From 833a3c52d2c343255548ebe6255f6e13edfc1dc4 Mon Sep 17 00:00:00 2001 From: Pieter Hintjens Date: Wed, 1 Jan 2014 13:42:49 +0100 Subject: [PATCH] Clarified ZMQ_IDENTITY doc for duplicate identities --- doc/zmq_setsockopt.txt | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index de4c61fc..41bc7392 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -129,22 +129,19 @@ Applicable socket types:: ZMQ_SUB ZMQ_IDENTITY: Set socket identity ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The 'ZMQ_IDENTITY' option shall set the identity of the specified 'socket'. -Socket identity is used only by request/reply pattern. Namely, it can be used -in tandem with ROUTER socket to route messages to the peer with specific -identity. +The 'ZMQ_IDENTITY' option shall set the identity of the specified 'socket' +when connecting to a ROUTER socket. The identity should be from 1 to 255 +bytes long and MAY NOT start with binary zero. -Identity should be at least one byte and at most 255 bytes long. Identities -starting with binary zero are reserved for use by 0MQ infrastructure. - -If two peers use the same identity when connecting to a third peer, the -results shall be undefined. +If two clients use the same identity when connecting to a ROUTER, the +ROUTER socket shall accept only the first such client and reject the +others. [horizontal] Option value type:: binary data Option value unit:: N/A Default value:: NULL -Applicable socket types:: all +Applicable socket types:: ZMQ_REQ, ZMQ_REP, ZMQ_ROUTER, ZMQ_DEALER. ZMQ_RATE: Set multicast data rate