From 741eb8d2d8ba606d81990ef50b2d8b261d47ec81 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Mon, 5 Nov 2018 14:47:03 +0100
Subject: [socket-nif|doc] Improved doc for recvmsg and update for sendmsg

The API for the sendmsg function has been updated to describe
the possible "partial success" of {ok, Remaining}.

OTP-14831
---
 erts/doc/src/socket.xml | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

(limited to 'erts')

diff --git a/erts/doc/src/socket.xml b/erts/doc/src/socket.xml
index 49c14869bf..ea2fde7dee 100644
--- a/erts/doc/src/socket.xml
+++ b/erts/doc/src/socket.xml
@@ -405,7 +405,8 @@
       <name name="recvmsg" arity="1"/>
       <name name="recvmsg" arity="2" clause_i="1"/>
       <name name="recvmsg" arity="2" clause_i="2"/>
-      <name name="recvmsg" arity="3"/>
+      <name name="recvmsg" arity="3" clause_i="1"/>
+      <name name="recvmsg" arity="3" clause_i="2"/>
       <name name="recvmsg" arity="5"/>
       <fsummary>Receive a message from a socket.</fsummary>
       <desc>
@@ -416,7 +417,7 @@
 	which may contain the source address (if socket not connected),
 	a list of <c>cmsghdr_recv()</c> (depends on what socket options have
 	been set and what the protocol and platform supports) and
-	also a set of flags, providing further info about the read . </p>
+	also a set of flags, providing further info about the read. </p>
 	
         <p>The <c>BufSz</c> argument basically defines the size of the
 	receive buffer. By setting the value to zero (0), the configured
@@ -458,6 +459,15 @@
 	which also contains the message to send,
 	The <c>MsgHdr</c> may also contain an list of optional <c>cmsghdr_send()</c>
 	(depends on what the protocol and platform supports).</p>
+
+	<p>Unlike the <seealso marker="#send"><c>send</c></seealso> function,
+	this one sends <em>one message</em>.
+	This means that if, for whatever reason, its not possible to send the
+	message in one go, the function will instead return with the
+	<em>remaining</em> data (<c>{ok, Remaining}</c>). Thereby leaving it
+	up to the caller to decide what to do (retry with the remaining data
+	of give up). </p>
+
       </desc>
     </func>
 
-- 
cgit v1.2.3