From 0874eec8038a56f77809b1e890292c24ff88a76f Mon Sep 17 00:00:00 2001 From: sigiesec Date: Thu, 7 Sep 2017 11:18:50 +0200 Subject: [PATCH] Problem: Use of "rid" in the docs Solution: Replaced by "routing id" --- doc/zmq_getsockopt.txt | 1 + doc/zmq_setsockopt.txt | 29 ++++++++++++++++++----------- 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index 65978ce0..66bad389 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -306,6 +306,7 @@ ZMQ_IDENTITY: Retrieve socket identity This option name is now deprecated. Use ZMQ_ROUTING_ID instead. ZMQ_IDENTITY remains as an alias for now. + ZMQ_IMMEDIATE: Retrieve attach-on-connect value ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Retrieve the state of the attach on connect value. If set to `1`, will delay the diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index e27d7588..c7b91e03 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -90,22 +90,29 @@ Applicable socket types:: all, when using TCP or UDP transports. ZMQ_CONNECT_RID: Assign the next outbound connection id ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The 'ZMQ_CONNECT_RID' option sets the peer id of the next host connected -via the zmq_connect() call, and immediately readies that connection for -data transfer with the named id. This option applies only to the first -subsequent call to zmq_connect(), calls thereafter use default connection -behaviour. +This option name is now deprecated. Use ZMQ_CONNECT_ROUTING_ID instead. +ZMQ_CONNECT_RID remains as an alias for now. -Typical use is to set this socket option ahead of each zmq_connect() attempt -to a new host. Each connection MUST be assigned a unique name. Assigning a -name that is already in use is not allowed. + +ZMQ_CONNECT_ROUTING_ID: Assign the next outbound routing id +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The 'ZMQ_CONNECT_ROUTING_ID' option sets the peer id of the peer connected +via the next zmq_connect() call, such that that connection is immediately ready for +data transfer with the given routing id. This option applies only to the first +subsequent call to zmq_connect(), zmq_connect() calls thereafter use the default +connection behaviour. + +Typical use is to set this socket option ahead of each zmq_connect() call. +Each connection MUST be assigned a unique routing id. Assigning a +routing id that is already in use is not allowed. Useful when connecting ROUTER to ROUTER, or STREAM to STREAM, as it -allows for immediate sending to peers. Outbound id framing requirements +allows for immediate sending to peers. Outbound routing id framing requirements for ROUTER and STREAM sockets apply. -The peer id should be from 1 to 255 bytes long and MAY NOT start with -binary zero. +The routing id must be from 1 to 255 bytes long and MAY NOT start with +a zero byte (such routing ids are reserved for internal use by the 0MQ +infrastructure). [horizontal] Option value type:: binary data