Modifier and Type | Method and Description |
---|---|
void |
IModule.cleanup()
Cleans up all ressources used by the module when deleted
All persistent resources created by the module should be cleaned
when this is called
|
ModuleType |
IModuleManager.getModuleById(String moduleID)
Retrieves a module instance by its local ID
|
void |
IModule.init(ConfigType config)
Initializes the module with the specified configuration
|
void |
IModule.loadState(IModuleStateManager loader)
Restores the state of this module from info provided by the input stream
|
void |
IModule.saveState(IModuleStateManager saver)
Saves the state of this module to the provided output stream
|
void |
IModule.start()
Starts the module with the current configuration.
init() should always be called before start(). |
void |
IModule.stop()
Stops the module.
All temporary resources created by the module should be cleaned when this is called (ex: memory, files, connections, etc.) stop() can be called right after init() even if start() hasn't been called. |
void |
IModule.updateConfig(ConfigType config)
Updates the module's configuration dynamically.
The module must honor this new configuration unless an error is detected. |
Modifier and Type | Class and Description |
---|---|
class |
StorageException
Exception type generated by persistence API
|
Modifier and Type | Method and Description |
---|---|
List<? extends IRecordStorageModule<?>> |
IPersistenceManager.findStorageForSensor(String sensorID)
Finds storage modules where the specified sensor data is archived
|
StorageConfig |
IPersistenceManager.getDefaultStorageConfig(Class<?> storageClass)
Gets the default config for the specified storage type
|
Modifier and Type | Class and Description |
---|---|
class |
ProcessException
Exceptions generated by process implementations
|
Modifier and Type | Method and Description |
---|---|
Map<String,? extends IStreamingDataInterface> |
IOnDemandProcessInstance.getOutputs()
Retrieves the list of data outputs
|
Modifier and Type | Class and Description |
---|---|
class |
SensorException
Exceptions generated by the sensor API
|
Modifier and Type | Class and Description |
---|---|
class |
ServiceException
Exceptions generated by the service API
|
Modifier and Type | Method and Description |
---|---|
void |
TCPCommProvider.cleanup() |
void |
TCPCommProvider.start() |
void |
TCPCommProvider.stop() |
Modifier and Type | Method and Description |
---|---|
void |
ModuleRegistry.destroyModule(String moduleID)
Removes the module with the given id
|
void |
ModuleRegistry.disableModule(String moduleID)
Disables the module with the given id
|
IModule<?> |
ModuleRegistry.enableModule(String moduleID)
Enables/Start the module with the given id
|
IModule<?> |
ModuleRegistry.getModuleById(String moduleID) |
WeakReference<? extends IModule<?>> |
ModuleRegistry.getModuleRef(String moduleID) |
void |
AbstractModule.init(ConfigType config) |
IModule<?> |
ModuleRegistry.loadModule(ModuleConfig config)
Instantiates one module using the given configuration
|
void |
AbstractModule.loadState(IModuleStateManager loader) |
void |
AbstractModule.saveState(IModuleStateManager saver) |
void |
ModuleRegistry.shutdown(boolean saveConfig,
boolean saveState)
Shuts down all modules and the config repository
|
void |
ModuleRegistry.unloadModule(String moduleID)
Unloads a module instance.
This causes the module to be removed from registry but its last saved configuration is kept as-is. |
void |
AbstractModule.updateConfig(ConfigType config) |
Modifier and Type | Method and Description |
---|---|
void |
GenericStreamStorage.cleanup() |
List<IRecordStorageModule<?>> |
PersistenceManagerImpl.findStorageForSensor(String sensorLocalID) |
StorageConfig |
PersistenceManagerImpl.getDefaultStorageConfig(Class<?> storageClass) |
IStorageModule<?> |
PersistenceManagerImpl.getModuleById(String moduleID) |
void |
InMemoryBasicStorage.start() |
void |
GenericStreamStorage.start() |
void |
InMemoryBasicStorage.stop() |
void |
GenericStreamStorage.stop() |
Modifier and Type | Method and Description |
---|---|
IProcessModule<?> |
ProcessingManagerImpl.getModuleById(String moduleID) |
void |
SMLStreamProcess.init(SMLStreamProcessConfig config) |
void |
SMLStreamProcess.start() |
void |
AbstractStreamProcess.start() |
void |
SMLStreamProcess.updateConfig(SMLStreamProcessConfig config) |
Modifier and Type | Method and Description |
---|---|
ISensorModule<?> |
SensorManagerImpl.getModuleById(String moduleID) |
void |
AbstractSensorModule.loadState(IModuleStateManager loader) |
void |
AbstractSensorModule.saveState(IModuleStateManager saver) |
void |
AbstractSensorModule.updateConfig(ConfigType config) |
Modifier and Type | Method and Description |
---|---|
void |
HttpServer.cleanup() |
void |
HttpServer.start() |
void |
HttpServer.stop() |
void |
HttpServer.updateConfig(HttpServerConfig config) |
Copyright © 2015 Sensia Software LLC. All rights reserved.