diff options
Diffstat (limited to 'doc/xs_recvmsg.txt')
| -rw-r--r-- | doc/xs_recvmsg.txt | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/xs_recvmsg.txt b/doc/xs_recvmsg.txt index 735fed0..4a88177 100644 --- a/doc/xs_recvmsg.txt +++ b/doc/xs_recvmsg.txt @@ -4,7 +4,7 @@ xs_recvmsg(3) NAME ---- -xs_recvmsg - receive a message part from a socket +xs_recvmsg - receive a message part from a socket (zero-copy) SYNOPSIS @@ -30,7 +30,7 @@ function shall fail with 'errno' set to EAGAIN. 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 +part is an independent 'xs_msg_t' in its own right. 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. @@ -42,9 +42,9 @@ there are further parts to receive. RETURN VALUE ------------ -The _xs_recvmsg()_ function shall return number of bytes in the message -if successful. Otherwise it shall return `-1` and set 'errno' to one of the -values defined below. +The _xs_recvmsg()_ function shall return the number of bytes in the +received message if successful. Otherwise it shall return `-1` and set +'errno' to one of the values defined below. ERRORS @@ -106,8 +106,9 @@ do { SEE ALSO -------- -linkxs:xs_recv[3] -linkxs:xs_send[3] +Applications that do not require zero-copy messaging can use the simpler +linkxs:xs_recv[3] instead of _xs_recvmsg()_. + linkxs:xs_sendmsg[3] linkxs:xs_getsockopt[3] linkxs:xs_socket[7] @@ -118,4 +119,3 @@ AUTHORS ------- This man page was written by Martin Sustrik <sustrik@250bpm.com>, Martin Lucina <martin@lucina.net> and Pieter Hintjens <ph@imatix.com>. - |