xnu-7195.101.1.tar.gz

[apple/xnu.git] / bsd / man / man2 / recv.2

diff --git a/bsd/man/man2/recv.2 b/bsd/man/man2/recv.2
index 433bca52a4c99e28fac231c7bdb317a930a6c0be..251fe51c68f66366cab92304eee3011aa129bff2 100644 (file)
--- a/bsd/man/man2/recv.2
+++ b/bsd/man/man2/recv.2
@@ -31,7 +31,7 @@
 .\"
 .\"     @(#)recv.2     8.3 (Berkeley) 2/21/94
 .\"
-.Dd May 15, 2006
+.Dd March 18, 2015
 .Dt RECV 2
 .Os
 .Sh NAME
@@ -94,7 +94,9 @@ The
 function is normally used only on a
 .Em connected
 socket (see
-.Xr connect 2 )
+.Xr connect 2 
+or
+.Xr connectx 2 )
 and is identical to
 .Fn recvfrom
 with a
@@ -196,6 +198,7 @@ and
 specify the destination address if the socket is unconnected;
 .Fa msg_name
 may be given as a null pointer if no names are desired or required.
+.Pp
 The
 .Fa msg_iov
 and
@@ -203,6 +206,18 @@ and
 arguments
 describe scatter gather locations, as discussed in
 .Xr read 2 .
+.Fa msg_iovlen 
+shall be set to the dimension of this array. In each 
+.Fa iovec 
+structure, the 
+.Fa iov_base 
+field specifies a storage area and the 
+.Fa iov_len 
+field gives its size in bytes. Each storage area indicated by 
+.Fa msg_iov 
+is filled with received data in turn until all of the received data 
+is stored or all of the areas have been filled.
+.Pp
 The
 .Fa msg_control
 argument,
@@ -245,8 +260,9 @@ The
 field is set on return according to the message received.
 .Dv MSG_EOR
 indicates end-of-record;
-the data returned completed a record (generally used with sockets of type
-.Dv SOCK_SEQPACKET ) .
+the data returned completed a record.
+.\" (generally used with sockets of type
+.\".Dv SOCK_SEQPACKET ) .
 .Dv MSG_TRUNC
 indicates that
 the trailing portion of a datagram was discarded
@@ -298,7 +314,8 @@ An attempt to allocate a memory buffer fails.
 .It Bq Er ENOTCONN
 The socket is associated with a connection-oriented protocol
 and has not been connected (see
-.Xr connect 2
+.Xr connect 2,
+.Xr connectx 2,
 and
 .Xr accept 2 ) .
 .\" ===========
@@ -332,7 +349,12 @@ call may also fail if:
 .Bl -tag -width Er
 .\" ===========
 .It Bq Er EMSGSIZE
-The requested message size is invalid.
+The 
+.Fa msg_iovlen 
+member of the 
+.Fa msghdr 
+structure pointed to by message is less than or equal to 0, or is greater than 
+.Dv IOV_MAX .
 .\" ===========
 .It Bq Er ENOMEM
 Insufficient memory is available.