socket_set_nonblock

ソケットリソースを非ブロックモードに設定する

説明

bool socket_set_nonblock(Socket $socket)

socket_set_nonblock 関数は、 socket パラメータで指定したソケットに O_NONBLOCK フラグを設定します。

受信や送信、接続、待機といった操作を非ブロックモードのソケットに対して行うと、 その処理が完了するか何らかのシグナルを受信するまではスクリプトは停止しません。 また、その操作がブロックされると、呼び出し元の関数は失敗します。

パラメータ

socket

socket_create あるいは socket_accept で作成した Socket クラスのインスタンス。

戻り値

成功した場合に true を、失敗した場合に false を返します。

変更履歴

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

例1 socket_set_nonblock の例

<?php
$socket = socket_create_listen(1223);
socket_set_nonblock($socket);

socket_accept($socket);
?>

この例は、すべてのインターフェイス上でポート 1223 を待ち受けるソケットを作成し、それを O_NONBLOCK モードに設定します。 socket_accept は、 その時点で待機中の接続がない場合はすぐに失敗します。

参考

  • socket_set_block
  • socket_set_option
  • stream_set_blocking