1.\" $NetBSD: recv.2,v 1.27 2006/04/23 19:06:59 wiz Exp $ 2.\" 3.\" Copyright (c) 1983, 1990, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. Neither the name of the University nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.\" @(#)recv.2 8.3 (Berkeley) 2/21/94 31.\" 32.Dd April 23, 2006 33.Dt RECV 2 34.Os 35.Sh NAME 36.Nm recv , 37.Nm recvfrom , 38.Nm recvmsg 39.Nd receive a message from a socket 40.Sh LIBRARY 41.Lb libc 42.Sh SYNOPSIS 43.In sys/socket.h 44.Ft ssize_t 45.Fn recv "int s" "void *buf" "size_t len" "int flags" 46.Ft ssize_t 47.Fn recvfrom "int s" "void * restrict buf" "size_t len" "int flags" "struct sockaddr * restrict from" "socklen_t * restrict fromlen" 48.Ft ssize_t 49.Fn recvmsg "int s" "struct msghdr *msg" "int flags" 50.Sh DESCRIPTION 51.Fn recvfrom 52and 53.Fn recvmsg 54are used to receive messages from a socket, 55and may be used to receive data on a socket whether or not 56it is connection-oriented. 57.Pp 58If 59.Fa from 60is non-nil, and the socket is not connection-oriented, 61the source address of the message is filled in. 62.Fa fromlen 63is a value-result parameter, initialized to the size of 64the buffer associated with 65.Fa from , 66and modified on return to indicate the actual size of the 67address stored there. 68.Pp 69The 70.Fn recv 71call is normally used only on a 72.Em connected 73socket (see 74.Xr connect 2 ) 75and is identical to 76.Fn recvfrom 77with a nil 78.Fa from 79parameter. 80As it is redundant, it may not be supported in future releases. 81.Pp 82All three routines return the length of the message on successful 83completion. 84If a message is too long to fit in the supplied buffer, 85excess bytes may be discarded depending on the type of socket 86the message is received from (see 87.Xr socket 2 ) . 88.Pp 89If no messages are available at the socket, the 90receive call waits for a message to arrive, unless 91the socket is nonblocking (see 92.Xr fcntl 2 ) 93in which case the value 94\-1 is returned and the external variable 95.Va errno 96set to 97.Er EAGAIN . 98The receive calls normally return any data available, 99up to the requested amount, 100rather than waiting for receipt of the full amount requested; 101this behavior is affected by the socket-level options 102.Dv SO_RCVLOWAT 103and 104.Dv SO_RCVTIMEO 105described in 106.Xr getsockopt 2 . 107.Pp 108The 109.Xr select 2 110or 111.Xr poll 2 112call may be used to determine when more data arrive. 113.Pp 114The 115.Fa flags 116argument to a recv call is formed by 117.Em or Ap ing 118one or more of the values: 119.Bl -column MSG_WAITALL -offset indent 120.It Dv MSG_OOB Ta process out-of-band data 121.It Dv MSG_PEEK Ta peek at incoming message 122.It Dv MSG_WAITALL Ta wait for full request or error 123.El 124The 125.Dv MSG_OOB 126flag requests receipt of out-of-band data 127that would not be received in the normal data stream. 128Some protocols place expedited data at the head of the normal 129data queue, and thus this flag cannot be used with such protocols. 130The 131.Dv MSG_PEEK 132flag causes the receive operation to return data 133from the beginning of the receive queue without removing that 134data from the queue. 135Thus, a subsequent receive call will return the same data. 136The 137.Dv MSG_WAITALL 138flag requests that the operation block until 139the full request is satisfied. 140However, the call may still return less data than requested 141if a signal is caught, an error or disconnect occurs, 142or the next data to be received is of a different type than that returned. 143.Pp 144The 145.Fn recvmsg 146call uses a 147.Fa msghdr 148structure to minimize the number of directly supplied parameters. 149This structure has the following form, as defined in 150.Ao Pa sys/socket.h Ac : 151.Pp 152.Bd -literal 153struct msghdr { 154 void *msg_name; /* optional address */ 155 socklen_t msg_namelen; /* size of address */ 156 struct iovec *msg_iov; /* scatter/gather array */ 157 int msg_iovlen; /* # elements in msg_iov */ 158 void *msg_control; /* ancillary data, see below */ 159 socklen_t msg_controllen; /* ancillary data buffer len */ 160 int msg_flags; /* flags on received message */ 161}; 162.Ed 163.Pp 164Here 165.Fa msg_name 166and 167.Fa msg_namelen 168specify the source address if the socket is unconnected; 169.Fa msg_name 170may be given as a null pointer if no names are desired or required. 171If the socket is connected, 172.Fa msg_name 173and 174.Fa msg_namelen 175are ignored. 176.Fa msg_iov 177and 178.Fa msg_iovlen 179describe scatter gather locations, as discussed in 180.Xr read 2 . 181.Fa msg_control , 182which has length 183.Fa msg_controllen , 184points to a buffer for other protocol control related messages 185or other miscellaneous ancillary data. 186The messages are of the form: 187.Bd -literal 188struct cmsghdr { 189 socklen_t cmsg_len; /* data byte count, including hdr */ 190 int cmsg_level; /* originating protocol */ 191 int cmsg_type; /* protocol-specific type */ 192/* followed by 193 u_char cmsg_data[]; */ 194}; 195.Ed 196As an example, one could use this to learn of changes in the data-stream 197in XNS/SPP, or in ISO, to obtain user-connection-request data by requesting 198a recvmsg with no data buffer provided immediately after an 199.Fn accept 200call. 201.Pp 202Open file descriptors are now passed as ancillary data for 203.Dv AF_LOCAL 204domain sockets, with 205.Fa cmsg_level 206set to 207.Dv SOL_SOCKET 208and 209.Fa cmsg_type 210set to 211.Dv SCM_RIGHTS . 212.Pp 213The 214.Fa msg_flags 215field is set on return according to the message received. 216.Dv MSG_EOR 217indicates end-of-record; 218the data returned completed a record (generally used with sockets of type 219.Dv SOCK_SEQPACKET ) . 220.Dv MSG_TRUNC 221indicates that 222the trailing portion of a datagram was discarded because the datagram 223was larger than the buffer supplied. 224.Dv MSG_CTRUNC 225indicates that some 226control data were discarded due to lack of space in the buffer 227for ancillary data. 228.Dv MSG_OOB 229is returned to indicate that expedited or out-of-band data were received. 230.Sh RETURN VALUES 231These calls return the number of bytes received, or \-1 232if an error occurred. 233.Sh ERRORS 234The calls fail if: 235.Bl -tag -width Er 236.It Bq Er EBADF 237The argument 238.Fa s 239is an invalid descriptor. 240.It Bq Er ENOTCONN 241The socket is associated with a connection-oriented protocol 242and has not been connected (see 243.Xr connect 2 244and 245.Xr accept 2 ) . 246.It Bq Er ENOTSOCK 247The argument 248.Fa s 249does not refer to a socket. 250.It Bq Er EAGAIN 251The socket is marked non-blocking, and the receive operation 252would block, or 253a receive timeout had been set, 254and the timeout expired before data were received. 255.It Bq Er EINTR 256The receive was interrupted by delivery of a signal before 257any data were available. 258.It Bq Er EFAULT 259The receive buffer pointer(s) point outside the process's 260address space. 261.It Bq Er EINVAL 262The total length of the I/O is more than can be expressed by the ssize_t 263return value. 264.El 265.Pp 266.Fn recvmsg 267will also fail if: 268.Bl -tag -width Er 269.It Bq Er EMSGSIZE 270The 271.Fa msg_iovlen 272member of the 273.Fa msg 274structure is less than or equal to 0 275or is greater than 276.Dv {IOV_MAX} . 277.El 278.Sh SEE ALSO 279.Xr fcntl 2 , 280.Xr getsockopt 2 , 281.Xr poll 2 , 282.Xr read 2 , 283.Xr select 2 , 284.Xr socket 2 285.Sh HISTORY 286The 287.Fn recv 288function call appeared in 289.Bx 4.2 . 290