From b4f3e0acd72de97bc5ef46ea74d9cd7ed7f9efc2 Mon Sep 17 00:00:00 2001 From: Martin Lucina Date: Mon, 31 May 2010 17:21:51 +0200 Subject: Documentation updates Clarify multi-part messages --- doc/zmq_send.txt | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) (limited to 'doc/zmq_send.txt') diff --git a/doc/zmq_send.txt b/doc/zmq_send.txt index e4439f5..300f812 100644 --- a/doc/zmq_send.txt +++ b/doc/zmq_send.txt @@ -36,10 +36,12 @@ responsibility for the message. Multi-part messages ~~~~~~~~~~~~~~~~~~~ -A 0MQ message is composed of 1 to N message parts; each message part is an -independent 'zmq_msg_t' in its own right. The total number of message parts is -unlimited. Consequently, wherever this documentation uses the term _message_ it -may be substituted for _message part_. +A 0MQ message is composed of 1 or more message parts; each message part is an +independent 'zmq_msg_t' in its own right. 0MQ ensures atomic delivery of +messages; peers shall receive either all _message parts_ of a message or none +at all. + +The total number of message parts is unlimited. 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 @@ -48,9 +50,6 @@ 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 that no more message parts are to follow. -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. - RETURN VALUE ------------ -- cgit v1.2.3