draft/man2/socket.2

   1 .\" t
   2 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .\"     $Id: socket.2,v 1.4 1999/05/13 11:33:42 freitag Exp $
  34 .\"
  35 .\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
  36 .\" Modified 1996-10-22 by Eric S. Raymond <esr@thyrsus.com>
  37 .\" Modified 1998, 1999 by Andi Kleen <ak@muc.de>
  38 .\" Modified 2002-07-17 by Michael Kerrisk <mtk.manpages@gmail.com>
  39 .\" Modified 2004-06-17 by Michael Kerrisk <mtk.manpages@gmail.com>
  40 .\"
  41 .\"*******************************************************************
  42 .\"
  43 .\" This file was generated with po4a. Translate the source file.
  44 .\"
  45 .\"*******************************************************************
  46 .TH SOCKET 2 2009\-01\-19 Linux "Linux Programmer's Manual"
  47 .SH 名前
  48 socket \- 通信のための端点(endpoint)を作成する
  49 .SH 書式
  50 \fB#include <sys/types.h>\fP /* 「注意」参照 */
  51 .br
  52 \fB#include <sys/socket.h>\fP
  53 .sp
  54 \fBint socket(int \fP\fIdomain\fP\fB, int \fP\fItype\fP\fB, int \fP\fIprotocol\fP\fB);\fP
  55 .SH 説明
  56 \fBsocket\fP()  は通信のための端点(endpoint)を作成し、ディスクリプター(descriptor)を返す。
  57 .PP
  58 \fIdomain\fP 引数は通信を行なうドメインを指定する; これはどの プロトコル・ファミリ(protocol
  59 family)を通信に使用するかを指定する。 これらのファミリは \fI<sys/socket.h>\fP に定義されている。
  60 現在、理解できるフォーマットは以下の通り。
  61 .TS
  62 tab(:);
  63 l l l.
  64 名前:目的:マニュアル
  65 T{
  66 \fBAF_UNIX\fP, \fBAF_LOCAL\fP
  67 T}:T{
  68 ローカル通信
  69 T}:T{
  70 \fBunix\fP(7)
  71 T}
  72 T{
  73 \fBAF_INET\fP
  74 T}:IPv4 インターネット・プロトコル:T{
  75 \fBip\fP(7)
  76 T}
  77 T{
  78 \fBAF_INET6\fP
  79 T}:IPv6 インターネット・プロトコル:T{
  80 \fBipv6\fP(7)
  81 T}
  82 T{
  83 \fBAF_IPX\fP
  84 T}:IPX \- Novell プロトコル:
  85 T{
  86 \fBAF_NETLINK\fP
  87 T}:T{
  88 カーネル・ユーザ・デバイス
  89 T}:T{
  90 \fBnetlink\fP(7)
  91 T}
  92 T{
  93 \fBAF_X25\fP
  94 T}:ITU\-T X.25 / ISO\-8208 プロトコル:T{
  95 \fBx25\fP(7)
  96 T}
  97 T{
  98 \fBAF_AX25\fP
  99 T}:T{
 100 アマチュア無線 AX.25 プロトコル
 101 T}:
 102 T{
 103 \fBAF_ATMPVC\fP
 104 T}:生の ATM PVC にアクセスする:
 105 T{
 106 \fBAF_APPLETALK\fP
 107 T}:アップルトーク:T{
 108 \fBddp\fP(7)
 109 T}
 110 T{
 111 \fBAF_PACKET\fP
 112 T}:T{
 113 低レベルのパケットインターフェース
 114 T}:T{
 115 \fBpacket\fP(7)
 116 T}
 117 .TE
 118 .PP
 119 ソケットは \fItype\fP で指定される型を持ち、それは通信方式(semantics)を指定する。 定義されている型は現在以下の通り。
 120 .TP  16
 121 \fBSOCK_STREAM\fP
 122 順序性と信頼性があり、双方向の、接続された バイト・ストリーム(byte stream)を提供する。
 123 帯域外(out\-of\-band)データ転送メカニズムもサポートされる。
 124 .TP
 125 \fBSOCK_DGRAM\fP
 126 データグラム(接続、信頼性無し、固定最大長メッセージ)  をサポートする。
 127 .TP
 128 \fBSOCK_SEQPACKET\fP
 129 固定最大長のデータグラム転送パスに基づいた順序性、信頼性のある 双方向の接続に基づいた通信を提供する。受け取り側ではそれぞれの入力
 130 システム・コールでパケット全体を読み取ることが要求される。
 131 .TP
 132 \fBSOCK_RAW\fP
 133 生のネットワーク・プロトコルへのアクセスを提供する。
 134 .TP
 135 \fBSOCK_RDM\fP
 136 信頼性はあるが、順序は保証しないデータグラム層を提供する。
 137 .TP
 138 \fBSOCK_PACKET\fP
 139 廃止されており新しいプログラムで使用してはいけない。 \fBpacket\fP(7)  を参照すること
 140 .PP
 141 ある種のソケット型が全てのプロトコル・ファミリで実装されているわけではない。 例えば \fBSOCK_SEQPACKET\fP は \fBAF_INET\fP
 142 には実装されていない。
 143 .PP
 144 Linux 2.6.27 以降では、 \fItype\fP 引数は二つ目の目的にも使用される。 ソケットの型を指定するのに加えて、
 145 以下の値のいくつかをビット単位の論理和 (OR) で指定することで、 \fBsocket\fP()  の振舞いを変更することができる。
 146 .TP  16
 147 \fBSOCK_NONBLOCK\fP
 148 新しく生成されるオープンファイル記述 (open file description) の \fBO_NONBLOCK\fP
 149 ファイルステータスフラグをセットする。 このフラグを使うことで、 \fBO_NONBLOCK\fP をセットするために \fBfcntl\fP(2)
 150 を追加で呼び出す必要がなくなる。
 151 .TP
 152 \fBSOCK_CLOEXEC\fP
 153 新しいファイルディスクリプタに対して close\-on\-exec (\fBFD_CLOEXEC\fP)  フラグをセットする。
 154 このフラグが役に立つ理由については、 \fBopen\fP(2)  の \fBO_CLOEXEC\fP フラグの説明を参照のこと。
 155 .PP
 156 \fIprotocol\fP はソケットによって使用される固有のプロトコルを指定する。通常それぞれの
 157 ソケットは、与えられたプロトコル・ファミリの種類ごとに一つのプロトコルのみを サポートする。 その場合は \fIprotocol\fP に 0 を指定できる。
 158 しかし、多くのプロトコルが存在してもかまわない。 この場合にはこの方法により固有のプロトコルを指定する必要がある。
 159 使用されるプロトコル番号は通信の行なわれる\*(lq通信ドメイン\*(rqに 固有である; \fBprotocols\fP(5)  を参照すること。
 160 プロトコル名をどうやってプロトコル番号に対応させるかについては \fBgetprotoent\fP(3)  を参照すること。
 161 .PP
 162 \fBSOCK_STREAM\fP 型のソケットはパイプのような全二重バイト・ストリームである。 これらはレコード境界を保存しない。
 163 ストリームは、ソケットがデータを送ったり受けたりする前に \fI接続された\fP 状態になってなければならない。他のソケットへの接続は
 164 \fBconnect\fP(2)  コールによって行なわれる。一度接続したらデータは \fBread\fP(2)  と \fBwrite\fP(2)  コールや
 165 \fBsend\fP(2)  と \fBrecv\fP(2)  コールの変種を使用して転送できる。 セッションが完了したら \fBclose\fP(2)
 166 が行なわれる。帯域外データの転送も \fBsend\fP(2)  に記述されており、 受信も \fBrecv\fP(2)  に記述されている。
 167 .PP
 168 \fBSOCK_STREAM\fP を実装した通信プロトコルはデータに損失や重複がないことを保証する。 もし相手のプロトコルがバッファー空間を持つ
 169 データの断片を適当な時間のうちに転送できなければ、 接続は断たれたとみなす。そのソケット \fBSO_KEEPALIVE\fP
 170 が有効になっている場合、プロトコル独自の方法で接続の相手側がまだ 有効であるかをチェックする。
 171 もしプロセスが、壊れたストリームでデータを送受信しようとした場合には \fBSIGPIPE\fP シグナルが送られる;
 172 これは通常のそのシグナルを扱っていないプロセスを 終了させる。 \fBSOCK_SEQPACKET\fP ソケットは \fBSOCK_STREAM\fP
 173 ソケットと同じシステム・コールを使用する。 唯一の違いは \fBread\fP(2)  コールが要求された量のデータのみを返し、到着したパケットの残りの部分を
 174 捨ててしまうことである。同様に入ってくるデータグラムの全てのメッセージ境界は 保存される。
 175 .PP
 176 \fBSOCK_DGRAM\fP と \fBSOCK_RAW\fP ソケットは \fBsendto\fP(2)
 177 コールで指定された相手へデータグラムを送ることが許されている。 データグラムは一般に \fBrecvfrom\fP(2)  で受けとり、
 178 このコールは次のデータグラムを送信者のアドレスと一緒に返す。
 179 .PP
 180 \fBSOCK_PACKET\fP は古いソケット型で、生(raw)のパケットをデバイスドライバから 直接受信するためのものである。 今は代わりに
 181 \fBpacket\fP(7)  を用いること。
 182 .PP
 183 \fBfcntl\fP(2)  の \fBF_SETOWN\fP 操作を使って、シグナル \fBSIGURG\fP や \fBSIGPIPE\fP
 184 を受けとるプロセス・グループを指定できる。 \fBSIGURG\fP シグナルは帯域外データが到着した時に、 \fBSIGPIPE\fP シグナルは
 185 \fBSOCK_STREAM\fP 接続が予期せず切断された時に送られる。 また、 \fBF_SETOWN\fP 操作は、I/O や I/O イベントの非同期
 186 (asynchronous) 通知を \fBSIGIO\fP を経由で受け取るプロセスやプロセス・グループを設定するのにも使用できる。 \fBF_SETOWN\fP
 187 を使用することは \fBFIOSETOWN\fP または \fBSIOCSPGRP\fP の引数で \fBioctl\fP(2)  を使用することと等価である。
 188 .PP
 189 ネットワークがプロトコル・モジュールにエラー状態を伝えた場合 (例えば、IP の ICMP メッセージを使用して)には、ソケットの
 190 ペンディング・エラー・フラグが設定される。次にこのソケットを操作した 時にペンディングされていたエラー・コードが返される。プロトコルによっては
 191 エラーについてのより詳しい情報を受け取るためにソケットごとのエラー・キューを 受け取ることが可能である。 \fBip\fP(7)  の
 192 \fBIP_RECVERR\fP を参照すること。
 193 .PP
 194 ソケットの操作はソケット・レベル \fIoptions\fP によって制御される。 これらのオプションは \fI<sys/socket.h>\fP
 195 に定義されている。 \fBsetsockopt\fP(2)  と \fBgetsockopt\fP(2)  関数はそれぞれオプションの設定と取得を行なう。
 196 .SH 返り値
 197 成功した場合、新しいソケットのファイル・ディスクリプターを返す。 エラーが発生した場合は \-1 を返し、 \fIerrno\fP を適切に設定する。
 198 .SH エラー
 199 .TP
 200 \fBEACCES\fP
 201 指定されたタイプまたはプロトコルのソケットを作成する許可が与えられていない。
 202 .TP
 203 \fBEAFNOSUPPORT\fP
 204 指定されたアドレスファミリーがサポートされていない。
 205 .TP
 206 \fBEINVAL\fP
 207 知らないプロトコル、または利用できないプロトコル・ファミリである。
 208 .TP
 209 \fBEINVAL\fP
 210 .\" Since Linux 2.6.27
 211 \fItype\fP に無効なフラグが指定されている。
 212 .TP
 213 \fBEMFILE\fP
 214 プロセスのファイルテーブルが溢れている。
 215 .TP
 216 \fBENFILE\fP
 217 オープンされたファイルの総数がシステム全体の上限に達していた。
 218 .TP
 219 \fBENOBUFS\fP または \fBENOMEM\fP
 220 十分なメモリがない。十分な資源が解放されるまではソケットを 作成することはできない。
 221 .TP
 222 \fBEPROTONOSUPPORT\fP
 223 このドメインでは指定されたプロトコルまたはプロトコル・タイプが サポートされていない。
 224 .PP
 225 下位のプロトコル・モジュールから他のエラーが生成されるかもしれない。
 226 .SH 準拠
 227 4.4BSD, POSIX.1\-2001.
 228
 229 フラグ \fBSOCK_NONBLOCK\fP, \fBSOCK_CLOEXEC\fP は Linux 固有である。
 230
 231 \fBsocket\fP()  は 4.2BSD で登場した。一般に、(System V の変種を含めて)  BSD のソケット層の互換性をサポートしている
 232 BSD 以外のシステムへの、 または、BSD 以外のシステムからの移植ができる。
 233 .SH 注意
 234 POSIX.1\-2001 では \fI<sys/types.h>\fP のインクルードは必須とされておらず、 Linux
 235 ではこのヘッダファイルは必要ではない。 しかし、歴史的には、いくつかの実装 (BSD 系) でこのヘッダファイルが
 236 必要であり、移植性が必要なアプリケーションではこのファイルを インクルードするのが賢明であろう。
 237
 238 4.x BSD において定数を使用する場合、プロトコル・ファミリーには
 239 \fBPF_UNIX\fP, \fBPF_INET\fP 等を使用している。一方でアドレス・ファミリーには
 240 \fBAF_UNIX\fP, \fBAF_INET\fP 等が使用されている。
 241 しかしながら BSD のマニュアルでは 「一般にプロトコル・ファミリーは
 242 アドレス・ファミリーと同じものである。」 と保証している。
 243 それ以外の規格では全ての場所で AF_* が使用されている。
 244 .SH 例
 245 \fBsocket\fP()  の利用例が \fBgetaddrinfo\fP(3)  に記載されている。
 246 .SH 関連項目
 247 \fBaccept\fP(2), \fBbind\fP(2), \fBconnect\fP(2), \fBfcntl\fP(2), \fBgetpeername\fP(2),
 248 \fBgetsockname\fP(2), \fBgetsockopt\fP(2), \fBioctl\fP(2), \fBlisten\fP(2), \fBread\fP(2),
 249 \fBrecv\fP(2), \fBselect\fP(2), \fBsend\fP(2), \fBshutdown\fP(2), \fBsocketpair\fP(2),
 250 \fBwrite\fP(2), \fBgetprotoent\fP(3), \fBip\fP(7), \fBsocket\fP(7), \fBtcp\fP(7),
 251 \fBudp\fP(7), \fBunix\fP(7)
 252 .PP
 253 \(lqAn Introductory 4.3BSD Interprocess Communication Tutorial\(rq は \fIUNIX
 254 Programmer's Supplementary Documents Volume 1\fP として再版された。
 255 .PP
 256 \(lqBSD Interprocess Communication Tutorial\(rq は \fIUNIX Programmer's
 257 Supplementary Documents Volume 1\fP として再版された。
 258 .SH この文書について
 259 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.41 の一部
 260 である。プロジェクトの説明とバグ報告に関する情報は
 261 http://www.kernel.org/doc/man\-pages/ に書かれている。