Skip to content

Websockets Editor

Editor for *.websocket artefacts. A websocket binding exposes a server WebSocket endpoint and routes each frame to a handler module. Served by engine-websockets.

Component: editor-websockets. Synchronizer: WebsocketsSynchronizer.

Artefact shape

json
{
    "endpoint": "trade-feed",
    "handler": "trading/websockets/trade-feed-handler.ts",
    "description": "Live trade feed"
}
FieldRequiredNotes
endpointyesEndpoint suffix. The full URL is ws://<host>/websockets/<endpoint>.
handleryesRepository path to the handler module. TS / JS via engine-javascript, Java via engine-java.
descriptionnoHuman-readable description.

The handler exports lifecycle callbacks (onOpen, onMessage, onClose, onError) invoked by the engine on each session event.

Editor fields

  • Endpoint - the URL suffix.
  • Handler - file picker.
  • Description.

Runtime

Active sessions are visible in the Websockets view (location, endpoint, handler, created-at, creator).

See also

Released under the EPL-2.0 License.