WebSocket Local Event Receiver
WebSocket local event receiver is an internal event receiver that comes with WSO2 products by default. You can configure it with XML, text, and JSON input mapping types.
The websocket-local
event receiver should be used if the event source is a web socket client. Such event sources need to connect to the inbuilt websocket server of WSO2 DAS for the DAS to receive events. However, if the event source is a web socket server, the DAS should connect to it in order to receive events. In such scenarios, use the WebSocket Event Receiver.
Creating a WebSocket local event receiver
For instructions on creating a WebSocket local event receiver, see Configuring Event Receivers.
Configuring adapter properties
There are not any adapter-specific properties for the WebSocket local event receiver as shown below.
When multi-tenancy is used, the URL formats used to receive events are as follows.
Super-tenant/Tenant | URL Formats |
---|---|
Super-tenant | ws://localhost:";<DAS_Server_Port>"/inputwebsocket/<receiver_name> wss://localhost:";<DAS_SSL_Server_Port>"/inputwebsocket/<receiver_name>"; |
Tenant | ws://localhost:";<DAS_Server_Port>"/t/<tenant_domain>/ inputwebsocket/<receiver_name> inputwebsocket/<receiver_name>"; |
e.g., If the receiver name is WebSocketLocalInputEventReceiver
and the tenant domain is mycompany.com
, the URL would be as follows when you use the default server ports.
Super-tenant/Tenant | URL Formats |
---|---|
Super-tenant | ws://localhost:";9763"/inputwebsocket/WebSocketLocalInputEventReceiver
|
Tenant | ws://localhost:";9763"/t/mycompany.com/ inputwebsocket/WebSocketLocalInputEventReceiver
inputwebsocket/WebSocketLocalInputEventReceiver";
|
Related samples
For more information on websocket-local
event receiver type, see the following sample.