1 .\" Copyright (c) 1983, 1990, 1991 The Regents of the University of California.
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
33 .\" Modified 1996-10-21 by Eric S. Raymond <esr@thyrsus.com>
34 .\" Modified 1998-2000 by Andi Kleen to match Linux 2.2 reality
35 .\" Modified 2002-04-23 by Roger Luethi <rl@hellgate.ch>
36 .\" Modified 2004-06-17 by Michael Kerrisk <mtk.manpages@gmail.com>
37 .\" 2008-12-04, mtk, Add documentation of accept4()
39 .\"*******************************************************************
41 .\" This file was generated with po4a. Translate the source file.
43 .\"*******************************************************************
44 .TH ACCEPT 2 2010\-09\-10 Linux "Linux Programmer's Manual"
46 accept \- ソケットへの接続を受ける
49 \fB#include <sys/types.h>\fP /* 「注意」参照 */
50 \fB#include <sys/socket.h>\fP
52 \fBint accept(int \fP\fIsockfd\fP\fB, struct sockaddr *\fP\fIaddr\fP\fB, socklen_t *\fP\fIaddrlen\fP\fB);\fP
54 \fB#define _GNU_SOURCE\fP /* feature_test_macros(7) 参照 */
55 \fB#include <sys/socket.h>\fP
57 \fBint accept4(int \fP\fIsockfd\fP\fB, struct sockaddr *\fP\fIaddr\fP\fB,\fP
58 \fB socklen_t *\fP\fIaddrlen\fP\fB, int \fP\fIflags\fP\fB);\fP
61 \fBaccept\fP() システムコールは、接続指向のソケット型 (\fBSOCK_STREAM\fP, \fBSOCK_SEQPACKET\fP)
62 で用いられる。 この関数は、接続待ちソケット \fIsocket\fP 宛ての保留状態の接続要求が入っているキューから
63 先頭の接続要求を取り出し、接続済みソケットを新規に生成し、 そのソケットを参照する新しいファイル・ディスクリプタを返す。
64 新規に生成されたソケットは、接続待ち (listen) 状態ではない。 もともとのソケット \fIsockfd\fP はこの呼び出しによって影響を受けない。
66 引き数 \fIsockfd\fP は、 \fBsocket\fP(2) によって生成され、 \fBbind\fP(2) によってローカルアドレスにバインドされ、
67 \fBlisten\fP(2) を経て接続を待っているソケットである。
69 \fIaddr\fP 引き数は \fIsockaddr\fP 構造体へのポインタである。 この構造体には接続相手のソケットのアドレスが入っている。 \fIaddr\fP
70 引き数で返されるアドレスの正確なフォーマットは、 ソケットのアドレス種別によって変わる (\fBsocket\fP(2) およびそれぞれのプロトコルの
71 man ページを参照)。 \fIaddr\fP が NULL の場合、 \fIaddr\fP には何も入らない。この場合、 \fIaddrlen\fP
72 は使用されず、この引き数は NULL にしておくべきである。
74 \fIaddrlen\fP 引き数は入出力両用の引き数である。呼び出し時には、呼び出し元が \fIaddr\fP が指す構造体のサイズ (バイト単位)
75 で初期化しておかなければならない。 返ってくる時には、接続相手のアドレスの実際の大きさが格納される。
77 渡されたバッファが小さ過ぎた場合は、返されるアドレスの末尾が切り詰められる。
78 この場合には、 \fIaddrlen\fP には、呼び出し時に指定された値よりも大きな値が格納される。
80 キューに保留となっている接続要求がなく、 かつソケットが非停止になっていないときは、 \fBaccept\fP() は接続が発生するまで呼び出し元を停止
81 (block) する。 ソケットが非停止になっていて、 待ち状態の接続要求がキューに無いときは、 \fBaccept\fP() はエラー \fBEAGAIN\fP
82 か \fBEWOULDBLOCK\fP で失敗する。
84 ソケットへの接続到着を知るには、 \fBselect\fP(2) または \fBpoll\fP(2) を用いればよい。
85 新しい接続要求が来るとソケットは読み込み可能になるので、 そうしたら \fBaccept\fP() を呼んでその接続に対するソケットを取得すればよい。
86 あるいはソケットに設定を行い、何らかのアクションがあったときに \fBSIGIO\fP を配送 (deliver) させるようにすることもできる。詳細は
87 \fBsocket\fP(7) を参照のこと。
89 明示的な接続確認 (confirmation) を必要とするようなプロトコル (DECNet など) では、 \fBaccept\fP()
90 は単に次の接続要求をキューから取り出すだけであり、 接続確認は行わないことに注意せよ。接続確認は、 新しいファイル・ディスクリプタに対する
91 通常の読み取り/書き込みによってなされ、接続拒否 (rejection) は新しいソケットをクローズすることによってなされる。 現在のところ、
92 Linux 上でこれらのセマンティクスを持つのは DECNet だけである。
94 \fIflags\fP が 0 の場合、 \fBaccept4\fP() は \fBaccept\fP() と同じである。 \fIflags\fP
95 に以下の値をビット毎の論理和 (OR) で指定することで、 異なる動作をさせることができる。
98 新しく生成されるオープンファイル記述 (open file description) の \fBO_NONBLOCK\fP
99 ファイルステータスフラグをセットする。 このフラグを使うことで、 \fBO_NONBLOCK\fP をセットするために \fBfcntl\fP(2)
103 新しいファイルディスクリプタに対して close\-on\-exec (\fBFD_CLOEXEC\fP) フラグをセットする。
104 このフラグが役に立つ理由については、 \fBopen\fP(2) の \fBO_CLOEXEC\fP フラグの説明を参照のこと。
106 成功した場合、これらのシステムコールは 受け付けたソケットのディスクリプタである非負の整数値を返す。 エラーが発生した場合は \-1 を返し、
107 \fIerrno\fP を適切に設定する。
109 Linux の \fBaccept\fP() (と \fBaccept4\fP()) は、新しいソケットにおける、発生済みのネットワークエラーを
110 \fBaccept\fP() からのエラーコードとして渡す。 この振舞いは BSD ソケットの実装とは異なる。 信頼性の高い動作を行うためには、
111 アプリケーションはプロトコルで定義されているネットワークエラーの検知を \fBaccept\fP() のあとに行い、それらのエラーを \fBEAGAIN\fP
112 と同じように扱い、再試行 (retry) を行うべきである。 TCP/IP では、以下のエラーが該当する: \fBENETDOWN\fP,
113 \fBEPROTO\fP, \fBENOPROTOOPT\fP, \fBEHOSTDOWN\fP, \fBENONET\fP, \fBEHOSTUNREACH\fP,
114 \fBEOPNOTSUPP\fP, \fBENETUNREACH\fP
117 \fBEAGAIN\fP または \fBEWOULDBLOCK\fP
118 .\" Actually EAGAIN on Linux
119 ソケットが非停止になっていて、 かつ受付け対象の接続が存在しない。 POSIX.1\-2001 は、この場合にどちらのエラーを返すことも認めており、
120 これら 2 つの定数が同じ値を持つことも求めていない。 したがって、移植性が必要なアプリケーションでは、両方の可能性を 確認すべきである。
129 \fIaddr\fP 引き数がユーザアドレス空間の書き込み可能領域にない。
132 有効な接続が到着する前に捕捉されたシグナルによって システムコールが中断された。 \fBsignal\fP(7) 参照。
135 ソケットが接続待ち状態ではない。もしくは、 \fIaddrlen\fP が不正である (例えば、負の場合など)。
138 (\fBaccept4\fP()) \fIflags\fP に不正な値が指定されている。
141 1プロセスがオープンできるファイル・ディスクリプタ数の上限に達した。
144 オープンされたファイルの総数がシステム全体の上限に達していた。
146 \fBENOBUFS\fP, \fBENOMEM\fP
147 メモリが足りない。 多くの場合は、システムメモリが足りないわけではなく、 ソケットバッファの大きさによるメモリ割り当ての制限である。
150 ディスクリプタはソケットではなくファイルを参照している。
153 参照しているソケットの型が \fBSOCK_STREAM\fP でない。
158 上記に加えて、Linux の \fBaccept\fP() は以下のエラーで失敗する:
161 ファイアウォールのルールにより接続が禁止された。
163 この他に、新しいソケットに対するネットワークエラーが返されることもある。 これらはそれぞれのプロトコルで定義されている。 いろいろな Linux
164 カーネルでは、 以下に示すようなエラーを返すこともある。 \fBENOSR\fP, \fBESOCKTNOSUPPORT\fP,
165 \fBEPROTONOSUPPORT\fP, \fBETIMEDOUT\fP. \fBERESTARTSYS\fP がトレースの最中に現れることもある。
167 \fBaccept4\fP() システムコールは Linux 2.6.28 以降で利用可能である。 glibc でのサポートはバージョン 2.10
170 .\" The BSD man page documents five possible error returns
171 .\" (EBADF, ENOTSOCK, EOPNOTSUPP, EWOULDBLOCK, EFAULT).
172 .\" POSIX.1-2001 documents errors
173 .\" EAGAIN, EBADF, ECONNABORTED, EINTR, EINVAL, EMFILE,
174 .\" ENFILE, ENOBUFS, ENOMEM, ENOTSOCK, EOPNOTSUPP, EPROTO, EWOULDBLOCK.
175 .\" In addition, SUSv2 documents EFAULT and ENOSR.
176 \fBaccept\fP(): POSIX.1\-2001, SVr4, 4.4BSD, (\fBaccept\fP() は 4.2BSD で初めて実装された).
178 \fBaccept4\fP() は非標準の Linux による拡張である。
180 .\" Some testing seems to show that Tru64 5.1 and HP-UX 11 also
181 .\" do not inherit file status flags -- MTK Jun 05
182 Linux では、 \fBaccept\fP() が返す新しいソケットは listen を行っているソケットの ファイル状態フラグ
183 (\fBO_NONBLOCK\fP や \fBO_ASYNC\fP など) を継承「しない」。 この動作は標準的な BSD ソケットの実装とは異なっている。
184 移植性を考慮したプログラムではファイル状態フラグが継承されるかどうかは 前提にせず、常に \fBaccept\fP()
185 が返したソケットに対して全ての必要なフラグを明示的に設定するように すべきである。
187 POSIX.1\-2001 では \fI<sys/types.h>\fP のインクルードは必須とされておらず、 Linux
188 ではこのヘッダファイルは必要ではない。 しかし、歴史的には、いくつかの実装 (BSD 系) でこのヘッダファイルが
189 必要であり、移植性が必要なアプリケーションではこのファイルを インクルードするのが賢明であろう。
191 \fBSIGIO\fP が届けられた後や、 \fBselect\fP(2) または \fBpoll\fP(2) が読み込み可能イベントを返した後に、
192 必ずしも待機中の接続があるとは限らない。 なぜならその接続は、 \fBaccept\fP() が呼ばれる前に、非同期的なネットワークエラーや
193 他のスレッドから呼ばれた (別の) accept によって 削除されているかもしれないからである。 この場合、その \fBaccept\fP()
194 呼び出しは停止 (block) し、次の接続の到着を待ちつづける。 \fBaccept\fP() に停止を行わせないようにするには、引き数に渡すソケット
195 \fIsockfd\fP に \fBO_NONBLOCK\fP フラグをセットしておく必要がある (\fBsocket\fP(7) を見よ)。
197 \fBaccept\fP() の第 3 引き数は、もともと \fIint *\fP と宣言されていた (libc4 や libc5, 4.x BSD, SunOS
198 4, SGI など多くのシステムではそうなっている)。 POSIX.1g draft 標準は、 これを \fIsize_t *\fP
199 に変更しようとし、SunOS 5 ではそう宣言されている。 後に POSIX drafts には \fIsocklen_t *\fP が含まれるようになり、
200 Single UNIX Specification や glibc2 ではこのように宣言されるようになった。 Linus Torvald
203 .\" .I fails: only italicizes a single line
204 「まともなライブラリを作りたければ、 "socklen_t" のサイズは int と同じにしなきゃならない。 さもないと BSD
205 ソケット層を破壊することになっちゃう。 POSIX は最初こいつを size_t にしたんで、 ぼくは彼らに文句をがなりたてた
206 (多分そういう人は他にもいたと思う。多くはなかったようだけど)。 こいつを size_t にするのは完全にいかれてる。 例えば 64
207 ビットアーキテクチャでは、 size_t が "int" と同じサイズだなんてことはほとんどないからね。 このサイズは "int" と
208 同じでなきゃ『ダメ』なんだ。 BSD ソケットインターフェースっていうのはそういうものなんだから。 まあともかく POSIX の人たちも、
209 "socklen_t" を作るという解決策をなんとかひねり出した。 そもそも最初から放っておけば良かったんだが、 いじっちゃった以上、
210 名前付きの型を持たせなきゃならない、と思ったみたいだね。 なんでかはわかんないけど (きっと最初にやっちまった馬鹿な間違いで顔をつぶしたくなかったから、
211 こっそり名前を付け替えて自分たちの大失敗をごまかそうとしたんだろう)。」
215 \fBbind\fP(2), \fBconnect\fP(2), \fBlisten\fP(2), \fBselect\fP(2), \fBsocket\fP(2),