lib/libc/sys/recv.2

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