Provided by: manpages-ja-dev_0.5.0.0.20161015+dfsg-1_all
名前
accept, accept4 - ソケットへの接続を受ける
書式
#include <sys/types.h> /* 「注意」参照 */ #include <sys/socket.h> int accept(int sockfd, struct sockaddr *addr, socklen_t *addrlen); #define _GNU_SOURCE /* feature_test_macros(7) 参照 */ #include <sys/socket.h> int accept4(int sockfd, struct sockaddr *addr, socklen_t *addrlen, int flags);
説明
accept() システムコールは、接続指向のソケット型 (SOCK_STREAM, SOCK_SEQPACKET) で用いられ る。 この関数は、接続待ちソケット socket 宛ての保留状態の接続要求が入っているキューから 先 頭の接続要求を取り出し、接続済みソケットを新規に生成し、 そのソケットを参照する新しいファ イルディスクリプターを返す。 新規に生成されたソケットは、接続待ち (listen) 状態ではない。 もともとのソケット sockfd はこの呼び出しによって影響を受けない。 引き数 sockfd は、 socket(2) によって生成され、 bind(2) によってローカルアドレスにバイン ドされ、 listen(2) を経て接続を待っているソケットである。 addr 引き数は sockaddr 構造体へのポインターである。 この構造体には接続相手のソケットのアド レスが入っている。 addr 引き数で返されるアドレスの正確なフォーマットは、 ソケットのアドレ ス種別によって変わる (socket(2) およびそれぞれのプロトコルの man ページを参照)。 addr が NULL の場合、 addr には何も入らない。この場合、 addrlen は使用されず、この引き数は NULL に しておくべきである。 addrlen 引き数は入出力両用の引き数である。呼び出し時には、呼び出し元が addr が指す構造体の サイズ (バイト単位) で初期化しておかなければならない。 返ってくる時には、接続相手のアドレ スの実際の大きさが格納される。 渡されたバッファーが小さ過ぎた場合は、返されるアドレスの末尾が切り詰められる。 この場合に は、 addrlen には、呼び出し時に指定された値よりも大きな値が格納される。 キューに保留となっている接続要求がなく、 かつソケットが非停止になっていないときは、 accept() は接続が発生するまで呼び出し元を停止 (block) する。 ソケットが非停止になってい て、 待ち状態の接続要求がキューに無いときは、 accept() はエラー EAGAIN か EWOULDBLOCK で 失敗する。 ソケットへの接続到着を知るには、 select(2) または poll(2) を用いればよい。 新しい接続要 求が来るとソケットは読み込み可能になるので、 そうしたら accept() を呼んでその接続に対する ソケットを取得すればよい。 あるいはソケットに設定を行い、何らかのアクションがあったときに SIGIO を配送 (deliver) させるようにすることもできる。詳細は socket(7) を参照のこと。 明示的な接続確認 (confirmation) を必要とするようなプロトコル (DECNet など) では、 accept() は単に次の接続要求をキューから取り出すだけであり、 接続確認は行わないことに注意せよ。接続 確認は、 新しいファイルディスクリプターに対する 通常の読み取り/書き込みによってなされ、接 続拒否 (rejection) は新しいソケットをクローズすることによってなされる。 現在のところ、 Linux 上でこれらのセマンティクスを持つのは DECNet だけである。 flags が 0 の場合、 accept4() は accept() と同じである。 flags に以下の値をビット毎の論 理和 (OR) で指定することで、 異なる動作をさせることができる。 SOCK_NONBLOCK 新しく生成されるオープンファイル記述 (open file description) の O_NONBLOCK ファイルステータスフラグをセットする。 このフラグを使うことで、 O_NONBLOCK をセットするために fcntl(2) を追加で呼び出す必要がなくなる。 SOCK_CLOEXEC 新しいファイルディスクリプターに対して close-on-exec (FD_CLOEXEC) フラグ をセットする。 このフラグが役に立つ理由については、 open(2) の O_CLOEXEC フラグの説明を参照のこと。
返り値
成功した場合、これらのシステムコールは 受け付けたソケットのディスクリプターである非負の整 数値を返す。 エラーが発生した場合は -1 を返し、 errno を適切に設定する。 エラー処理 Linux の accept() (と accept4()) は、新しいソケットにおける、発生済みのネットワークエ ラーを accept() からのエラーコードとして渡す。 この振舞いは BSD ソケットの実装とは異な る。 信頼性の高い動作を行うためには、 アプリケーションはプロトコルで定義されているネット ワークエラーの検知を accept() のあとに行い、それらのエラーを EAGAIN と同じように扱い、再 試行 (retry) を行うべきである。 TCP/IP では、以下のエラーが該当する: ENETDOWN, EPROTO, ENOPROTOOPT, EHOSTDOWN, ENONET, EHOSTUNREACH, EOPNOTSUPP, ENETUNREACH
エラー
EAGAIN または EWOULDBLOCK ソケットが非停止になっていて、 かつ受付け対象の接続が存在しない。 POSIX.1-2001 は、この場合にどちらのエラーを返すことも認めており、 これら 2 つの定数が同じ値を持 つことも求めていない。 したがって、移植性が必要なアプリケーションでは、両方の可能性 を 確認すべきである。 EBADF ディスクリプターが不正。 ECONNABORTED 接続が中止された。 EFAULT addr 引き数がユーザーアドレス空間の書き込み可能領域にない。 EINTR 有効な接続が到着する前に捕捉されたシグナルによって システムコールが中断された。 signal(7) 参照。 EINVAL ソケットが接続待ち状態ではない。もしくは、 addrlen が不正である (例えば、負の場合な ど)。 EINVAL (accept4()) flags に不正な値が指定されている。 EMFILE 1プロセスがオープンできるファイルディスクリプター数の上限に達した。 ENFILE オープンされたファイルの総数がシステム全体の上限に達していた。 ENOBUFS, ENOMEM メモリーが足りない。 多くの場合は、システムメモリーが足りないわけではなく、 ソケッ トバッファーの大きさによるメモリー割り当ての制限である。 ENOTSOCK ディスクリプターはソケットではなくファイルを参照している。 EOPNOTSUPP 参照しているソケットの型が SOCK_STREAM でない。 EPROTO プロトコルエラー。 上記に加えて、Linux の accept() は以下のエラーで失敗する: EPERM ファイアウォールのルールにより接続が禁止された。 この他に、新しいソケットに対するネットワークエラーが返されることもある。 これらはそれぞれ のプロトコルで定義されている。 いろいろな Linux カーネルでは、 以下に示すようなエラーを返 すこともある。 ENOSR, ESOCKTNOSUPPORT, EPROTONOSUPPORT, ETIMEDOUT. ERESTARTSYS がトレース の最中に現れることもある。
バージョン
accept4() システムコールは Linux 2.6.28 以降で利用可能である。 glibc でのサポートはバー ジョン 2.10 以降で利用可能である。
準拠
accept(): POSIX.1-2001, SVr4, 4.4BSD, (accept() は 4.2BSD で初めて実装された). accept4() は非標準の Linux による拡張である。 Linux では、 accept() が返す新しいソケットは listen を行っているソケットの ファイル状態フ ラグ (O_NONBLOCK や O_ASYNC など) を継承「しない」。 この動作は標準的な BSD ソケットの実装 とは異なっている。 移植性を考慮したプログラムではファイル状態フラグが継承されるかどうかは 前提にせず、常に accept() が返したソケットに対して全ての必要なフラグを明示的に設定するよう に すべきである。
注意
POSIX.1-2001 では <sys/types.h> のインクルードは必須とされておらず、 Linux ではこのヘッ ダーファイルは必要ではない。 しかし、歴史的には、いくつかの実装 (BSD 系) でこのヘッダー ファイルが 必要であり、移植性が必要なアプリケーションではこのファイルを インクルードするの が賢明であろう。 SIGIO が届けられた後や、 select(2) または poll(2) が読み込み可能イベントを返した後に、 必ずしも待機中の接続があるとは限らない。 なぜならその接続は、 accept() が呼ばれる前に、非 同期的なネットワークエラーや 他のスレッドから呼ばれた (別の) accept によって 削除されてい るかもしれないからである。 この場合、その accept() 呼び出しは停止 (block) し、次の接続の到 着を待ちつづける。 accept() に停止を行わせないようにするには、引き数に渡すソケット sockfd に O_NONBLOCK フラグをセットしておく必要がある (socket(7) を見よ)。 socklen_t 型 accept() の第 3 引き数は、もともと int * と宣言されていた (libc4 や libc5, 4.x BSD, SunOS 4, SGI など多くのシステムではそうなっている)。 POSIX.1g draft 標準は、 これを size_t * に 変更しようとし、SunOS 5 ではそう宣言されている。 後に POSIX drafts には socklen_t * が含ま れるようになり、 Single UNIX Specification や glibc2 ではこのように宣言されるようになっ た。 Linus Torvald の発言を引用する: 「まともなライブラリを作りたければ、 "socklen_t" のサイズは int と同じにしなきゃならない。 さもないと BSD ソケット層を破壊することになっちゃう。 POSIX は最初こいつを size_t にしたん で、 ぼくは彼らに文句をがなりたてた (多分そういう人は他にもいたと思う。多くはなかったよう だけど)。 こいつを size_t にするのは完全にいかれてる。 例えば 64 ビットアーキテクチャーで は、 size_t が "int" と同じサイズだなんてことはほとんどないからね。 このサイズは "int" と 同じでなきゃ『ダメ』なんだ。 BSD ソケットインターフェースっていうのはそういうものなんだか ら。 まあともかく POSIX の人たちも、 "socklen_t" を作るという解決策をなんとかひねり出し た。 そもそも最初から放っておけば良かったんだが、 いじっちゃった以上、 名前付きの型を持た せなきゃならない、と思ったみたいだね。 なんでかはわかんないけど (きっと最初にやっちまった 馬鹿な間違いで顔をつぶしたくなかったから、 こっそり名前を付け替えて自分たちの大失敗をごま かそうとしたんだろう)。」
例
bind(2) 参照。
関連項目
bind(2), connect(2), listen(2), select(2), socket(2), socket(7)
この文書について
この man ページは Linux man-pages プロジェクトのリリース 3.79 の一部 である。プロジェクト の説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。