io.siddhi.extension.io.websocket.sink.websocketserver

Class WebSocketServerSink

java.lang.Object

io.siddhi.core.stream.output.sink.Sink

io.siddhi.extension.io.websocket.sink.websocketserver.WebSocketServerSink

All Implemented Interfaces:

io.siddhi.core.stream.output.sink.SinkListener

public class WebSocketServerSink
extends io.siddhi.core.stream.output.sink.Sink

WebsocketServerSink Start the WebSocket server and publishing the siddhi events.

Nested Class Summary

Nested classes/interfaces inherited from class io.siddhi.core.stream.output.sink.Sink

io.siddhi.core.stream.output.sink.Sink.OnErrorAction

Field Summary

Fields inherited from class io.siddhi.core.stream.output.sink.Sink

isTryingToConnect

Constructor Summary

Constructors

Constructor and Description
WebSocketServerSink()

Method Summary

Modifier and Type	Method and Description
void	connect()
void	destroy()
void	disconnect()
protected io.siddhi.core.stream.ServiceDeploymentInfo	exposeServiceDeploymentInfo()
String[]	getSupportedDynamicOptions()
Class[]	getSupportedInputEventClasses()
protected io.siddhi.core.util.snapshot.state.StateFactory	init(io.siddhi.query.api.definition.StreamDefinition streamDefinition, io.siddhi.core.util.transport.OptionHolder optionHolder, io.siddhi.core.util.config.ConfigReader configReader, io.siddhi.core.config.SiddhiAppContext siddhiAppContext) The initialization method for Sink, will be called before other methods.
void	publish(Object payload, io.siddhi.core.util.transport.DynamicOptions dynamicOptions, io.siddhi.core.util.snapshot.state.State state)

Methods inherited from class io.siddhi.core.stream.output.sink.Sink

connectWithRetry, getHandler, getMapper, getServiceDeploymentInfoList, getStreamDefinition, getType, init, initOnlyTransport, isConnected, isStateful, onError, publish, retryPublish, setConnected, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketServerSink

public WebSocketServerSink()

Method Detail

getSupportedInputEventClasses

public Class[] getSupportedInputEventClasses()

Specified by:

getSupportedInputEventClasses in class io.siddhi.core.stream.output.sink.Sink

getSupportedDynamicOptions

public String[] getSupportedDynamicOptions()

Specified by:

getSupportedDynamicOptions in class io.siddhi.core.stream.output.sink.Sink

init

protected io.siddhi.core.util.snapshot.state.StateFactory init(io.siddhi.query.api.definition.StreamDefinition streamDefinition,
                                                               io.siddhi.core.util.transport.OptionHolder optionHolder,
                                                               io.siddhi.core.util.config.ConfigReader configReader,
                                                               io.siddhi.core.config.SiddhiAppContext siddhiAppContext)

The initialization method for Sink, will be called before other methods. It used to validate all configurations and to get initial values.

Specified by:

init in class io.siddhi.core.stream.output.sink.Sink

Parameters:

streamDefinition - containing stream definition bind to the Sink

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

configReader - to read the sink related system configuration.

siddhiAppContext - the context of the SiddhiApp used to get siddhi related utility functions.

exposeServiceDeploymentInfo

protected io.siddhi.core.stream.ServiceDeploymentInfo exposeServiceDeploymentInfo()

Specified by:

exposeServiceDeploymentInfo in class io.siddhi.core.stream.output.sink.Sink

publish

public void publish(Object payload,
                    io.siddhi.core.util.transport.DynamicOptions dynamicOptions,
                    io.siddhi.core.util.snapshot.state.State state)
             throws io.siddhi.core.exception.ConnectionUnavailableException

Specified by:

publish in class io.siddhi.core.stream.output.sink.Sink

Throws:

io.siddhi.core.exception.ConnectionUnavailableException

connect

public void connect()
             throws io.siddhi.core.exception.ConnectionUnavailableException

Specified by:

connect in class io.siddhi.core.stream.output.sink.Sink

Throws:

io.siddhi.core.exception.ConnectionUnavailableException

disconnect

public void disconnect()

Specified by:

disconnect in class io.siddhi.core.stream.output.sink.Sink

destroy

public void destroy()

Specified by:

destroy in class io.siddhi.core.stream.output.sink.Sink