Skip to content

Siddhi IO WebSocket

Jenkins Build Status GitHub Release GitHub Release Date GitHub Open Issues GitHub Last Commit License

The siddhi-io-websocket extension is an extension to Siddhi that allows to receive and publish events through WebSocket.

For information on Siddhi and it's features refer Siddhi Documentation.

Downloads

  • Versions 3.x and above with group id io.siddhi.extension.* from here.
  • Versions 2.x and lower with group id org.wso2.extension.siddhi. from here.

Latest API Docs

Latest API Docs is 3.0.2.

Features

  • websocket (Sink)

    A Siddhi application can be configured to publish events via the Websocket transport by adding the @Sink(type = 'websocket') annotation at the top of an event stream definition.

  • websocket-server (Sink)

    A Siddhi application can be configured to run as a websocket server by adding the @Sink(type = 'websocket-server') annotation at the top of an event stream definition.

  • websocket (Source)

    A Siddhi application can be configured to receive events via the WebSocket by adding the @Source(type = 'websocket') annotation at the top of an event stream definition.
    When this is defined the associated stream will receive events from the WebSocket server on the url defined in the system.

  • websocket-server (Source)

    A Siddhi application can be configured to receive events via the WebSocket by adding the @Source(type = 'websocket-server') annotation at the top of an event stream definition.

Dependencies

There are no other dependencies needed for this extension.

Installation

For installing this extension on various siddhi execution environments refer Siddhi documentation section on adding extensions.

Support and Contribution

  • We encourage users to ask questions and get support via StackOverflow, make sure to add the siddhi tag to the issue for better response.
  • If you find any issues related to the extension please report them on the issue tracker.
  • For production support and other contribution related information refer Siddhi Community documentation.