libutil: add O_NOCTTY back to old pty open code
[minix.git] / lib / libc / sys / recv.2
blob134cdb17dce5a0b074d6defc0550b878ad9d3f50
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
52 and
53 .Fn recvmsg
54 are used to receive messages from a socket,
55 and may be used to receive data on a socket whether or not
56 it is connection-oriented.
57 .Pp
59 .Fa from
60 is non-nil, and the socket is not connection-oriented,
61 the source address of the message is filled in.
62 .Fa fromlen
63 is a value-result parameter, initialized to the size of
64 the buffer associated with
65 .Fa from ,
66 and modified on return to indicate the actual size of the
67 address stored there.
68 .Pp
69 The
70 .Fn recv
71 call is normally used only on a
72 .Em connected
73 socket (see
74 .Xr connect 2 )
75 and is identical to
76 .Fn recvfrom
77 with a nil
78 .Fa from
79 parameter.
80 As it is redundant, it may not be supported in future releases.
81 .Pp
82 All three routines return the length of the message on successful
83 completion.
84 If a message is too long to fit in the supplied buffer,
85 excess bytes may be discarded depending on the type of socket
86 the message is received from (see
87 .Xr socket 2 ) .
88 .Pp
89 If no messages are available at the socket, the
90 receive call waits for a message to arrive, unless
91 the socket is nonblocking (see
92 .Xr fcntl 2 )
93 in which case the value
94 \-1 is returned and the external variable
95 .Va errno
96 set to
97 .Er EAGAIN .
98 The receive calls normally return any data available,
99 up to the requested amount,
100 rather than waiting for receipt of the full amount requested;
101 this behavior is affected by the socket-level options
102 .Dv SO_RCVLOWAT
104 .Dv SO_RCVTIMEO
105 described in
106 .Xr getsockopt 2 .
109 .Xr select 2
111 .Xr poll 2
112 call may be used to determine when more data arrive.
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
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.
131 .Dv MSG_PEEK
132 flag causes the receive operation to return data
133 from the beginning of the receive queue without removing that
134 data from the queue.
135 Thus, a subsequent receive call will return the same data.
137 .Dv MSG_WAITALL
138 flag requests that the operation block until
139 the full request is satisfied.
140 However, the call may still return less data than requested
141 if a signal is caught, an error or disconnect occurs,
142 or the next data to be received is of a different type than that returned.
145 .Fn recvmsg
146 call uses a
147 .Fa msghdr
148 structure to minimize the number of directly supplied parameters.
149 This structure has the following form, as defined in
150 .Ao Pa sys/socket.h Ac :
152 .Bd -literal
153 struct 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 */
164 Here
165 .Fa msg_name
167 .Fa msg_namelen
168 specify the source address if the socket is unconnected;
169 .Fa msg_name
170 may be given as a null pointer if no names are desired or required.
171 If the socket is connected,
172 .Fa msg_name
174 .Fa msg_namelen
175 are ignored.
176 .Fa msg_iov
178 .Fa msg_iovlen
179 describe scatter gather locations, as discussed in
180 .Xr read 2 .
181 .Fa msg_control ,
182 which has length
183 .Fa msg_controllen ,
184 points to a buffer for other protocol control related messages
185 or other miscellaneous ancillary data.
186 The messages are of the form:
187 .Bd -literal
188 struct 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[]; */
196 As an example, one could use this to learn of changes in the data-stream
197 in XNS/SPP, or in ISO, to obtain user-connection-request data by requesting
198 a recvmsg with no data buffer provided immediately after an
199 .Fn accept
200 call.
202 Open file descriptors are now passed as ancillary data for
203 .Dv AF_LOCAL
204 domain sockets, with
205 .Fa cmsg_level
206 set to
207 .Dv SOL_SOCKET
209 .Fa cmsg_type
210 set to
211 .Dv SCM_RIGHTS .
214 .Fa msg_flags
215 field is set on return according to the message received.
216 .Dv MSG_EOR
217 indicates end-of-record;
218 the data returned completed a record (generally used with sockets of type
219 .Dv SOCK_SEQPACKET ) .
220 .Dv MSG_TRUNC
221 indicates that
222 the trailing portion of a datagram was discarded because the datagram
223 was larger than the buffer supplied.
224 .Dv MSG_CTRUNC
225 indicates that some
226 control data were discarded due to lack of space in the buffer
227 for ancillary data.
228 .Dv MSG_OOB
229 is returned to indicate that expedited or out-of-band data were received.
230 .Sh RETURN VALUES
231 These calls return the number of bytes received, or \-1
232 if an error occurred.
233 .Sh ERRORS
234 The calls fail if:
235 .Bl -tag -width Er
236 .It Bq Er EBADF
237 The argument
238 .Fa s
239 is an invalid descriptor.
240 .It Bq Er ENOTCONN
241 The socket is associated with a connection-oriented protocol
242 and has not been connected (see
243 .Xr connect 2
245 .Xr accept 2 ) .
246 .It Bq Er ENOTSOCK
247 The argument
248 .Fa s
249 does not refer to a socket.
250 .It Bq Er EAGAIN
251 The socket is marked non-blocking, and the receive operation
252 would block, or
253 a receive timeout had been set,
254 and the timeout expired before data were received.
255 .It Bq Er EINTR
256 The receive was interrupted by delivery of a signal before
257 any data were available.
258 .It Bq Er EFAULT
259 The receive buffer pointer(s) point outside the process's
260 address space.
261 .It Bq Er EINVAL
262 The total length of the I/O is more than can be expressed by the ssize_t
263 return value.
266 .Fn recvmsg
267 will also fail if:
268 .Bl -tag -width Er
269 .It Bq Er EMSGSIZE
271 .Fa msg_iovlen
272 member of the
273 .Fa msg
274 structure is less than or equal to 0
275 or is greater than
276 .Dv {IOV_MAX} .
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
287 .Fn recv
288 function call appeared in
289 .Bx 4.2 .