summaryrefslogtreecommitdiff
path: root/doc/xs_sendmsg.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_sendmsg.txt
parentc8102f6ef6394357d2d1a53c579bca574a3e3c6a (diff)
parentd5064791e2c4b5e8f9ce46c47272fd054c16e4af (diff)
Merge branch 'doc-updates' of git.lucina.net:libxsv1.0.0
Diffstat (limited to 'doc/xs_sendmsg.txt')
-rw-r--r--doc/xs_sendmsg.txt13
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/xs_sendmsg.txt b/doc/xs_sendmsg.txt
index 9478b4a..7445f25 100644
--- a/doc/xs_sendmsg.txt
+++ b/doc/xs_sendmsg.txt
@@ -4,7 +4,7 @@ xs_sendmsg(3)
NAME
----
-xs_sendmsg - send a message part on a socket
+xs_sendmsg - send a message part on a socket (zero-copy)
SYNOPSIS
@@ -48,6 +48,7 @@ by available memory.
An application that sends multipart messages must use the _XS_SNDMORE_ flag
when sending each data part except the final one.
+
RETURN VALUE
------------
The _xs_sendmsg()_ function shall return number of bytes in the message
@@ -104,8 +105,9 @@ rc = xs_sendmsg (socket, &part3, 0);
SEE ALSO
--------
-linkxs:xs_recv[3]
-linkxs:xs_recv[3]
+Applications that do not require zero-copy messaging can use the simpler
+linkxs:xs_send[3] instead of _xs_sendmsg()_.
+
linkxs:xs_recvmsg[3]
linkxs:xs_socket[7]
linkxs:xs[7]
@@ -113,6 +115,5 @@ 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>.