Commit dfbaf4f9 authored by Martin Lucina's avatar Martin Lucina

Documentation updates

Multi-part messages
parent 0fa73b03
...@@ -32,8 +32,9 @@ to EAGAIN. ...@@ -32,8 +32,9 @@ to EAGAIN.
Multi-part messages Multi-part messages
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
A 0MQ message is composed of 1 to N message parts; each message part is an A 0MQ message is composed of 1 to N message parts; each message part is an
independent 'zmq_msg_t' in its own right. Consequently, wherever this independent 'zmq_msg_t' in its own right. The total number of message parts is
documentation uses the term _message_ it may be substituted for _message part_. unlimited. Consequently, wherever this documentation uses the term _message_ it
may be substituted for _message part_.
An application wishing to determine if a message is composed of multiple parts An application wishing to determine if a message is composed of multiple parts
does so by retrieving the value of the _ZMQ_RCVMORE_ socket option on the does so by retrieving the value of the _ZMQ_RCVMORE_ socket option on the
......
...@@ -37,15 +37,16 @@ responsibility for the message. ...@@ -37,15 +37,16 @@ responsibility for the message.
Multi-part messages Multi-part messages
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
A 0MQ message is composed of 1 to N message parts; each message part is an A 0MQ message is composed of 1 to N message parts; each message part is an
independent 'zmq_msg_t' in its own right. Consequently, wherever this independent 'zmq_msg_t' in its own right. The total number of message parts is
documentation uses the term _message_ it may be substituted for _message part_. unlimited. Consequently, wherever this documentation uses the term _message_ it
may be substituted for _message part_.
An application wishing to send a multi-part message does so by specifying the An application wishing to send a multi-part message does so by specifying the
'ZMQ_SNDMORE' flag to _zmq_send()_. The presence of this flag indicates to 0MQ 'ZMQ_SNDMORE' flag to _zmq_send()_. The presence of this flag indicates to 0MQ
that the message being sent is a multi-part message and that more message parts that the message being sent is a multi-part message and that more message parts
are to follow. When the application wishes to send the final message part it are to follow. When the application wishes to send the final message part it
does so by calling _zmq_send()_ without the 'ZMQ_SNDMORE' flag; this indicates does so by calling _zmq_send()_ without the 'ZMQ_SNDMORE' flag; this indicates
that no more message parts are to follow. The total number of mess that no more message parts are to follow.
0MQ shall ensure the atomicity of a multi-part message; peers shall receive 0MQ shall ensure the atomicity of a multi-part message; peers shall receive
either all _message parts_ of a multi-part message or none at all. either all _message parts_ of a multi-part message or none at all.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment