tishan89 / siddhi-io-websocket

siddhi-io-websocket

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

Find some useful links below:

• Source code
• Releases
• Issue tracker

Latest API Docs

Latest API Docs is 1.0.6.

How to use

Using the extension in WSO2 Stream Processor

• You can use this extension in the latest WSO2 Stream Processor that is a part of WSO2 Analytics offering, with editor, debugger and simulation support.

• This extension is shipped by default with WSO2 Stream Processor, if you wish to use an alternative version of this extension you can replace the component jar that can be found in the <STREAM_PROCESSOR_HOME>/lib directory.

Using the extension as a java library

• This extension can be added as a maven dependency along with other Siddhi dependencies to your project.

     <dependency>
        <groupId>org.wso2.extension.siddhi.io.websocket</groupId>
        <artifactId>siddhi-io-websocket</artifactId>
        <version>x.x.x</version>
     </dependency>

Jenkins Build Status

---

Branch	Build Status
master

---

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 publish events via the WebSocket transport 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.

How to Contribute

• Please report issues at GitHub Issue Tracker.

• Send your contributions as pull requests to master branch.

Contact us

• Post your questions with the "Siddhi" tag in Stackoverflow.

• Siddhi developers can be contacted via the mailing lists:

  Developers List : [e-mail]

  Architecture List : [e-mail]

Support

• We are committed to ensuring support for this extension in production. Our unique approach ensures that all support leverages our open development methodology and is provided by the very same engineers who build the technology.

• For more details and to take advantage of this unique opportunity contact us via http://wso2.com/support/.