Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

WebSocket

Schemes: ws://, wss://

Query parameters recognised as config fields for this connector. Any other ?key=value pair is passed through unchanged as a driver option on the connection URL.

NameTypeRequiredDefaultDescription
backlogintegerno(Consumer only) TCP listen backlog (pending-connection queue depth) for the accept socket. Raise this if high-concurrency handshake bursts are being dropped/reset before accept() can keep up. Defaults to 4096, which is higher than the OS/tokio default of 1024.
execution_modeauto | direct_only | routednoauto(Consumer only) Selects whether WebSocket routes run directly or through the routed pipeline.
message_id_headerstringno(Consumer only) Header key to extract the message ID from the WebSocket handshake. Defaults to “message-id”.
pathstringno(Consumer only) Optional request path filter. If set, only upgrade requests whose URI path matches exactly are delivered to this consumer.
routed_queue_capacityintegerno(Consumer only) Queue capacity for the routed adapter. Direct response routes do not use this queue. Defaults to 100.
urlstringyesFor consumers, the listen address (e.g. “0.0.0.0:9000”). For publishers, the target URL.