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)