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 .\"     $Id$
  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" "int *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 The
 125 .Dv MSG_OOB
 126 flag requests receipt of out-of-band data
 127 that would not be received in the normal data stream.
 128 Some protocols place expedited data at the head of the normal
 129 data queue, and thus this flag cannot be used with such protocols.
 130 The MSG_PEEK flag causes the receive operation to return data
 131 from the beginning of the receive queue without removing that
 132 data from the queue.
 133 Thus, a subsequent receive call will return the same data.
 134 The MSG_WAITALL flag requests that the operation block until
 135 the full request is satisfied.
 136 However, the call may still return less data than requested
 137 if a signal is caught, an error or disconnect occurs,
 138 or the next data to be received is of a different type than that returned.
 139 .Pp
 140 The
 141 .Fn recvmsg
 142 call uses a
 143 .Fa msghdr
 144 structure to minimize the number of directly supplied parameters.
 145 This structure has the following form, as defined in
 146 .Ao Pa sys/socket.h Ac :
 147 .Pp
 148 .Bd -literal
 149 struct msghdr {
 150         caddr_t msg_name;       /* optional address */
 151         u_int   msg_namelen;    /* size of address */
 152         struct  iovec *msg_iov; /* scatter/gather array */
 153         u_int   msg_iovlen;     /* # elements in msg_iov */
 154         caddr_t msg_control;    /* ancillary data, see below */
 155         u_int   msg_controllen; /* ancillary data buffer len */
 156         int     msg_flags;      /* flags on received message */
 157 };
 158 .Ed
 159 .Pp
 160 Here
 161 .Fa msg_name
 162 and
 163 .Fa msg_namelen
 164 specify the destination address if the socket is unconnected;
 165 .Fa msg_name
 166 may be given as a null pointer if no names are desired or required.
 167 .Fa Msg_iov
 168 and
 169 .Fa msg_iovlen
 170 describe scatter gather locations, as discussed in
 171 .Xr read 2 .
 172 .Fa Msg_control ,
 173 which has length
 174 .Fa msg_controllen ,
 175 points to a buffer for other protocol control related messages
 176 or other miscellaneous ancillary data.
 177 The messages are of the form:
 178 .Bd -literal
 179 struct cmsghdr {
 180         u_int   cmsg_len;       /* data byte count, including hdr */
 181         int     cmsg_level;     /* originating protocol */
 182         int     cmsg_type;      /* protocol-specific type */
 183 /* followed by
 184         u_char  cmsg_data[]; */
 185 };
 186 .Ed
 187 As an example, one could use this to learn of changes in the data-stream
 188 in XNS/SPP, or in ISO, to obtain user-connection-request data by requesting
 189 a recvmsg with no data buffer provided immediately after an
 190 .Fn accept
 191 call.
 192 .Pp
 193 Open file descriptors are now passed as ancillary data for
 194 .Dv AF_UNIX
 195 domain sockets, with
 196 .Fa cmsg_level
 197 set to
 198 .Dv SOL_SOCKET
 199 and
 200 .Fa cmsg_type
 201 set to
 202 .Dv SCM_RIGHTS .
 203 .Pp
 204 Process credentials can also be passed as ancillary data for
 205 .Dv AF_UNIX
 206 domain sockets using a
 207 .Fa cmsg_type
 208 of
 209 .Dv SCM_CREDS.
 210 In this case,
 211 .Fa cmsg_data
 212 should be a structure of type
 213 .Fa cmsgcred ,
 214 which is defined in
 215 .Ao Pa sys/socket.h Ac
 216 as follows:
 217 .Pp
 218 .Bd -literal
 219 struct cmsgcred {
 220         pid_t   cmcred_pid;             /* PID of sending process */
 221         uid_t   cmcred_uid;             /* real UID of sending process */
 222         uid_t   cmcred_euid;            /* effective UID of sending process */
 223         gid_t   cmcred_gid;             /* real GID of sending process */
 224         short   cmcred_ngroups;         /* number or groups */
 225         gid_t   cmcred_groups[CMGROUP_MAX];     /* groups */
 226 };
 227 .Ed
 228 .Pp
 229 The kernel will fill in the credential information of the sending process
 230 and deliver it to the receiver.
 231 .Pp
 232 The
 233 .Fa msg_flags
 234 field is set on return according to the message received.
 235 .Dv MSG_EOR
 236 indicates end-of-record;
 237 the data returned completed a record (generally used with sockets of type
 238 .Dv SOCK_SEQPACKET ) .
 239 .Dv MSG_TRUNC
 240 indicates that
 241 the trailing portion of a datagram was discarded because the datagram
 242 was larger than the buffer supplied.
 243 .Dv MSG_CTRUNC
 244 indicates that some
 245 control data were discarded due to lack of space in the buffer
 246 for ancillary data.
 247 .Dv MSG_OOB
 248 is returned to indicate that expedited or out-of-band data were received.
 249 .Pp
 250 .Sh RETURN VALUES
 251 These calls return the number of bytes received, or -1
 252 if an error occurred.
 253 .Sh ERRORS
 254 The calls fail if:
 255 .Bl -tag -width ENOTCONNAA
 256 .It Bq Er EBADF
 257 The argument
 258 .Fa s
 259 is an invalid descriptor.
 260 .It Bq Er ENOTCONN
 261 The socket is associated with a connection-oriented protocol
 262 and has not been connected (see
 263 .Xr connect 2
 264 and
 265 .Xr accept 2 ).
 266 .It Bq Er ENOTSOCK
 267 The argument
 268 .Fa s
 269 does not refer to a socket.
 270 .It Bq Er EAGAIN
 271 The socket is marked non-blocking, and the receive operation
 272 would block, or
 273 a receive timeout had been set,
 274 and the timeout expired before data were received.
 275 .It Bq Er EINTR
 276 The receive was interrupted by delivery of a signal before
 277 any data were available.
 278 .It Bq Er EFAULT
 279 The receive buffer pointer(s) point outside the process's
 280 address space.
 281 .El
 282 .Sh SEE ALSO
 283 .Xr fcntl 2 ,
 284 .Xr getsockopt 2 ,
 285 .Xr read 2 ,
 286 .Xr select 2 ,
 287 .Xr socket 2
 288 .Sh HISTORY
 289 The
 290 .Fn recv
 291 function call appeared in
 292 .Bx 4.2 .