com.sitewhere.spi.device.communication

Interface IInboundEventReceiver<T>

All Superinterfaces:

ILifecycleComponent, ITenantLifecycleComponent

public interface IInboundEventReceiver<T>
extends ITenantLifecycleComponent

Handles receipt of device event information from an underlying transport.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName() Get name shown in user interfaces when referencing receiver.
IInboundEventSource<T>	getEventSource() Get the parent event source.
void	onEventPayloadReceived(T payload, java.util.Map<java.lang.String,java.lang.Object> metadata) Called when an event payload is received.
void	setEventSource(IInboundEventSource<T> source) Set the parent event source that will process events.

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ITenantLifecycleComponent

getTenant, setTenant

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent

canPause, findComponentsOfType, getComponentId, getComponentName, getComponentType, getCreatedDate, getLifecycleComponents, getLifecycleError, getLifecycleStatus, getLogger, initialize, initializeNestedComponent, lifecycleInitialize, lifecyclePause, lifecycleStart, lifecycleStop, lifecycleStop, logState, pause, start, startNestedComponent, stop, stop

Method Detail

getDisplayName

java.lang.String getDisplayName()

Get name shown in user interfaces when referencing receiver.

Returns:

onEventPayloadReceived

void onEventPayloadReceived(T payload,
                            java.util.Map<java.lang.String,java.lang.Object> metadata)
                     throws EventDecodeException

Called when an event payload is received.

Parameters:

payload -

metadata -

Throws:

SiteWhereException

EventDecodeException

setEventSource

void setEventSource(IInboundEventSource<T> source)

Set the parent event source that will process events.

Parameters:

source -

getEventSource

IInboundEventSource<T> getEventSource()

Get the parent event source.

Returns: