summaryrefslogtreecommitdiff
path: root/usr/src/man/man3xnet/recvmsg.3xnet
diff options
context:
space:
mode:
Diffstat (limited to 'usr/src/man/man3xnet/recvmsg.3xnet')
-rw-r--r--usr/src/man/man3xnet/recvmsg.3xnet16
1 files changed, 8 insertions, 8 deletions
diff --git a/usr/src/man/man3xnet/recvmsg.3xnet b/usr/src/man/man3xnet/recvmsg.3xnet
index 2636c2a67a..033e1928f1 100644
--- a/usr/src/man/man3xnet/recvmsg.3xnet
+++ b/usr/src/man/man3xnet/recvmsg.3xnet
@@ -42,8 +42,9 @@
.\"
.\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
.\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
+.\" Copyright (c) 2018, Joyent, Inc.
.\"
-.TH RECVMSG 3XNET "Feb 27, 2006"
+.TH RECVMSG 3XNET "September 10, 2018"
.SH NAME
recvmsg \- receive a message from a socket
.SH SYNOPSIS
@@ -56,7 +57,6 @@ recvmsg \- receive a message from a socket
.fi
.SH DESCRIPTION
-.sp
.LP
The \fBrecvmsg()\fR function receives a message from a connection-mode or
connectionless-mode socket. It is normally used with connectionless-mode
@@ -165,7 +165,6 @@ Control data was truncated.
.RE
.SH PARAMETERS
-.sp
.LP
The function takes the following arguments:
.sp
@@ -231,18 +230,21 @@ an error is pending for the socket.
.RE
.SH USAGE
-.sp
.LP
The \fBselect\fR(3C) and \fBpoll\fR(2) functions can be used to determine when
data is available to be received.
.SH RETURN VALUES
-.sp
.LP
Upon successful completion, \fBrecvmsg()\fR returns the length of the message
in bytes. If no messages are available to be received and the peer has
performed an orderly shutdown, \fBrecvmsg()\fR returns \fB0\fR. Otherwise,
\fB\(mi1\fR is returned and \fBerrno\fR is set to indicate the error.
.SH ERRORS
+.LP
+In addition to the errors documented below, an asynchronous error generated by
+the underlying socket protocol may be returned. For the full list of errors,
+please see the corresponding socket protocol manual page. For example, for a
+list of TCP errors, please see \fBtcp\fR(7P).
.sp
.LP
The \fBrecvmsg()\fR function will fail if:
@@ -399,7 +401,6 @@ complete.
.RE
.SH ATTRIBUTES
-.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -417,9 +418,8 @@ MT-Level MT-Safe
.TE
.SH SEE ALSO
-.sp
.LP
\fBpoll\fR(2), \fBrecv\fR(3XNET), \fBrecvfrom\fR(3XNET), \fBselect\fR(3C),
\fBsend\fR(3XNET), \fBsendmsg\fR(3XNET), \fBsendto\fR(3XNET),
\fBsetsockopt\fR(3XNET), \fBshutdown\fR(3XNET), \fBsocket\fR(3XNET),
-\fBsocket.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)
+\fBsocket.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5), \fBtcp\fR(7P)