com.mbientlab.metawear

Interface RouteManager

public interface RouteManager

Manages a data route

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RouteManager.MessageHandler Processes messages received from data producers (i.e.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getLogKeys() Retrieves available logging keys for this route
java.util.Collection<java.lang.String>	getStreamKeys() Retrieves available subscription keys for this route
int	id() Retrieves the ID
boolean	isActive() Retrieves the active state of the manager.
void	remove() Removes the underlying route from the board and marks the manager as inactive
boolean	setLogMessageHandler(java.lang.String logKey, RouteManager.MessageHandler processor) Assigns a handler to process data received from the logger.
boolean	subscribe(java.lang.String streamKey, RouteManager.MessageHandler processor) Subscribes to a data stream.
boolean	unsubscribe(java.lang.String streamKey) Unsubscribes from a data stream.

Method Detail

id

int id()

Retrieves the ID

Returns:

ID identifying the route manager

remove

void remove()

Removes the underlying route from the board and marks the manager as inactive

isActive

boolean isActive()

Retrieves the active state of the manager. If the manager is not active, none of the class methods will have any effect.

Returns:

True if the manager is still active

getStreamKeys

java.util.Collection<java.lang.String> getStreamKeys()

Retrieves available subscription keys for this route

Returns:

Collection of subscription keys

unsubscribe

boolean unsubscribe(java.lang.String streamKey)

Unsubscribes from a data stream. No changes will be made if the stream key is invalid.

Parameters:

streamKey - Unique key identifying the stream

Returns:

True if the operation was successful

subscribe

boolean subscribe(java.lang.String streamKey,
                  RouteManager.MessageHandler processor)

Subscribes to a data stream. No changes will be made if the stream key is invalid.

Parameters:

streamKey - Unique key identifying the stream

processor - Processor to handle the stream data

Returns:

True if the operation was successful

getLogKeys

java.util.Collection<java.lang.String> getLogKeys()

Retrieves available logging keys for this route

Returns:

Collection of logging keys

setLogMessageHandler

boolean setLogMessageHandler(java.lang.String logKey,
                             RouteManager.MessageHandler processor)

Assigns a handler to process data received from the logger. No changes will be made if the log key is invalid.

Parameters:

logKey - Unique key identifying the logger

processor - Processor to handle the log data

Returns:

True if the operation was successful