path: root/man3p/recv.3p

.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved 
.TH "RECV" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\" recv 
.SH NAME
recv \- receive a message from a connected socket
.SH SYNOPSIS
.LP
\fB#include <sys/socket.h>
.br
.sp
ssize_t recv(int\fP \fIsocket\fP\fB, void *\fP\fIbuffer\fP\fB, size_t\fP
\fIlength\fP\fB, int\fP
\fIflags\fP\fB);
.br
\fP
.SH DESCRIPTION
.LP
The \fIrecv\fP() function shall receive a message from a connection-mode
or connectionless-mode socket. It is normally used
with connected sockets because it does not permit the application
to retrieve the source address of received data.
.LP
The \fIrecv\fP() function takes the following arguments:
.TP 7
\fIsocket\fP
Specifies the socket file descriptor.
.TP 7
\fIbuffer\fP
Points to a buffer where the message should be stored.
.TP 7
\fIlength\fP
Specifies the length in bytes of the buffer pointed to by the \fIbuffer\fP
argument.
.TP 7
\fIflags\fP
Specifies the type of message reception. Values of this argument are
formed by logically OR'ing zero or more of the following
values: 
.TP 7
MSG_PEEK
.RS
Peeks at an incoming message. The data is treated as unread and the
next \fIrecv\fP() or similar function shall still return
this data.
.RE
.TP 7
MSG_OOB
.RS
Requests out-of-band data. The significance and semantics of out-of-band
data are protocol-specific.
.RE
.TP 7
MSG_WAITALL
.RS
On SOCK_STREAM sockets this requests that the function block until
the full amount of data can be returned. The function may
return the smaller amount of data if the socket is a message-based
socket, if a signal is caught, if the connection is terminated,
if MSG_PEEK was specified, or if an error is pending for the socket.
.RE
.sp
.sp
.LP
The \fIrecv\fP() function shall return the length of the message written
to the buffer pointed to by the \fIbuffer\fP
argument. For message-based sockets, such as SOCK_DGRAM and SOCK_SEQPACKET,
the entire message shall be read in a single operation.
If a message is too long to fit in the supplied buffer, and MSG_PEEK
is not set in the \fIflags\fP argument, the excess bytes
shall be discarded. For stream-based sockets, such as SOCK_STREAM,
message boundaries shall be ignored. In this case, data shall be
returned to the user as soon as it becomes available, and no data
shall be discarded.
.LP
If the MSG_WAITALL flag is not set, data shall be returned only up
to the end of the first message.
.LP
If no messages are available at the socket and O_NONBLOCK is not set
on the socket's file descriptor, \fIrecv\fP() shall block
until a message arrives. If no messages are available at the socket
and O_NONBLOCK is set on the socket's file descriptor,
\fIrecv\fP() shall fail and set \fIerrno\fP to [EAGAIN] or [EWOULDBLOCK].
.SH RETURN VALUE
.LP
Upon successful completion, \fIrecv\fP() shall return the length of
the message in bytes. If no messages are available to be
received and the peer has performed an orderly shutdown, \fIrecv\fP()
shall return 0. Otherwise, -1 shall be returned and
\fIerrno\fP set to indicate the error.
.SH ERRORS
.LP
The \fIrecv\fP() function shall fail if:
.TP 7
.B EAGAIN \fRor\fP EWOULDBLOCK
.sp
The socket's file descriptor is marked O_NONBLOCK and no data is waiting
to be received; or MSG_OOB is set and no out-of-band data
is available and either the socket's file descriptor is marked O_NONBLOCK
or the socket does not support blocking to await
out-of-band data.
.TP 7
.B EBADF
The \fIsocket\fP argument is not a valid file descriptor.
.TP 7
.B ECONNRESET
A connection was forcibly closed by a peer.
.TP 7
.B EINTR
The \fIrecv\fP() function was interrupted by a signal that was caught,
before any data was available.
.TP 7
.B EINVAL
The MSG_OOB flag is set and no out-of-band data is available.
.TP 7
.B ENOTCONN
A receive is attempted on a connection-mode socket that is not connected.
.TP 7
.B ENOTSOCK
The \fIsocket\fP argument does not refer to a socket.
.TP 7
.B EOPNOTSUPP
The specified flags are not supported for this socket type or protocol.
.TP 7
.B ETIMEDOUT
The connection timed out during connection establishment, or due to
a transmission timeout on active connection.
.sp
.LP
The \fIrecv\fP() function may fail if:
.TP 7
.B EIO
An I/O error occurred while reading from or writing to the file system.
.TP 7
.B ENOBUFS
Insufficient resources were available in the system to perform the
operation.
.TP 7
.B ENOMEM
Insufficient memory was available to fulfill the request.
.sp
.LP
\fIThe following sections are informative.\fP
.SH EXAMPLES
.LP
None.
.SH APPLICATION USAGE
.LP
The \fIrecv\fP() function is equivalent to \fIrecvfrom\fP() with a
zero
\fIaddress_len\fP argument, and to \fIread\fP() if no flags are used.
.LP
The \fIselect\fP() and \fIpoll\fP() functions can
be used to determine when data is available to be received.
.SH RATIONALE
.LP
None.
.SH FUTURE DIRECTIONS
.LP
None.
.SH SEE ALSO
.LP
\fIpoll\fP() , \fIread\fP() , \fIrecvmsg\fP() , \fIrecvfrom\fP() ,
\fIselect\fP() , \fIsend\fP() , \fIsendmsg\fP() , \fIsendto\fP() ,
\fIshutdown\fP() , \fIsocket\fP() , \fIwrite\fP() , the
Base Definitions volume of IEEE\ Std\ 1003.1-2001, \fI<sys/socket.h>\fP
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group. In the
event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .