API Docs - v4.0.14¶
Sink¶
wso2event (Sink)¶
The WSO2Event source pushes wso2events via TCP (databridge) in wso2event format. You can send wso2events through Thrift or Binary protocols.
Syntax
@sink(type="wso2event", wso2.stream.id="<STRING>", url="<STRING>", auth.url="<STRING>", username="<STRING>", password="<STRING>", protocol="<STRING>", mode="<STRING>", @map(...)))
QUERY PARAMETERS
| Name | Description | Default Value | Possible Data Types | Optional | Dynamic |
|---|---|---|---|---|---|
| wso2.stream.id | Stream Id to use when publishing events. If stream id is not defined, it uses the respective siddhi stream name with version 1.0.0. | the defined stream id:1.0.0.
(e.g.,if the stream definition is org.wso2.stream.bar.stream, then the value is org.wso2.stream.bar.stream:1.0.0.) |
STRING | Yes | No |
| url | The URL to which the outgoing events published via TCP over Thrift or Binary. (e.g., tcp://localhost:7611) |
STRING | No | No | |
| auth.url | The Thrift/Binary server endpoint url which used for authentication purposes. | ssl://localhost:<tcp-port> + 100
(e.g., if the tcp port is 7611, then the value is ssl://localhost:7711) |
STRING | Yes | No |
| username | The username is used for authentication flow before publishing events. e.g., admin |
STRING | No | No | |
| password | The password is used for authentication flow before publishing events. e.g., admin |
STRING | No | No | |
| protocol | There are two protocols that we can use to publish events through data bridge. Either, we can use thrift or binary. | thrift | STRING | Yes | No |
| mode | Property which decides whether to publish events in synchronous or asynchronous mode. It can be either blocking or non-blocking mode. |
non-blocking | STRING | Yes | No |
Examples EXAMPLE 1
@sink(type='wso2event', wso2.stream.id='fooStream:1.0.0', url="tcp://localhost:7611", auth.url="ssl://localhost:7711", protocol="thrift", username="admin", password="admin", mode="non-blocking" , @map(type='wso2event')) Define stream barStream(system string, price float, volume long);
As defined in above query events are pushed to destination that defined.
Source¶
wso2event (Source)¶
The WSO2Event source receives wso2events via TCP (databridge) in wso2event format. You can receive wso2events through Thrift or Binary protocols.
Syntax
@source(type="wso2event", wso2.stream.id="<STRING>", @map(...)))
QUERY PARAMETERS
| Name | Description | Default Value | Possible Data Types | Optional | Dynamic |
|---|---|---|---|---|---|
| wso2.stream.id | Stream Id to consume events. If stream id is not defined, it uses the respective siddhi stream definition with version 1.0.0 |
the defined stream id:1.0.0.
(e.g. if the stream definition is org.wso2.stream.bar.stream, then the value is org.wso2.stream.bar.stream:1.0.0.) |
STRING | No | No |
Examples EXAMPLE 1
@source(type='wso2event', wso2.stream.id='inputstream:1.0.0', @map(type='wso2event')) Define stream Foo (symbol string, price float, volume long);
As defined in above query events are received to stream id that defined in source.