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

ZeroMQ

Schemes: zeromq://, zmq://

Query parameters recognised as config fields for this connector. Unrecognised parameters are not forwarded as driver options, so any other ?key=value pair is rejected rather than silently ignored.

NameTypeRequiredDefaultDescription
backendzmq | omq | try_omqnotry_omqBackend: try_omq (default, prefer omq and fall back to zmq), zmq (the zeromq crate) or omq (the omq-tokio backend). omq needs the zeromq-omq build feature.
bindbooleannofalseIf true, bind to the address. If false, connect.
formatjson | raw | raw_framednoraw_framedWire format: json wraps the CanonicalMessage; raw sends payload bytes per frame; raw_framed adds a JSON metadata frame. Default raw_framed. REQ/REP replies are the exception: a REP peer always answers with a JSON array of canonical messages and a REQ publisher always decodes one, whatever format is set to.
internal_buffer_sizeintegernonullInternal buffer size for the channel. Defaults to 128. zmq backend only — omq applies HWM backpressure on the socket itself and ignores this.
request_timeout_msintegernonull(REQ publisher only) Timeout in ms for one request/reply exchange before it is reported as failed. Defaults to 30000.
socket_typepush | pull | pub | sub | req | repnonullThe socket type (PUSH, PULL, PUB, SUB, REQ, REP).
topicstringno(Consumer only) The ZeroMQ topic (for SUB sockets).
urlstringyesThe ZeroMQ URL (e.g., “tcp://127.0.0.1:5555”).