diff options
Diffstat (limited to 'usr/src/man/man3xnet/getsockopt.3xnet')
| -rw-r--r-- | usr/src/man/man3xnet/getsockopt.3xnet | 67 |
1 files changed, 8 insertions, 59 deletions
diff --git a/usr/src/man/man3xnet/getsockopt.3xnet b/usr/src/man/man3xnet/getsockopt.3xnet index dd3528b654..48ea7719fe 100644 --- a/usr/src/man/man3xnet/getsockopt.3xnet +++ b/usr/src/man/man3xnet/getsockopt.3xnet @@ -1,13 +1,13 @@ '\" te .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved. Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved. -.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at .\" http://www.opengroup.org/bookstore/. .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions 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. .\" This notice shall appear on any product containing this material. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH getsockopt 3XNET "21 Jan 2007" "SunOS 5.11" "X/Open Networking Services Library Functions" +.TH GETSOCKOPT 3XNET "Jan 21, 2007" .SH NAME getsockopt \- get the socket options .SH SYNOPSIS @@ -49,36 +49,30 @@ The \fIoption_name\fR argument specifies a single option to be retrieved. It can be one of the following values defined in \fB<sys/socket.h>\fR: .sp .ne 2 -.mk .na \fB\fBSO_DEBUG\fR\fR .ad .RS 17n -.rt Reports whether debugging information is being recorded. This option stores an \fBint\fR value. This is a boolean option. .RE .sp .ne 2 -.mk .na \fB\fBSO_ACCEPTCONN\fR\fR .ad .RS 17n -.rt Reports whether socket listening is enabled. This option stores an \fBint\fR value. .RE .sp .ne 2 -.mk .na \fB\fBSO_BROADCAST\fR\fR .ad .RS 17n -.rt Reports whether transmission of broadcast messages is supported, if this is supported by the protocol. This option stores an \fBint\fR value. This is a boolean option. @@ -86,12 +80,10 @@ boolean option. .sp .ne 2 -.mk .na \fB\fBSO_REUSEADDR\fR\fR .ad .RS 17n -.rt Reports whether the rules used in validating addresses supplied to \fBbind\fR(3XNET) should allow reuse of local addresses, if this is supported by the protocol. This option stores an \fBint\fR value. This is a boolean @@ -100,12 +92,10 @@ option. .sp .ne 2 -.mk .na \fB\fBSO_KEEPALIVE\fR\fR .ad .RS 17n -.rt Reports whether connections are kept active with periodic transmission of messages, if this is supported by the protocol. .sp @@ -118,12 +108,10 @@ This is a boolean option. .sp .ne 2 -.mk .na \fB\fBSO_LINGER\fR\fR .ad .RS 17n -.rt Reports whether the socket lingers on \fBclose\fR(2) if data is present. If \fBSO_LINGER\fR is set, the system blocks the process during \fBclose\fR(2) until it can transmit the data or until the end of the interval indicated by @@ -135,12 +123,10 @@ a \fBlinger\fR structure. .sp .ne 2 -.mk .na \fB\fBSO_OOBINLINE\fR\fR .ad .RS 17n -.rt Reports whether the socket leaves received out-of-band data (data marked urgent) in line. This option stores an \fBint\fR value. This is a boolean option. @@ -148,57 +134,47 @@ option. .sp .ne 2 -.mk .na \fB\fBSO_SNDBUF\fR\fR .ad .RS 17n -.rt Reports send buffer size information. This option stores an \fBint\fR value. .RE .sp .ne 2 -.mk .na \fB\fBSO_RCVBUF\fR\fR .ad .RS 17n -.rt Reports receive buffer size information. This option stores an \fBint\fR value. .RE .sp .ne 2 -.mk .na \fB\fBSO_ERROR\fR\fR .ad .RS 17n -.rt Reports information about error status and clears it. This option stores an \fBint\fR value. .RE .sp .ne 2 -.mk .na \fB\fBSO_TYPE\fR\fR .ad .RS 17n -.rt Reports the socket type. This option stores an \fBint\fR value. .RE .sp .ne 2 -.mk .na \fB\fBSO_DONTROUTE\fR\fR .ad .RS 17n -.rt Reports whether outgoing messages bypass the standard routing facilities. The destination must be on a directly-connected network, and messages are directed to the appropriate network interface according to the destination address. The @@ -208,12 +184,10 @@ stores an \fBint\fR value. This is a boolean option. .sp .ne 2 -.mk .na \fB\fBSO_MAC_EXEMPT\fR\fR .ad .RS 17n -.rt Gets the mandatory access control status of the socket. A socket that has this option enabled can communicate with an unlabeled peer if the socket is in the global zone or has a label that dominates the default label of the peer. @@ -224,12 +198,10 @@ available only when the system is configured with Trusted Extensions. .sp .ne 2 -.mk .na \fB\fBSO_ALLZONES\fR\fR .ad .RS 17n -.rt Bypasses zone boundaries (privileged). This option stores an \fBint\fR value. This is a boolean option. .sp @@ -253,23 +225,19 @@ privilege. See \fBzones\fR(5). .sp .ne 2 -.mk .na \fB\fBSO_DOMAIN\fR\fR .ad .RS 17n -.rt get the domain used in the socket (get only) .RE .sp .ne 2 -.mk .na \fB\fBSO_PROTOTYPE\fR\fR .ad .RS 17n -.rt for socket in domains \fBAF_INET\fR and \fBAF_INET6\fR, get the underlying protocol number used in the socket. For socket in domain \fBAF_ROUTE\fR, get the address family used in the socket. @@ -297,57 +265,47 @@ Upon successful completion, \fBgetsockopt()\fR returns \fB0\fR. Otherwise, The \fBgetsockopt()\fR function will fail if: .sp .ne 2 -.mk .na \fB\fBEBADF\fR\fR .ad .RS 15n -.rt The \fIsocket\fR argument is not a valid file descriptor. .RE .sp .ne 2 -.mk .na \fB\fBEFAULT\fR\fR .ad .RS 15n -.rt The \fIoption_value\fR or \fIoption_len\fR parameter can not be accessed or written. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 15n -.rt The specified option is invalid at the specified socket level. .RE .sp .ne 2 -.mk .na \fB\fBENOPROTOOPT\fR\fR .ad .RS 15n -.rt The option is not supported by the protocol. .RE .sp .ne 2 -.mk .na \fB\fBENOTSOCK\fR\fR .ad .RS 15n -.rt The \fIsocket\fR argument does not refer to a socket. .RE @@ -356,45 +314,37 @@ The \fIsocket\fR argument does not refer to a socket. The \fBgetsockopt()\fR function may fail if: .sp .ne 2 -.mk .na \fB\fBEACCES\fR\fR .ad .RS 11n -.rt The calling process does not have the appropriate privileges. .RE .sp .ne 2 -.mk .na \fB\fBEINVAL\fR\fR .ad .RS 11n -.rt The socket has been shut down. .RE .sp .ne 2 -.mk .na \fB\fBENOBUFS\fR\fR .ad .RS 11n -.rt Insufficient resources are available in the system to complete the call. .RE .sp .ne 2 -.mk .na \fB\fBENOSR\fR\fR .ad .RS 11n -.rt There were insufficient STREAMS resources available for the operation to complete. .RE @@ -407,15 +357,14 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityStandard +Interface Stability Standard _ -MT-LevelMT-Safe +MT-Level MT-Safe .TE .SH SEE ALSO |