(split) Import translated manuals from JM CVS Repository.

[linuxjm/LDP_man-pages.git] / draft / man2 / getsockopt.2

.\" Copyright (c) 1983, 1991 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"     This product includes software developed by the University of
.\"     California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     $Id: getsockopt.2,v 1.1 1999/05/24 14:57:04 freitag Exp $
.\"
.\" Modified Sat Jul 24 16:19:32 1993 by Rik Faith (faith@cs.unc.edu)
.\" Modified Mon Apr 22 02:29:06 1996 by Martin Schulze (joey@infodrom.north.de)
.\" Modified Tue Aug 27 10:52:51 1996 by Andries Brouwer (aeb@cwi.nl)
.\" Modified Thu Jan 23 13:29:34 1997 by Andries Brouwer (aeb@cwi.nl)
.\" Modified Sun Mar 28 21:26:46 1999 by Andries Brouwer (aeb@cwi.nl)
.\" Modified 1999 by Andi Kleen <ak@muc.de>.
.\"     Removed most stuff because it is in socket.7 now.
.\"
.\" Japanese Version Copyright (c) 1996 Akira Yoshiyama
.\"         all rights reserved.
.\" Translated Sat Jul  6 00:43:37 JST 1996
.\"         by Akira Yoshiyama <yosshy@jedi.seg.kobe-u.ac.jp>
.\" Modified Fri Nov  7 22:45:27 JST 1997
.\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
.\" Updated Sun Oct 12 JST 2003 by Kentaro Shirakata <argrath@ub32.org>
.\"
.TH GETSOCKOPT 2 2008-12-03 "Linux" "Linux Programmer's Manual"
.\"O .SH NAME
.SH ̾Á°
.\"O getsockopt, setsockopt \- get and set options on sockets
getsockopt, setsockopt \- ¥½¥±¥Ã¥È¤Î¥ª¥×¥·¥ç¥ó¤ÎÀßÄê¤È¼èÆÀ¤ò¹Ô¤Ê¤¦
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.nf
.\"O .BR "#include <sys/types.h>" "          /* See NOTES */"
.BR "#include <sys/types.h>" "          /* ¡ÖÃí°Õ¡×»²¾È */"
.br
.B #include <sys/socket.h>
.sp
.BI "int getsockopt(int " sockfd ", int " level ", int " optname ,
.BI "               void *" optval ", socklen_t *" optlen );
.BI "int setsockopt(int " sockfd ", int " level ", int " optname ,
.BI "               const void *" optval ", socklen_t " optlen );
.fi
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O .BR getsockopt ()
.\"O and
.\"O .BR setsockopt ()
.\"O manipulate options for the socket referred to by the file descriptor
.\"O .IR sockfd .
.\"O Options may exist at multiple
.\"O protocol levels; they are always present at the uppermost
.\"O socket level.
.BR getsockopt ()
¤È
.BR setsockopt ()
¤Ï¡¢¥Õ¥¡¥¤¥ë¥Ç¥£¥¹¥¯¥ê¥×¥¿
.I socket
¤Ç»²¾È¤µ¤ì¤ë¥½¥±¥Ã¥È¤Ë´ØÏ¢¤¹¤ë¥ª¥×¥·¥ç¥ó¤ÎÁàºî¤ò¹Ô¤¦¡£
¥ª¥×¥·¥ç¥ó¤ÏÊ£¿ô¤Î¥×¥í¥È¥³¥ëÁØ(level)¤Ë¸ºß¤¹¤ë¤«¤â¤·¤ì¤Ê¤¤¤¬¡¢
¤³¤ì¤é¤Ï¾ï¤ËºÇ¾å°Ì¤Î¥½¥±¥Ã¥ÈÁؤؤÈÀßÄꤵ¤ì¤ë¡£

.\"O When manipulating socket options, the level at which the
.\"O option resides and the name of the option must be specified.
.\"O To manipulate options at the sockets API level,
.\"O .I level
.\"O is specified as
.\"O .BR SOL_SOCKET .
.\"O To manipulate options at any
.\"O other level the protocol number of the appropriate protocol
.\"O controlling the option is supplied.
.\"O For example,
.\"O to indicate that an option is to be interpreted by the
.\"O .B TCP
.\"O protocol,
.\"O .I level
.\"O should be set to the protocol number of
.\"O .BR TCP ;
.\"O see
.\"O .BR getprotoent (3).
¥½¥±¥Ã¥È¡¦¥ª¥×¥·¥ç¥ó¤òÁàºî¤¹¤ëºÝ¤Ë¤Ï¡¢¥ª¥×¥·¥ç¥ó¤ÎÁØ (level) ¤È
¥ª¥×¥·¥ç¥ó¤Î̾Á°¤ò»ØÄꤷ¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
¥½¥±¥Ã¥È API Áؤǥª¥×¥·¥ç¥ó¤òÁàºî¤¹¤ë°Ù¤Ë¤Ï¡¢
.I level
¤ò
.B SOL_SOCKET
¤Ë»ØÄꤹ¤ë¡£
¾¤ÎÁ´¤Æ¤ÎÁؤǥª¥×¥·¥ç¥ó¤òÁàºî¤¹¤ë°Ù¤Ë¤Ï¡¢Í¿¤¨¤é¤ì¤¿¥ª¥×¥·¥ç¥ó¤Î
À©¸æ¼çÂΤȤʤë¥×¥í¥È¥³¥ë¤Î¥×¥í¥È¥³¥ëÈÖ¹æ¤ò»ØÄꤹ¤ë¡£Î㤨¤Ð¡¢
¥ª¥×¥·¥ç¥ó¤¬
.B TCP
¥×¥í¥È¥³¥ë¤Ç²ò¼á¤µ¤ì¤ë¤Ù¤­¤³¤È¤ò»Ø¼¨¤¹¤ë¤Ë¤Ï¡¢
.I level
¤Ë
.B TCP
¤Î¥×¥í¥È¥³¥ëÈÖ¹æ¤ò»ØÄꤷ¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
.BR getprotoent (3)
¤ò»²¾È¤¹¤ë¤³¤È¡£

.\"O The arguments
.\"O .I optval
.\"O and
.\"O .I optlen
.\"O are used to access option values for
.\"O .BR setsockopt ().
.I optval
¤È
.I optlen
°ú¤­¿ô¤Ï
.BR setsockopt ()
¤Î¥ª¥×¥·¥ç¥ó¤ÎÃͤ˥¢¥¯¥»¥¹¤¹¤ë¤¿¤á¤ËÍѤ¤¤é¤ì¤ë¡£
.\"O For
.\"O .BR getsockopt ()
.\"O they identify a buffer in which the value for the
.\"O requested option(s) are to be returned.
.BR getsockopt ()
¤Ç¤ÏÍ׵ᤷ¤¿¥ª¥×¥·¥ç¥ó¤ÎÃͤòÊÖ¤¹¤¿¤á¤Î¥Ð¥Ã¥Õ¥¡¡¼¤ò»ØÄꤹ¤ë¡£
.\"O For
.\"O .BR getsockopt (),
.\"O .I optlen
.\"O is a value-result argument, initially containing the
.\"O size of the buffer pointed to by
.\"O .IR optval ,
.\"O and modified on return to indicate the actual size of
.\"O the value returned.
.\"O If no option value is to be supplied or returned,
.\"O .I optval
.\"O may be NULL.
.BR getsockopt ()
¤Ç¤Ï
.I optlen
¤ÏÃͤȷë²ÌξÍѤΰú¤­¿ô¤Ç¡¢ºÇ½é¤Ë
.I optval
¤Î»Ø¤·¤Æ¤¤¤ë¥Ð¥Ã¥Õ¥¡¡¼¤Î¥µ¥¤¥º¤òÍ¿¤¨¡¢¼ÂºÝ¤ËÊÖ¤µ¤ì¤ëÃͤΥµ¥¤¥º¤Ë
½ñ¤­´¹¤¨¤é¤ì¤ë¡£¤â¤·¥ª¥×¥·¥ç¥óÃͤòÍ¿¤¨¤º¡¢ÊÖ¤µ¤ì¤â¤·¤Ê¤¤¾ì¹ç¤Ë¤Ï
.I optval
¤Ï NULL ¤Ç¤âÎɤ¤¡£

.\"O .I Optname
.\"O and any specified options are passed uninterpreted to the appropriate
.\"O protocol module for interpretation.
.\"O The include file
.\"O .I <sys/socket.h>
.\"O contains definitions for socket level options, described below.
.\"O Options at
.\"O other protocol levels vary in format and name; consult the appropriate
.\"O entries in section 4 of the manual.
.I optname
¤ª¤è¤Ó»ØÄꤵ¤ì¤¿¥ª¥×¥·¥ç¥ó¤Ï²ò¼á¤µ¤ì¤º¤Ë¡¢Å¬Àڤʥץí¥È¥³¥ë¡¦¥â¥¸¥å¡¼¥ë¤Ë
ÅϤµ¤ì¤Æ²ò¼á¤µ¤ì¤ë¡£¥¤¥ó¥¯¥ë¡¼¥É¡¦¥Õ¥¡¥¤¥ë
.I <sys/socket.h>
¤Ë¤Ï¸å½Ò¤Î¥½¥±¥Ã¥ÈÁؤΥª¥×¥·¥ç¥ó¤ÎÄêµÁ¤¬´Þ¤Þ¤ì¤Æ¤¤¤ë¡£
¾¤Î¥×¥í¥È¥³¥ëÁؤǤÏ̾Á°¤ä·Á¼°¤Ï°Û¤Ê¤ë¡£
¥Þ¥Ë¥å¥¢¥ë¤Î¥»¥¯¥·¥ç¥ó 4 ¤ÎŬÀڤʥ¨¥ó¥È¥ê¤ò»²¾È¤¹¤ë¤³¤È¡£

.\"O Most socket-level options utilize an
.\"O .I int
.\"O argument for
.\"O .IR optval .
.\"O For
.\"O .BR setsockopt (),
.\"O the argument should be nonzero to enable a boolean option, or zero if the
.\"O option is to be disabled.
¤Û¤È¤ó¤É¤Î¥½¥±¥Ã¥ÈÁؤΥª¥×¥·¥ç¥ó¤Ï
.I optval
¤Ë
.I int
°ú¤­¿ô¤òÍøÍѤ¹¤ë¡£
.BR setsockopt ()
¤Ç¡¢ÆóÃÍ(boolean)¥ª¥×¥·¥ç¥ó¤òÍ­¸ú(enable)¤Ë¤¹¤ë¤Ë¤Ï¥¼¥í°Ê³°¤ò»ØÄꤷ¡¢
̵¸ú(disable)¤Ë¤¹¤ë¤Ë¤Ï¥¼¥í¤ò»ØÄꤹ¤ë¡£
.PP
.\"O For a description of the available socket options see
.\"O .BR socket (7)
.\"O and the appropriate protocol man pages.
ÍøÍѲÄǽ¤Ê¥½¥±¥Ã¥È¥ª¥×¥·¥ç¥ó¤ÎÀâÌÀ¤Ë´Ø¤·¤Æ¤Ï¡¢
.BR socket (7)
¤ÈŬÀڤʥץí¥È¥³¥ë¤Î man ¥Ú¡¼¥¸¤ò»²¾È¤Î¤³¤È¡£
.\"O .SH "RETURN VALUE"
.SH ÊÖ¤êÃÍ
.\"O On success, zero is returned.
.\"O On error, \-1 is returned, and
.\"O .I errno
.\"O is set appropriately.
À®¸ù¤·¤¿¾ì¹ç¤Ë¤Ï¥¼¥í¤òÊÖ¤¹¡£¥¨¥é¡¼»þ¤Ë¤Ï \-1 ¤¬ÊÖ¤µ¤ì¡¢
.I errno
¤¬Å¬ÀÚ¤ËÀßÄꤵ¤ì¤ë¡£
.\"O .SH ERRORS
.SH ¥¨¥é¡¼
.TP 10
.B EBADF
.\"O The argument
.\"O .I sockfd
.\"O is not a valid descriptor.
°ú¤­¿ô
.I sockfd
¤¬Í­¸ú¤Ê¥Ç¥£¥¹¥¯¥ê¥×¥¿¤Ç¤Ê¤¤¡£
.TP
.B EFAULT
.\"O The address pointed to by
.\"O .I optval
.\"O is not in a valid part of the process address space.
.\"O For
.\"O .BR getsockopt (),
.\"O this error may also be returned if
.\"O .I optlen
.\"O is not in a valid part of the process address space.
.I optval
¤Ç»ØÄꤵ¤ì¤¿¥¢¥É¥ì¥¹¤¬¥×¥í¥»¥¹¤Î¥¢¥É¥ì¥¹¶õ´Ö¤ÎÍ­¸ú¤ÊÉôʬ¤Ç¤Ï¤Ê¤¤¡£
.BR getsockopt ()
¤Î¾ì¹ç¡¢
.I optlen
¤¬¥×¥í¥»¥¹¤Î¥¢¥É¥ì¥¹¶õ´Ö¤ÎÍ­¸ú¤ÊÉôʬ¤Ç¤Ê¤¤¾ì¹ç¤Ë¤â¤³¤Î¥¨¥é¡¼¤¬ÊÖ¤µ¤ì¤ë¡£
.TP
.B EINVAL
.\"O .I optlen
.\"O invalid in
.\"O .BR setsockopt ().
.BR setsockopt ()
¤Ç
.I option
¤¬ÉÔÀµ¤Ç¤¢¤ë¡£
.\"O In some cases this error can also occur for an invalid value in
.\"O .IR optval
.\"O (e.g., for the
.\"O .B IP_ADD_MEMBERSHIP
.\"O option described in
.\"O .BR ip (7)).
.I optval
¤Ë̵¸ú¤ÊÃͤ¬»ØÄꤵ¤ì¤¿¾ì¹ç¤Ë¤â¡¢¤³¤Î¥¨¥é¡¼¤¬È¯À¸¤¹¤ë²ÄǽÀ­¤¬¤¢¤ë
(Î㤨¤Ð¡¢
.BR ip (7)
¤ËÀâÌÀ¤¬¤¢¤ë
.B IP_ADD_MEMBERSHIP
¥ª¥×¥·¥ç¥ó¤Ê¤É)¡£
.TP
.B ENOPROTOOPT
.\"O The option is unknown at the level indicated.
»ØÄꤵ¤ì¤¿ÁØ(level)¤Ë¤Ï¤³¤Î¥ª¥×¥·¥ç¥ó¤Ï¸ºß¤·¤Ê¤¤¡£
.TP
.B ENOTSOCK
.\"O The argument
.\"O .I sockfd
.\"O is a file, not a socket.
°ú¤­¿ô
.I sockfd
¤Ï¥Õ¥¡¥¤¥ë¤Ç¤¢¤ê¡¢¥½¥±¥Ã¥È¤Ç¤Ê¤¤¡£
.\"O .SH "CONFORMING TO"
.SH ½àµò
.\"O SVr4, 4.4BSD (these system calls first appeared in 4.2BSD),
.\"O POSIX.1-2001.
.\"O .\" SVr4 documents additional ENOMEM and ENOSR error codes, but does
.\"O .\" not document the
.\"O .\" .BR SO_SNDLOWAT ", " SO_RCVLOWAT ", " SO_SNDTIMEO ", " SO_RCVTIMEO
.\"O .\" options
SVr4, 4.4BSD (¤³¤ì¤é¤Î¥·¥¹¥Æ¥à¡¦¥³¡¼¥ë¤Ï 4.2BSD ¤ÇºÇ½é¤Ë¸½¤ì¤¿),
POSIX.1-2001.
.\" SVr4 ¤Ë¤Ï¾¤Ë ENOMEM ¤È ENOSR ¥¨¥é¡¼¡¦¥³¡¼¥É¤Ë¤Ä¤¤¤Æ¤âµ­½Ò¤µ¤ì¤Æ¤¤¤ë¡£
.\" ¤·¤«¤·¡¢
.\" .BR SO_SNDLOWAT ", " SO_RCVLOWAT ", " SO_SNDTIMEO ", " SO_RCVTIMEO
.\" ¥ª¥×¥·¥ç¥ó¤Ë´Ø¤¹¤ëµ­½Ò¤Ï¤Ê¤¤¡£
.\"O .SH NOTES
.SH Ãí°Õ
.\"O POSIX.1-2001 does not require the inclusion of
.\"O .IR <sys/types.h> ,
.\"O and this header file is not required on Linux.
.\"O However, some historical (BSD) implementations required this header
.\"O file, and portable applications are probably wise to include it.
POSIX.1-2001 ¤Ç¤Ï
.I <sys/types.h>
¤Î¥¤¥ó¥¯¥ë¡¼¥É¤Ïɬ¿Ü¤È¤µ¤ì¤Æ¤ª¤é¤º¡¢
Linux ¤Ç¤Ï¤³¤Î¥Ø¥Ã¥À¥Õ¥¡¥¤¥ë¤ÏɬÍפǤϤʤ¤¡£
¤·¤«¤·¡¢Îò»ËŪ¤Ë¤Ï¡¢¤¤¤¯¤Ä¤«¤Î¼ÂÁõ (BSD ·Ï) ¤Ç¤³¤Î¥Ø¥Ã¥À¥Õ¥¡¥¤¥ë¤¬
ɬÍפǤ¢¤ê¡¢°Ü¿¢À­¤¬É¬Íפʥ¢¥×¥ê¥±¡¼¥·¥ç¥ó¤Ç¤Ï¤³¤Î¥Õ¥¡¥¤¥ë¤ò
¥¤¥ó¥¯¥ë¡¼¥É¤¹¤ë¤Î¤¬¸­ÌÀ¤Ç¤¢¤í¤¦¡£

.\"O The
.\"O .I optlen
.\"O argument of
.\"O .BR getsockopt ()
.\"O and
.\"O .BR setsockopt ()
.\"O is in reality an
.\"O .I "int [*]"
.\"O (and this is what 4.x BSD and libc4 and libc5 have).
.BR getsockopt ()
¤È
.BR setsockopt ()
¤Î
.I optlen
°ú¤­¿ô¤Ï¼ÂºÝ¤Ï
.I int [*]
¤Ç¤¢¤ë (¤½¤·¤Æ 4.x BSD ¤È libc4 ¤È libc5 ¤Ï¤½¤¦¤Ê¤Ã¤Æ¤¤¤ë)¡£
.\"O Some POSIX confusion resulted in the present
.\"O .IR socklen_t ,
.\"O also used by glibc.
.\"O See also
POSIX ¤Ç¤Ïäþ;¶ÊÀÞ¤ò·Ð¤Æ¸½ºß¤Î
.I socklen_t
¤Ë¤Ê¤Ã¤Æ¤ª¤ê¡¢
glibc ¤Ç¤â
.I socklen_t
¤ò»È¤Ã¤Æ¤¤¤ë¡£
.BR accept (2)
¤â»²¾È¤Î¤³¤È¡£
.\"O .SH BUGS
.SH ¥Ð¥°
.\"O Several of the socket options should be handled at lower levels of the
.\"O system.
¥½¥±¥Ã¥È¤Î¥ª¥×¥·¥ç¥ó¤Î¤¤¤¯¤Ä¤«¤Ï¥·¥¹¥Æ¥à¤Î¤è¤êÄ㤤ÁؤÇ
½èÍý¤µ¤ì¤ë¤Ù¤­¤Ç¤¢¤ë¡£
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR ioctl (2),
.BR socket (2),
.BR getprotoent (3),
.BR protocols (5),
.BR socket (7),
.BR tcp (7),
.BR unix (7)