socket_listen

(PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8)

socket_listen — ソケット上で接続待ち(listen)する

socket_listen(Socket $socket, int $backlog = 0): bool

ソケット socket が socket_create() を用いて作成され、 socket_bind() で名前が付けられた後、 socket 上の接続要求を待つための通信ができるようになります。

socket_listen() は、ソケットが SOCK_STREAM 型または SOCK_SEQPACKET 型の場合のみ利用可能です。

socket: socket_create() または socket_addrinfo_bind() で作成した有効な Socket クラスのインスタンス。
backlog: 最大 backlog 個の接続を処理用のキューで待ち受けることが可能です。もし待ちうけ用のキューがいっぱいになった場合、クライアントでは ECONNREFUSED の通知とともにエラーが発生します。あるいは、もし基盤となるプロトコルがリクエストの再送をサポートしている場合、再試行が成功するまでリクエストは無視されます。

注意:
backlog パラメータに指定できる値の最大値はプラットフォームに大きく依存します。Linux では、最大値は SOMAXCONN に切り詰められます。win32 では、もし SOMAXCONN を渡した場合、backlog の最大値を適切な値に設定する責任はサービスの提供側が負います。このプラットフォームでは、実際の backlog の値を見つける標準的な手段が提供されていません。

成功した場合に true を、失敗した場合に false を返します。エラーコードは socket_last_error() で取得可能で、このコードを socket_strerror() に指定することによりエラーの内容を文字列として取得可能です。

バージョン	説明
8.0.0	`socket` は、Socket クラスのインスタンスになりました。これより前のバージョンでは、リソース型でした。

関連キーワード: 　ソケット, listen, 接続, backlog, 最大, bind, 作成, create, addrinfo, Socket