From d5064791e2c4b5e8f9ce46c47272fd054c16e4af Mon Sep 17 00:00:00 2001 From: Martin Lucina Date: Wed, 14 Mar 2012 15:55:01 +0100 Subject: Documentation updates (API reference) Signed-off-by: Martin Lucina --- doc/xs_sendmsg.txt | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'doc/xs_sendmsg.txt') 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 , Martin -+Lucina and Pieter Hintjens . - +This man page was written by Martin Sustrik , Martin +Lucina and Pieter Hintjens . -- cgit v1.2.3