summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Lucina <mato@kotelna.sk>2010-05-31 14:18:37 +0200
committerMartin Lucina <mato@kotelna.sk>2010-05-31 14:18:37 +0200
commitdfbaf4f9668f0493649d6ba1328cced64e5340b0 (patch)
tree452d4e2b1fa5d41505edbaf2e9a73ac461618c9c
parent0fa73b039462c1754d407de85306904e9b0c73be (diff)
Documentation updates
Multi-part messages
-rw-r--r--doc/zmq_recv.txt5
-rw-r--r--doc/zmq_send.txt7
2 files changed, 7 insertions, 5 deletions
diff --git a/doc/zmq_recv.txt b/doc/zmq_recv.txt
index b93f2a5..50be810 100644
--- a/doc/zmq_recv.txt
+++ b/doc/zmq_recv.txt
@@ -32,8 +32,9 @@ to EAGAIN.
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. Consequently, wherever this
-documentation uses the term _message_ it may be substituted for _message part_.
+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_.
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
diff --git a/doc/zmq_send.txt b/doc/zmq_send.txt
index b05c73b..e4439f5 100644
--- a/doc/zmq_send.txt
+++ b/doc/zmq_send.txt
@@ -37,15 +37,16 @@ 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. Consequently, wherever this
-documentation uses the term _message_ it may be substituted for _message part_.
+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_.
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
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
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
either all _message parts_ of a multi-part message or none at all.