draft/man2/socket.2

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