org.wso2.siddhi.core.stream.output.sink

Class InMemorySink

java.lang.Object

org.wso2.siddhi.core.stream.output.sink.Sink

org.wso2.siddhi.core.stream.output.sink.InMemorySink

All Implemented Interfaces:

SinkListener, Snapshotable

public class InMemorySink
extends Sink

Implementation of Sink which represents in-memory transport. This implementation can send incoming objects to in-memory transport within JVM.

Field Summary

Fields inherited from class org.wso2.siddhi.core.stream.output.sink.Sink

isTryingToConnect

Constructor Summary

Constructors

Constructor and Description
InMemorySink()

Method Summary

Modifier and Type	Method and Description
void	connect() Called to connect to the backend before events are published
Map<String,Object>	currentState() Used to collect the serializable state of the processing element, that need to be persisted for the reconstructing the element to the same state on a different point of time
void	destroy() Called at the end to clean all the resources consumed
void	disconnect() Called after all publishing is done, or when ConnectionUnavailableException is thrown
String[]	getSupportedDynamicOptions() Supported dynamic options by the transport
Class[]	getSupportedInputEventClasses()
protected void	init(org.wso2.siddhi.query.api.definition.StreamDefinition outputStreamDefinition, OptionHolder optionHolder, ConfigReader sinkConfigReader, SiddhiAppContext siddhiAppContext) Will be called for initialing the Sink
void	publish(Object payload, DynamicOptions dynamicOptions) Sending events via output transport
void	restoreState(Map<String,Object> state) Used to restore serialized state of the processing element, for reconstructing the element to the same state as if was on a previous point of time.

Methods inherited from class org.wso2.siddhi.core.stream.output.sink.Sink

connectWithRetry, getElementId, getHandler, getMapper, getStreamDefinition, getType, init, initOnlyTransport, isConnected, publish, setConnected, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InMemorySink

public InMemorySink()

Method Detail

getSupportedInputEventClasses

public Class[] getSupportedInputEventClasses()

Specified by:

getSupportedInputEventClasses in class Sink

getSupportedDynamicOptions

public String[] getSupportedDynamicOptions()

Description copied from class: Sink

Supported dynamic options by the transport

Specified by:

getSupportedDynamicOptions in class Sink

Returns:

the list of supported dynamic option keys

init

protected void init(org.wso2.siddhi.query.api.definition.StreamDefinition outputStreamDefinition,
                    OptionHolder optionHolder,
                    ConfigReader sinkConfigReader,
                    SiddhiAppContext siddhiAppContext)

Description copied from class: Sink

Will be called for initialing the Sink

Specified by:

init in class Sink

Parameters:

outputStreamDefinition - containing stream definition bind to the Sink

optionHolder - Option holder containing static and dynamic options related to the Sink

sinkConfigReader - this hold the Sink extensions configuration reader.

siddhiAppContext - SiddhiAppContext of the parent siddhi app.

connect

public void connect()
             throws ConnectionUnavailableException

Description copied from class: Sink

Called to connect to the backend before events are published

Specified by:

connect in class Sink

Throws:

ConnectionUnavailableException - if it cannot connect to the backend

disconnect

public void disconnect()

Description copied from class: Sink

Called after all publishing is done, or when ConnectionUnavailableException is thrown

Specified by:

disconnect in class Sink

destroy

public void destroy()

Description copied from class: Sink

Called at the end to clean all the resources consumed

Specified by:

destroy in class Sink

publish

public void publish(Object payload,
                    DynamicOptions dynamicOptions)
             throws ConnectionUnavailableException

Description copied from class: Sink

Sending events via output transport

Specified by:

publish in class Sink

Parameters:

payload - payload of the event

dynamicOptions - one of the event constructing the payload

Throws:

ConnectionUnavailableException - throw when connections are unavailable.

currentState

public Map<String,Object> currentState()

Description copied from interface: Snapshotable

Used to collect the serializable state of the processing element, that need to be persisted for the reconstructing the element to the same state on a different point of time

Returns:

stateful objects of the processing element as an array

restoreState

public void restoreState(Map<String,Object> state)

Description copied from interface: Snapshotable

Used to restore serialized state of the processing element, for reconstructing the element to the same state as if was on a previous point of time.

Parameters:

state - the stateful objects of the element as an array on the same order provided by currentState().