release/man2/getsockopt.2

   1 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     $Id: getsockopt.2,v 1.1 1999/05/24 14:57:04 freitag Exp $
  33 .\"
  34 .\" Modified Sat Jul 24 16:19:32 1993 by Rik Faith (faith@cs.unc.edu)
  35 .\" Modified Mon Apr 22 02:29:06 1996 by Martin Schulze (joey@infodrom.north.de)
  36 .\" Modified Tue Aug 27 10:52:51 1996 by Andries Brouwer (aeb@cwi.nl)
  37 .\" Modified Thu Jan 23 13:29:34 1997 by Andries Brouwer (aeb@cwi.nl)
  38 .\" Modified Sun Mar 28 21:26:46 1999 by Andries Brouwer (aeb@cwi.nl)
  39 .\" Modified 1999 by Andi Kleen <ak@muc.de>.
  40 .\"     Removed most stuff because it is in socket.7 now.
  41 .\"
  42 .\" Japanese Version Copyright (c) 1996 Akira Yoshiyama
  43 .\"         all rights reserved.
  44 .\" Translated Sat Jul  6 00:43:37 JST 1996
  45 .\"         by Akira Yoshiyama <yosshy@jedi.seg.kobe-u.ac.jp>
  46 .\" Modified Fri Nov  7 22:45:27 JST 1997
  47 .\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  48 .\" Updated Sun Oct 12 JST 2003 by Kentaro Shirakata <argrath@ub32.org>
  49 .\"
  50 .TH GETSOCKOPT 2 2008-12-03 "Linux" "Linux Programmer's Manual"
  51 .SH Ì¾Á°
  52 getsockopt, setsockopt \- ¥½¥±¥Ã¥È¤Î¥ª¥×¥·¥ç¥ó¤ÎÀßÄê¤È¼èÆÀ¤ò¹Ô¤Ê¤¦
  53 .SH ½ñ¼°
  54 .nf
  55 .BR "#include <sys/types.h>" "          /* ¡ÖÃí°Õ¡×»²¾È */"
  56 .br
  57 .B #include <sys/socket.h>
  58 .sp
  59 .BI "int getsockopt(int " sockfd ", int " level ", int " optname ,
  60 .BI "               void *" optval ", socklen_t *" optlen );
  61 .BI "int setsockopt(int " sockfd ", int " level ", int " optname ,
  62 .BI "               const void *" optval ", socklen_t " optlen );
  63 .fi
  64 .SH ÀâÌÀ
  65 .BR getsockopt ()
  66 ¤È
  67 .BR setsockopt ()
  68 ¤Ï¡¢¥Õ¥¡¥¤¥ë¥Ç¥£¥¹¥¯¥ê¥×¥¿
  69 .I socket
  70 ¤Ç»²¾È¤µ¤ì¤ë¥½¥±¥Ã¥È¤Ë´ØÏ¢¤¹¤ë¥ª¥×¥·¥ç¥ó¤ÎÁàºî¤ò¹Ô¤¦¡£
  71 ¥ª¥×¥·¥ç¥ó¤ÏÊ£¿ô¤Î¥×¥í¥È¥³¥ëÁØ(level)¤ËÂ¸ºß¤¹¤ë¤«¤â¤·¤ì¤Ê¤¤¤¬¡¢
  72 ¤³¤ì¤é¤Ï¾ï¤ËºÇ¾å°Ì¤Î¥½¥±¥Ã¥ÈÁØ¤Ø¤ÈÀßÄê¤µ¤ì¤ë¡£
  73
  74 ¥½¥±¥Ã¥È¡¦¥ª¥×¥·¥ç¥ó¤òÁàºî¤¹¤ëºÝ¤Ë¤Ï¡¢¥ª¥×¥·¥ç¥ó¤ÎÁØ (level) ¤È
  75 ¥ª¥×¥·¥ç¥ó¤ÎÌ¾Á°¤ò»ØÄê¤·¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
  76 ¥½¥±¥Ã¥È API ÁØ¤Ç¥ª¥×¥·¥ç¥ó¤òÁàºî¤¹¤ë°Ù¤Ë¤Ï¡¢
  77 .I level
  78 ¤ò
  79 .B SOL_SOCKET
  80 ¤Ë»ØÄê¤¹¤ë¡£
  81 Â¾¤ÎÁ´¤Æ¤ÎÁØ¤Ç¥ª¥×¥·¥ç¥ó¤òÁàºî¤¹¤ë°Ù¤Ë¤Ï¡¢Í¿¤¨¤é¤ì¤¿¥ª¥×¥·¥ç¥ó¤Î
  82 À©¸æ¼çÂÎ¤È¤Ê¤ë¥×¥í¥È¥³¥ë¤Î¥×¥í¥È¥³¥ëÈÖ¹æ¤ò»ØÄê¤¹¤ë¡£Îã¤¨¤Ð¡¢
  83 ¥ª¥×¥·¥ç¥ó¤¬
  84 .B TCP
  85 ¥×¥í¥È¥³¥ë¤Ç²ò¼á¤µ¤ì¤ë¤Ù¤¤³¤È¤ò»Ø¼¨¤¹¤ë¤Ë¤Ï¡¢
  86 .I level
  87 ¤Ë
  88 .B TCP
  89 ¤Î¥×¥í¥È¥³¥ëÈÖ¹æ¤ò»ØÄê¤·¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
  90 .BR getprotoent (3)
  91 ¤ò»²¾È¤¹¤ë¤³¤È¡£
  92
  93 .I optval
  94 ¤È
  95 .I optlen
  96 °ú¤¿ô¤Ï
  97 .BR setsockopt ()
  98 ¤Î¥ª¥×¥·¥ç¥ó¤ÎÃÍ¤Ë¥¢¥¯¥»¥¹¤¹¤ë¤¿¤á¤ËÍÑ¤¤¤é¤ì¤ë¡£
  99 .BR getsockopt ()
 100 ¤Ç¤ÏÍ×µá¤·¤¿¥ª¥×¥·¥ç¥ó¤ÎÃÍ¤òÊÖ¤¹¤¿¤á¤Î¥Ð¥Ã¥Õ¥¡¡¼¤ò»ØÄê¤¹¤ë¡£
 101 .BR getsockopt ()
 102 ¤Ç¤Ï
 103 .I optlen
 104 ¤ÏÃÍ¤È·ë²ÌÎ¾ÍÑ¤Î°ú¤¿ô¤Ç¡¢ºÇ½é¤Ë
 105 .I optval
 106 ¤Î»Ø¤·¤Æ¤¤¤ë¥Ð¥Ã¥Õ¥¡¡¼¤Î¥µ¥¤¥º¤òÍ¿¤¨¡¢¼ÂºÝ¤ËÊÖ¤µ¤ì¤ëÃÍ¤Î¥µ¥¤¥º¤Ë
 107 ½ñ¤´¹¤¨¤é¤ì¤ë¡£¤â¤·¥ª¥×¥·¥ç¥óÃÍ¤òÍ¿¤¨¤º¡¢ÊÖ¤µ¤ì¤â¤·¤Ê¤¤¾ì¹ç¤Ë¤Ï
 108 .I optval
 109 ¤Ï NULL ¤Ç¤âÎÉ¤¤¡£
 110
 111 .I optname
 112 ¤ª¤è¤Ó»ØÄê¤µ¤ì¤¿¥ª¥×¥·¥ç¥ó¤Ï²ò¼á¤µ¤ì¤º¤Ë¡¢Å¬ÀÚ¤Ê¥×¥í¥È¥³¥ë¡¦¥â¥¸¥å¡¼¥ë¤Ë
 113 ÅÏ¤µ¤ì¤Æ²ò¼á¤µ¤ì¤ë¡£¥¤¥ó¥¯¥ë¡¼¥É¡¦¥Õ¥¡¥¤¥ë
 114 .I <sys/socket.h>
 115 ¤Ë¤Ï¸å½Ò¤Î¥½¥±¥Ã¥ÈÁØ¤Î¥ª¥×¥·¥ç¥ó¤ÎÄêµÁ¤¬´Þ¤Þ¤ì¤Æ¤¤¤ë¡£
 116 Â¾¤Î¥×¥í¥È¥³¥ëÁØ¤Ç¤ÏÌ¾Á°¤ä·Á¼°¤Ï°Û¤Ê¤ë¡£
 117 ¥Þ¥Ë¥å¥¢¥ë¤Î¥»¥¯¥·¥ç¥ó 4 ¤ÎÅ¬ÀÚ¤Ê¥¨¥ó¥È¥ê¤ò»²¾È¤¹¤ë¤³¤È¡£
 118
 119 ¤Û¤È¤ó¤É¤Î¥½¥±¥Ã¥ÈÁØ¤Î¥ª¥×¥·¥ç¥ó¤Ï
 120 .I optval
 121 ¤Ë
 122 .I int
 123 °ú¤¿ô¤òÍøÍÑ¤¹¤ë¡£
 124 .BR setsockopt ()
 125 ¤Ç¡¢ÆóÃÍ(boolean)¥ª¥×¥·¥ç¥ó¤òÍ¸ú(enable)¤Ë¤¹¤ë¤Ë¤Ï¥¼¥í°Ê³°¤ò»ØÄê¤·¡¢
 126 Ìµ¸ú(disable)¤Ë¤¹¤ë¤Ë¤Ï¥¼¥í¤ò»ØÄê¤¹¤ë¡£
 127 .PP
 128 ÍøÍÑ²ÄÇ½¤Ê¥½¥±¥Ã¥È¥ª¥×¥·¥ç¥ó¤ÎÀâÌÀ¤Ë´Ø¤·¤Æ¤Ï¡¢
 129 .BR socket (7)
 130 ¤ÈÅ¬ÀÚ¤Ê¥×¥í¥È¥³¥ë¤Î man ¥Ú¡¼¥¸¤ò»²¾È¤Î¤³¤È¡£
 131 .SH ÊÖ¤êÃÍ
 132 À®¸ù¤·¤¿¾ì¹ç¤Ë¤Ï¥¼¥í¤òÊÖ¤¹¡£¥¨¥é¡¼»þ¤Ë¤Ï \-1 ¤¬ÊÖ¤µ¤ì¡¢
 133 .I errno
 134 ¤¬Å¬ÀÚ¤ËÀßÄê¤µ¤ì¤ë¡£
 135 .SH ¥¨¥é¡¼
 136 .TP 10
 137 .B EBADF
 138 °ú¤¿ô
 139 .I sockfd
 140 ¤¬Í¸ú¤Ê¥Ç¥£¥¹¥¯¥ê¥×¥¿¤Ç¤Ê¤¤¡£
 141 .TP
 142 .B EFAULT
 143 .I optval
 144 ¤Ç»ØÄê¤µ¤ì¤¿¥¢¥É¥ì¥¹¤¬¥×¥í¥»¥¹¤Î¥¢¥É¥ì¥¹¶õ´Ö¤ÎÍ¸ú¤ÊÉôÊ¬¤Ç¤Ï¤Ê¤¤¡£
 145 .BR getsockopt ()
 146 ¤Î¾ì¹ç¡¢
 147 .I optlen
 148 ¤¬¥×¥í¥»¥¹¤Î¥¢¥É¥ì¥¹¶õ´Ö¤ÎÍ¸ú¤ÊÉôÊ¬¤Ç¤Ê¤¤¾ì¹ç¤Ë¤â¤³¤Î¥¨¥é¡¼¤¬ÊÖ¤µ¤ì¤ë¡£
 149 .TP
 150 .B EINVAL
 151 .BR setsockopt ()
 152 ¤Ç
 153 .I option
 154 ¤¬ÉÔÀµ¤Ç¤¢¤ë¡£
 155 .I optval
 156 ¤ËÌµ¸ú¤ÊÃÍ¤¬»ØÄê¤µ¤ì¤¿¾ì¹ç¤Ë¤â¡¢¤³¤Î¥¨¥é¡¼¤¬È¯À¸¤¹¤ë²ÄÇ½À¤¬¤¢¤ë
 157 (Îã¤¨¤Ð¡¢
 158 .BR ip (7)
 159 ¤ËÀâÌÀ¤¬¤¢¤ë
 160 .B IP_ADD_MEMBERSHIP
 161 ¥ª¥×¥·¥ç¥ó¤Ê¤É)¡£
 162 .TP
 163 .B ENOPROTOOPT
 164 »ØÄê¤µ¤ì¤¿ÁØ(level)¤Ë¤Ï¤³¤Î¥ª¥×¥·¥ç¥ó¤ÏÂ¸ºß¤·¤Ê¤¤¡£
 165 .TP
 166 .B ENOTSOCK
 167 °ú¤¿ô
 168 .I sockfd
 169 ¤Ï¥Õ¥¡¥¤¥ë¤Ç¤¢¤ê¡¢¥½¥±¥Ã¥È¤Ç¤Ê¤¤¡£
 170 .SH ½àµò
 171 SVr4, 4.4BSD (¤³¤ì¤é¤Î¥·¥¹¥Æ¥à¡¦¥³¡¼¥ë¤Ï 4.2BSD ¤ÇºÇ½é¤Ë¸½¤ì¤¿),
 172 POSIX.1-2001.
 173 .\" SVr4 ¤Ë¤ÏÂ¾¤Ë ENOMEM ¤È ENOSR ¥¨¥é¡¼¡¦¥³¡¼¥É¤Ë¤Ä¤¤¤Æ¤âµ½Ò¤µ¤ì¤Æ¤¤¤ë¡£
 174 .\" ¤·¤«¤·¡¢
 175 .\" .BR SO_SNDLOWAT ", " SO_RCVLOWAT ", " SO_SNDTIMEO ", " SO_RCVTIMEO
 176 .\" ¥ª¥×¥·¥ç¥ó¤Ë´Ø¤¹¤ëµ½Ò¤Ï¤Ê¤¤¡£
 177 .SH Ãí°Õ
 178 POSIX.1-2001 ¤Ç¤Ï
 179 .I <sys/types.h>
 180 ¤Î¥¤¥ó¥¯¥ë¡¼¥É¤ÏÉ¬¿Ü¤È¤µ¤ì¤Æ¤ª¤é¤º¡¢
 181 Linux ¤Ç¤Ï¤³¤Î¥Ø¥Ã¥À¥Õ¥¡¥¤¥ë¤ÏÉ¬Í×¤Ç¤Ï¤Ê¤¤¡£
 182 ¤·¤«¤·¡¢Îò»ËÅª¤Ë¤Ï¡¢¤¤¤¯¤Ä¤«¤Î¼ÂÁõ (BSD ·Ï) ¤Ç¤³¤Î¥Ø¥Ã¥À¥Õ¥¡¥¤¥ë¤¬
 183 É¬Í×¤Ç¤¢¤ê¡¢°Ü¿¢À¤¬É¬Í×¤Ê¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤Ç¤Ï¤³¤Î¥Õ¥¡¥¤¥ë¤ò
 184 ¥¤¥ó¥¯¥ë¡¼¥É¤¹¤ë¤Î¤¬¸ÌÀ¤Ç¤¢¤í¤¦¡£
 185
 186 .BR getsockopt ()
 187 ¤È
 188 .BR setsockopt ()
 189 ¤Î
 190 .I optlen
 191 °ú¤¿ô¤Ï¼ÂºÝ¤Ï
 192 .I int [*]
 193 ¤Ç¤¢¤ë (¤½¤·¤Æ 4.x BSD ¤È libc4 ¤È libc5 ¤Ï¤½¤¦¤Ê¤Ã¤Æ¤¤¤ë)¡£
 194 POSIX ¤Ç¤ÏäþÍ¾¶ÊÀÞ¤ò·Ð¤Æ¸½ºß¤Î
 195 .I socklen_t
 196 ¤Ë¤Ê¤Ã¤Æ¤ª¤ê¡¢
 197 glibc ¤Ç¤â
 198 .I socklen_t
 199 ¤ò»È¤Ã¤Æ¤¤¤ë¡£
 200 .BR accept (2)
 201 ¤â»²¾È¤Î¤³¤È¡£
 202 .SH ¥Ð¥°
 203 ¥½¥±¥Ã¥È¤Î¥ª¥×¥·¥ç¥ó¤Î¤¤¤¯¤Ä¤«¤Ï¥·¥¹¥Æ¥à¤Î¤è¤êÄã¤¤ÁØ¤Ç
 204 ½èÍý¤µ¤ì¤ë¤Ù¤¤Ç¤¢¤ë¡£
 205 .SH ´ØÏ¢¹àÌÜ
 206 .BR ioctl (2),
 207 .BR socket (2),
 208 .BR getprotoent (3),
 209 .BR protocols (5),
 210 .BR socket (7),
 211 .BR tcp (7),
 212 .BR unix (7)