summaryrefslogtreecommitdiff
path: root/doc/xs_send.txt
diff options
context:
space:
mode:
authorMartin Sustrik <sustrik@250bpm.com>2012-03-14 16:06:28 +0100
committerMartin Sustrik <sustrik@250bpm.com>2012-03-14 16:06:28 +0100
commitfc9dc49cbf4571c8a17048d19f342408999e2164 (patch)
tree3e5107be7df5e58e33d3b574e405590be32679f8 /doc/xs_send.txt
parentc8102f6ef6394357d2d1a53c579bca574a3e3c6a (diff)
parentd5064791e2c4b5e8f9ce46c47272fd054c16e4af (diff)
Merge branch 'doc-updates' of git.lucina.net:libxsv1.0.0
Diffstat (limited to 'doc/xs_send.txt')
-rw-r--r--doc/xs_send.txt23
1 files changed, 11 insertions, 12 deletions
diff --git a/doc/xs_send.txt b/doc/xs_send.txt
index f2d66e4..72bbf88 100644
--- a/doc/xs_send.txt
+++ b/doc/xs_send.txt
@@ -4,7 +4,7 @@ xs_send(3)
NAME
----
-xs_send - send a message part on a socket
+xs_send - send a message part on a socket
SYNOPSIS
@@ -35,14 +35,13 @@ the 'socket' and Crossroads have assumed responsibility for the message.
Multi-part messages
~~~~~~~~~~~~~~~~~~~
-A Crossroads message is composed of 1 or more message parts. Each message
-part is an independent 'xs_msg_t' in its own right. Crossroads ensure 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 except
-by available memory.
+A Crossroads message is composed of 1 or more message parts. Crossroads
+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 except by available memory.
An application that sends multipart messages must use the _XS_SNDMORE_ flag
-when sending each data part except the final one.
+when sending each message part except the final one.
RETURN VALUE
@@ -88,15 +87,15 @@ assert (rc == 2);
SEE ALSO
--------
-linkxs:xs_sendmsg[3]
+Applications that wish to use zero-copy messaging must use
+linkxs:xs_sendmsg[3] instead of _xs_send()_.
+
linkxs:xs_recv[3]
-linkxs:xs_recvmsg[3]
linkxs:xs_socket[7]
linkxs:xs[7]
AUTHORS
-------
-+This man page was written by Martin Sustrik <sustrik@250bpm.com>, Martin
-+Lucina <martin@lucina.net> and Pieter Hintjens <ph@imatix.com>.
-
+This man page was written by Martin Sustrik <sustrik@250bpm.com>, Martin
+Lucina <martin@lucina.net> and Pieter Hintjens <ph@imatix.com>.