summaryrefslogtreecommitdiff
path: root/usr/src/man/man3xnet
diff options
context:
space:
mode:
authorRobert Mustacchi <rm@joyent.com>2014-11-16 13:51:26 -0800
committerRobert Mustacchi <rm@joyent.com>2014-11-17 22:09:25 -0800
commit177d5b5f8c0e969013441207a0a705ae66b08cf7 (patch)
tree0648d6d10ceab266a3acb20e2904e89eae510c65 /usr/src/man/man3xnet
parentb998737654179ec0e068e04f6fda6e76777171c9 (diff)
downloadillumos-joyent-177d5b5f8c0e969013441207a0a705ae66b08cf7.tar.gz
5331 want sockaddr(3SOCKET)
Reviewed by: Joshua M. Clulow <josh@sysmgr.org> Reviewed by: Dan McDonald <danmcd@omniti.com> Approved by: Richard Lowe <richlowe@richlowe.net>
Diffstat (limited to 'usr/src/man/man3xnet')
-rw-r--r--usr/src/man/man3xnet/accept.3xnet7
-rw-r--r--usr/src/man/man3xnet/bind.3xnet7
-rw-r--r--usr/src/man/man3xnet/connect.3xnet7
-rw-r--r--usr/src/man/man3xnet/getnameinfo.3xnet8
-rw-r--r--usr/src/man/man3xnet/getpeername.3xnet6
-rw-r--r--usr/src/man/man3xnet/getsockname.3xnet6
-rw-r--r--usr/src/man/man3xnet/recvfrom.3xnet9
-rw-r--r--usr/src/man/man3xnet/sendto.3xnet10
8 files changed, 10 insertions, 50 deletions
diff --git a/usr/src/man/man3xnet/accept.3xnet b/usr/src/man/man3xnet/accept.3xnet
index 79037af1f8..2b78155438 100644
--- a/usr/src/man/man3xnet/accept.3xnet
+++ b/usr/src/man/man3xnet/accept.3xnet
@@ -22,7 +22,6 @@ accept \- accept a new connection on a socket
.fi
.SH DESCRIPTION
-.sp
.LP
The \fBaccept()\fR function extracts the first connection on the queue of
pending connections, creates a new socket with the same socket type protocol
@@ -91,18 +90,15 @@ requests and O_NONBLOCK is set on the file descriptor for the socket,
The accepted socket cannot itself accept more connections. The original socket
remains open and can accept more connections.
.SH USAGE
-.sp
.LP
When a connection is available, \fBselect\fR(3C) will indicate that the file
descriptor for the socket is ready for reading.
.SH RETURN VALUES
-.sp
.LP
Upon successful completion, \fBaccept()\fR returns the nonnegative file
descriptor of the accepted socket. Otherwise, \(mi1 is returned and
\fBerrno\fR is set to indicate the error.
.SH ERRORS
-.sp
.LP
The \fBaccept()\fR function will fail if:
.sp
@@ -243,7 +239,6 @@ been initialized.
.RE
.SH ATTRIBUTES
-.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -261,7 +256,7 @@ MT-Level MT-Safe
.TE
.SH SEE ALSO
-.sp
.LP
+\fBsockaddr\fR(3SOCKET),
\fBbind\fR(3XNET), \fBconnect\fR(3XNET), \fBlisten\fR(3XNET),
\fBsocket\fR(3XNET), \fBattributes\fR(5), \fBstandards\fR(5)
diff --git a/usr/src/man/man3xnet/bind.3xnet b/usr/src/man/man3xnet/bind.3xnet
index 45772c3ff8..12be69fbe3 100644
--- a/usr/src/man/man3xnet/bind.3xnet
+++ b/usr/src/man/man3xnet/bind.3xnet
@@ -22,7 +22,6 @@ bind \- bind a name to a socket
.fi
.SH DESCRIPTION
-.sp
.LP
The \fBbind()\fR function assigns an \fIaddress\fR to an unnamed socket.
Sockets created with \fBsocket\fR(3XNET) function are initially unnamed. They
@@ -65,17 +64,14 @@ Specifies the length of the \fBsockaddr\fR structure pointed to by the
The socket in use may require the process to have appropriate privileges to use
the \fBbind()\fR function.
.SH USAGE
-.sp
.LP
An application program can retrieve the assigned socket name with the
\fBgetsockname\fR(3XNET) function.
.SH RETURN VALUES
-.sp
.LP
Upon successful completion, \fBbind()\fR returns 0. Otherwise, \(mi1 is
returned and \fBerrno\fR is set to indicate the error.
.SH ERRORS
-.sp
.LP
The \fBbind()\fR function will fail if:
.sp
@@ -296,7 +292,6 @@ There were insufficient STREAMS resources for the operation to complete.
.RE
.SH ATTRIBUTES
-.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -314,8 +309,8 @@ MT-Level MT-Safe
.TE
.SH SEE ALSO
-.sp
.LP
+\fBsockaddr\fR(3SOCKET),
\fBconnect\fR(3XNET), \fBgetsockname\fR(3XNET), \fBlisten\fR(3XNET),
\fBsocket\fR(3XNET), \fBattributes\fR(5), \fBprivileges\fR(5),
\fBstandards\fR(5)
diff --git a/usr/src/man/man3xnet/connect.3xnet b/usr/src/man/man3xnet/connect.3xnet
index 50c08bb6c2..14e2ab5494 100644
--- a/usr/src/man/man3xnet/connect.3xnet
+++ b/usr/src/man/man3xnet/connect.3xnet
@@ -21,7 +21,6 @@ connect \- connect a socket
.fi
.SH DESCRIPTION
-.sp
.LP
The \fBconnect()\fR function requests a connection to be made on a socket. The
function takes the following arguments:
@@ -100,18 +99,15 @@ for writing.
The socket in use may require the process to have appropriate privileges to use
the \fBconnect()\fR function.
.SH USAGE
-.sp
.LP
If \fBconnect()\fR fails, the state of the socket is unspecified. Portable
applications should close the file descriptor and create a new socket before
attempting to reconnect.
.SH RETURN VALUES
-.sp
.LP
Upon successful completion, \fBconnect()\fR returns 0. Otherwise, \(mi1 is
returned and \fBerrno\fR is set to indicate the error.
.SH ERRORS
-.sp
.LP
The \fBconnect()\fR function will fail if:
.sp
@@ -388,7 +384,6 @@ The socket is listening and can not be connected.
.RE
.SH ATTRIBUTES
-.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -406,8 +401,8 @@ MT-Level MT-Safe
.TE
.SH SEE ALSO
-.sp
.LP
+\fBsockaddr\fR(3SOCKET),
\fBclose\fR(2), \fBpoll\fR(2), \fBaccept\fR(3XNET), \fBbind\fR(3XNET),
\fBgetsockname\fR(3XNET), \fBselect\fR(3C), \fBsend\fR(3XNET),
\fBshutdown\fR(3XNET), \fBsocket\fR(3XNET), \fBattributes\fR(5),
diff --git a/usr/src/man/man3xnet/getnameinfo.3xnet b/usr/src/man/man3xnet/getnameinfo.3xnet
index 60cef94c6c..b7f43685bd 100644
--- a/usr/src/man/man3xnet/getnameinfo.3xnet
+++ b/usr/src/man/man3xnet/getnameinfo.3xnet
@@ -24,7 +24,6 @@ getnameinfo \- get name information
.fi
.SH DESCRIPTION
-.sp
.LP
The \fBgetnameinfo()\fR function translates a socket address to a node name and
service location, all of which are defined as in \fBgetaddrinfo\fR(3XNET).
@@ -94,7 +93,6 @@ datagram service (\fBSOCK_DGRAM\fR). The default behavior assumes that the
service is a stream service (\fBSOCK_STREAM\fR).
.RE
.SH RETURN VALUES
-.sp
.LP
A 0 return value for \fBgetnameinfo()\fR indicates successful completion; a
non-zero return value indicates failure. The possible values for the failures
@@ -105,7 +103,6 @@ Upon successful completion, \fBgetnameinfo()\fR returns the node and service
names, if requested, in the buffers provided. The returned names are always
null-terminated strings.
.SH ERRORS
-.sp
.LP
The \fBgetnameinfo()\fR function will fail if:
.sp
@@ -175,7 +172,6 @@ A system error occurred. The error code can be found in \fBerrno\fR.
.RE
.SH USAGE
-.sp
.LP
If the returned values are to be used as part of any further name resolution
(for example, passed to \fBgetaddrinfo()\fR), applications should provide
@@ -186,7 +182,6 @@ Given the IPv4-mapped IPv6 address "::ffff:1.2.3.4", the implementation
performs a lookup as if the socket address structure contains the IPv4 address
"1.2.3.4".
.SH ATTRIBUTES
-.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -204,13 +199,12 @@ MT-Level MT-Safe
.TE
.SH SEE ALSO
-.sp
.LP
+\fBsockaddr\fR(3SOCKET),
\fBgai_strerror\fR(3XNET), \fBgetaddrinfo\fR(3XNET),
\fBgetservbyname\fR(3XNET), \fBsocket\fR(3XNET), \fBattributes\fR(5),
\fBstandards\fR(5)
.SH NOTES
-.sp
.LP
The IPv6 unspecified address ("::") and the IPv6 loopback address ("::1") are
not IPv4-compatible addresses. If the address is the IPv6 unspecified address
diff --git a/usr/src/man/man3xnet/getpeername.3xnet b/usr/src/man/man3xnet/getpeername.3xnet
index ed96bd2bf2..4ed8a0bb75 100644
--- a/usr/src/man/man3xnet/getpeername.3xnet
+++ b/usr/src/man/man3xnet/getpeername.3xnet
@@ -21,7 +21,6 @@ getpeername \- get the name of the peer socket
.fi
.SH DESCRIPTION
-.sp
.LP
The \fBgetpeername()\fR function retrieves the peer address of the specified
socket, stores this address in the \fBsockaddr\fR structure pointed to by the
@@ -37,12 +36,10 @@ If the protocol permits connections by unbound clients, and the peer is not
bound, then the value stored in the object pointed to by \fIaddress\fR is
unspecified.
.SH RETURN VALUES
-.sp
.LP
Upon successful completion, 0 is returned. Otherwise, \(mi1 is returned and
\fBerrno\fR is set to indicate the error.
.SH ERRORS
-.sp
.LP
The \fBgetpeername()\fR function will fail if:
.sp
@@ -123,7 +120,6 @@ complete.
.RE
.SH ATTRIBUTES
-.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -141,7 +137,7 @@ MT-Level MT-Safe
.TE
.SH SEE ALSO
-.sp
.LP
+\fBsockaddr\fR(3SOCKET),
\fBaccept\fR(3XNET), \fBbind\fR(3XNET), \fBgetsockname\fR(3XNET),
\fBsocket\fR(3XNET), \fBattributes\fR(5), \fBstandards\fR(5)
diff --git a/usr/src/man/man3xnet/getsockname.3xnet b/usr/src/man/man3xnet/getsockname.3xnet
index 9afeb8cb07..73d3e5206e 100644
--- a/usr/src/man/man3xnet/getsockname.3xnet
+++ b/usr/src/man/man3xnet/getsockname.3xnet
@@ -21,7 +21,6 @@ getsockname \- get the socket name
.fi
.SH DESCRIPTION
-.sp
.LP
The \fBgetsockname()\fR function retrieves the locally-bound name of the
specified socket, stores this address in the \fBsockaddr\fR structure pointed
@@ -36,14 +35,12 @@ If the actual length of the address is greater than the length of the supplied
If the socket has not been bound to a local name, the value stored in the
object pointed to by \fIaddress\fR is unspecified.
.SH RETURN VALUES
-.sp
.LP
Upon successful completion, 0 is returned, the \fIaddress\fR argument points to
the address of the socket, and the \fIaddress_len\fR argument points to the
length of the address. Otherwise, \(mi1 is returned and \fBerrno\fR is set to
indicate the error.
.SH ERRORS
-.sp
.LP
The \fBgetsockname()\fR function will fail:
.sp
@@ -115,7 +112,6 @@ complete.
.RE
.SH ATTRIBUTES
-.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -133,7 +129,7 @@ MT-Level MT-Safe
.TE
.SH SEE ALSO
-.sp
.LP
+\fBsockaddr\fR(3SOCKET),
\fBaccept\fR(3XNET), \fBbind\fR(3XNET), \fBgetpeername\fR(3XNET),
\fBsocket\fR(3XNET) \fBattributes\fR(5), \fBstandards\fR(5)
diff --git a/usr/src/man/man3xnet/recvfrom.3xnet b/usr/src/man/man3xnet/recvfrom.3xnet
index 2d1eec2fcc..1e03959d4d 100644
--- a/usr/src/man/man3xnet/recvfrom.3xnet
+++ b/usr/src/man/man3xnet/recvfrom.3xnet
@@ -22,7 +22,6 @@ recvfrom \- receive a message from a socket
.fi
.SH DESCRIPTION
-.sp
.LP
The \fBrecvfrom()\fR function receives a message from a connection-mode or
connectionless-mode socket. It is normally used with connectionless-mode
@@ -161,19 +160,16 @@ If no messages are available at the socket and \fBO_NONBLOCK\fR is set on the
socket's file descriptor, \fBrecvfrom()\fR fails and sets \fBerrno\fR to
\fBEAGAIN\fR or \fBEWOULDBLOCK\fR.
.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, \fBrecvfrom()\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, \fBrecvfrom()\fR returns 0. Otherwise the
function returns \(mi1 and sets \fBerrno\fR to indicate the error.
.SH ERRORS
-.sp
.LP
The \fBrecvfrom()\fR function will fail if:
.sp
@@ -316,7 +312,6 @@ complete.
.RE
.SH ATTRIBUTES
-.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -334,9 +329,9 @@ MT-Level MT-Safe
.TE
.SH SEE ALSO
-.sp
.LP
-\fBpoll\fR(2), \fBrecv\fR(3XNET), \fBrecvmsg\fR(3XNET), \fBselect\fR(3C)
+\fBpoll\fR(2), \fBsockaddr\fR(3SOCKET),
+\fBrecv\fR(3XNET), \fBrecvmsg\fR(3XNET), \fBselect\fR(3C)
\fBsend\fR(3XNET), \fBsendmsg\fR(3XNET), \fBsendto\fR(3XNET),
\fBshutdown\fR(3XNET), \fBsocket\fR(3XNET), \fBattributes\fR(5),
\fBstandards\fR(5)
diff --git a/usr/src/man/man3xnet/sendto.3xnet b/usr/src/man/man3xnet/sendto.3xnet
index 9c9e75bc57..a3e6bc81f5 100644
--- a/usr/src/man/man3xnet/sendto.3xnet
+++ b/usr/src/man/man3xnet/sendto.3xnet
@@ -21,7 +21,6 @@ sendto \- send a message on a socket
.fi
.SH DESCRIPTION
-.sp
.LP
The \fBsendto()\fR function sends a message through a connection-mode or
connectionless-mode socket. If the socket is connectionless-mode, the message
@@ -53,7 +52,6 @@ descriptor does have \fBO_NONBLOCK\fR set, \fBsendto()\fR will fail.
The socket in use may require the process to have appropriate privileges to use
the \fBsendto()\fR function.
.SH PARAMETERS
-.sp
.LP
The function takes the following arguments:
.sp
@@ -133,17 +131,14 @@ Specifies the length of the \fBsockaddr\fR structure pointed to by the
.RE
.SH USAGE
-.sp
.LP
The \fBselect\fR(3C) and \fBpoll\fR(2) functions can be used to determine when
it is possible to send more data.
.SH RETURN VALUES
-.sp
.LP
Upon successful completion, \fBsendto()\fR returns the number of bytes sent.
Otherwise, \fB-1\fR is returned and \fBerrno\fR is set to indicate the error.
.SH ERRORS
-.sp
.LP
The \fBsendto()\fR function will fail if:
.sp
@@ -427,7 +422,6 @@ length exceeds \fIPATH_MAX\fR.
.RE
.SH ATTRIBUTES
-.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -445,9 +439,9 @@ MT-Level MT-Safe
.TE
.SH SEE ALSO
-.sp
.LP
-\fBpoll\fR(2), \fBgetsockopt\fR(3XNET), \fBrecv\fR(3XNET),
+\fBpoll\fR(2), \fBsockaddr\fR(3SOCKET),
+\fBgetsockopt\fR(3XNET), \fBrecv\fR(3XNET),
\fBrecvfrom\fR(3XNET), \fBrecvmsg\fR(3XNET), \fBselect\fR(3C),
\fBsend\fR(3XNET), \fBsendmsg\fR(3XNET), \fBsetsockopt\fR(3XNET),
\fBshutdown\fR(3XNET), \fBsocket\fR(3XNET), \fBattributes\fR(5),