org.sensorhub.api.processing

Interface IStreamProcessModule<ConfigType extends StreamProcessConfig>

Type Parameters:

ConfigType - Type of configuration class

All Superinterfaces:

IDataProducerModule<ConfigType>, IEventListener, IEventProducer, IModule<ConfigType>, IModuleWithDescription, IProcessModule<ConfigType>

public interface IStreamProcessModule<ConfigType extends StreamProcessConfig>
extends IProcessModule<ConfigType>, IDataProducerModule<ConfigType>, IEventListener

Interface for all event stream processors.
This type of process is started in a persistent manner and listens to incoming events. The algorithm is triggered repeatedly each time enough input data events have been received or some time has ellapsed.
Each process can listen to multiple event streams and produce a different type of result (and corresponding event) on each of its output.

Since:

Feb 20, 2015

Field Summary

Fields inherited from interface org.sensorhub.api.module.IModule

CANNOT_INIT_MSG, CANNOT_LOAD_MSG, CANNOT_START_MSG, CANNOT_STOP_MSG, CANNOT_UPDATE_MSG

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,DataComponent>	getParameters() Gets the list of parameters for this process. Values should be changed directly inside the objects returned in the map. Parameters that can be changed during processing must be marked as 'updatable' and the new set values are taken into account ASAP by the running process. Changing the value during processing of parameters that are not updatable is either silently ignored or can result in a processing exception.
boolean	isPauseSupported() Checks if this particular processing module supports pausing
void	pause() Pauses processing of the event stream. Incoming events are simply discarded and won't be processed when the process is resumed.
void	resume() Resumes normal processing of the event stream. Processing may actually resume only when the next event is received.

Methods inherited from interface org.sensorhub.api.processing.IProcessModule

getInputDescriptors, getOutputDescriptors, isCompatibleDataSource

Methods inherited from interface org.sensorhub.api.data.IDataProducerModule

getAllOutputs, getCurrentFeatureOfInterest

Methods inherited from interface org.sensorhub.api.module.IModule

cleanup, getConfiguration, getCurrentError, getCurrentState, getLocalID, getName, getStatusMessage, init, init, isInitialized, isStarted, loadState, registerListener, requestInit, requestStart, requestStop, saveState, setConfiguration, start, stop, unregisterListener, updateConfig, waitForState

Methods inherited from interface org.sensorhub.api.data.IModuleWithDescription

getCurrentDescription, getLastDescriptionUpdate, getUniqueIdentifier

Methods inherited from interface org.sensorhub.api.common.IEventListener

handleEvent

Method Detail

getParameters

java.util.Map<java.lang.String,DataComponent> getParameters()

Gets the list of parameters for this process.
Values should be changed directly inside the objects returned in the map.
Parameters that can be changed during processing must be marked as 'updatable' and the new set values are taken into account ASAP by the running process.
Changing the value during processing of parameters that are not updatable is either silently ignored or can result in a processing exception.

Returns:

map of parameter descriptors

isPauseSupported

boolean isPauseSupported()

Checks if this particular processing module supports pausing

Returns:

true if the process can be paused and resumed at any time

pause

void pause()

Pauses processing of the event stream.
Incoming events are simply discarded and won't be processed when the process is resumed.

resume

void resume()

Resumes normal processing of the event stream.
Processing may actually resume only when the next event is received.