summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMartin Sustrik <sustrik@250bpm.com>2011-06-20 11:33:54 +0200
committerMartin Sustrik <sustrik@250bpm.com>2011-06-20 11:33:54 +0200
commitab99975ad44ed0fe9ab651f31cc47d493e7fb77e (patch)
treeec7d05592886bf48cb4ed60d10aa8f5eaf02dacd /doc
parentada5d424721c0c0139b8011a5e9de348d061ba2f (diff)
LABEL flag added to the wire format
So far there was no distinction between message parts used by 0MQ and message parts used by user. Now, the message parts used by 0MQ are marked as 'LABEL'. Signed-off-by: Martin Sustrik <sustrik@250bpm.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/zmq_getsockopt.txt12
-rw-r--r--doc/zmq_send.txt4
2 files changed, 16 insertions, 0 deletions
diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt
index 270ea6f..9a0958f 100644
--- a/doc/zmq_getsockopt.txt
+++ b/doc/zmq_getsockopt.txt
@@ -57,6 +57,18 @@ Default value:: N/A
Applicable socket types:: all
+ZMQ_RCVLABEL: Inquires whether last message received was a label
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The 'ZMQ_RCVLABEL' option shall return a boolean value indicating whether the
+last message part received was a label. Labels are used internally by 0MQ.
+
+[horizontal]
+Option value type:: int
+Option value unit:: boolean
+Default value:: N/A
+Applicable socket types:: all
+
+
ZMQ_SNDHWM: Set high water mark for outbound messages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_SNDHWM' option shall set the high water mark for outbound messages on
diff --git a/doc/zmq_send.txt b/doc/zmq_send.txt
index 85ac3b7..52a50ae 100644
--- a/doc/zmq_send.txt
+++ b/doc/zmq_send.txt
@@ -28,6 +28,10 @@ Specifies that the message being sent is a multi-part message, and that further
message parts are to follow. Refer to the section regarding multi-part messages
below for a detailed description.
+*ZMQ_SNDLABEL*::
+Specifies that the message being sent is a label. Labels are used internally
+by 0MQ.
+
The _zmq_msg_t_ structure passed to _zmq_send()_ is nullified during the call.
If you want to send the same message to multiple sockets you have to copy it
using (e.g. using _zmq_msg_copy()_).