Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【PHP8.x】STREAM_SHUT_RDWR定数の使い方

STREAM_SHUT_RDWR定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

STREAM_SHUT_RDWR定数は、ネットワークストリーム接続において、データの読み取りと書き込みの両方の機能を停止させることを表す定数です。

PHPでネットワーク通信を扱う際、例えばstream_socket_shutdown()のような関数を利用して、確立された接続の一部、あるいは全てを終了させる場合があります。この定数は、そのstream_socket_shutdown()関数に渡す引数の一つとして使われ、指定されたネットワークソケット接続からのデータ受信(読み取り)とデータ送信(書き込み)の両方を、同時に遮断するように指示します。

具体的には、クライアントとサーバー間の通信が完全に終了し、今後一切のデータ送受信が不要になった場合に、この定数を使用することで、双方向の通信を完全に停止させることができます。これにより、不要なリソースの占有を防ぎ、ネットワーク接続を安全かつ効率的に管理することが可能となります。ネットワークプログラミングにおいて、接続を適切に終了させるために重要な役割を担う定数です。

構文(syntax)

1<?php
2stream_socket_shutdown($socket, STREAM_SHUT_RDWR);

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHP stream_select によるストリーム監視とシャットダウン

1<?php
2
3/**
4 * PHP ストリーム監視とシャットダウンのサンプル。
5 *
6 * このスクリプトはTCPサーバーを起動し、クライアントからの接続を待ち受けます。
7 * stream_select を使用して、サーバーソケットと接続されたクライアントソケットの
8 * イベント(新しい接続、データの受信など)をノンブロッキングで監視します。
9 *
10 * クライアントからデータを受信すると、STREAM_SHUT_RDWR 定数を用いて
11 * stream_socket_shutdown 関数を呼び出し、そのクライアントソケットの
12 * 読み書き機能を停止させます。その後、接続をクローズします。
13 *
14 * 実行方法:
15 * 1. ターミナルで PHP スクリプトを実行: php your_script_name.php
16 * 2. 別のターミナルでクライアントとして接続(例: netcat を使用): nc 127.0.0.1 8000
17 * 3. netcat で何かメッセージを送信してください。サーバーがメッセージを受信後、
18 *    そのクライアントソケットの読み書きをシャットダウンし、接続を閉じます。
19 */
20
21/**
22 * TCPサーバーを起動し、ストリームイベントを処理します。
23 *
24 * @param string $address サーバーがリッスンするアドレス (例: 'tcp://127.0.0.1:8000')
25 */
26function run_server_and_handle_streams(string $address = 'tcp://127.0.0.1:8000'): void
27{
28    // TCP サーバーソケットを作成
29    // エラーが発生した場合は、メッセージを表示して終了
30    $server = stream_socket_server($address, $errno, $errstr);
31    if (!$server) {
32        echo "サーバーの作成に失敗しました: $errstr ($errno)\n";
33        return;
34    }
35    echo "サーバーが $address で起動しました。クライアントの接続を待機中...\n";
36
37    // サーバーソケットをノンブロッキングモードに設定
38    // これにより、stream_socket_accept() が即座に値を返し、
39    // stream_select() と組み合わせて複数の接続を効率的に扱えます。
40    stream_set_blocking($server, false);
41
42    // stream_select が監視するストリームのリストを初期化
43    $read_streams = [$server]; // 読み込み可能なストリームのリスト (サーバーソケットは新規接続を読み込む)
44    $write_streams = [];       // 書き込み可能なストリームのリスト (今回は使用しない)
45    $except_streams = [];      // 例外が発生したストリームのリスト (今回は使用しない)
46    $clients = [];             // 接続されたクライアントソケットを追跡するためのリスト
47
48    while (true) {
49        // stream_select の監視対象となる読み込みストリームの現在のリストをコピー
50        // stream_select は引数で渡された配列を変更するため、常にコピーを渡します。
51        $current_read_streams = $read_streams;
52        $num_changed_streams = stream_select($current_read_streams, $write_streams, $except_streams, 0, 200000); // タイムアウト: 0.2秒 (200000マイクロ秒)
53
54        if ($num_changed_streams === false) {
55            // stream_select の呼び出し中にエラーが発生した場合
56            echo "stream_select エラー: " . error_get_last()['message'] . "\n";
57            break;
58        }
59
60        if ($num_changed_streams === 0) {
61            // タイムアウトしたが、イベントが発生したストリームがなかった場合
62            continue;
63        }
64
65        // イベントが発生したストリームを一つずつ処理
66        foreach ($current_read_streams as $stream) {
67            if ($stream === $server) {
68                // サーバーソケットが読み込み可能と報告された場合、それは新しいクライアント接続要求を意味します
69                $client = stream_socket_accept($server);
70                if ($client) {
71                    // 新しいクライアント接続をノンブロッキングに設定
72                    stream_set_blocking($client, false);
73                    $client_address = stream_socket_get_name($client, true);
74                    echo "新しいクライアントが接続しました: $client_address\n";
75
76                    // 新しいクライアントソケットを監視リストに追加
77                    $read_streams[] = $client;
78                    $clients[(int)$client] = $client; // ストリームリソースIDをキーとしてクライアントを追跡
79                }
80            } else {
81                // クライアントソケットが読み込み可能と報告された場合、データ受信または切断を意味します
82                $client_address = stream_socket_get_name($stream, true);
83                $data = fread($stream, 1024); // クライアントソケットからデータを最大1024バイト読み込む
84
85                if ($data === '') {
86                    // fread が空文字列を返した場合、クライアントが接続を終了したことを意味します (EOF)
87                    echo "クライアントが切断しました: $client_address\n";
88                } elseif ($data === false) {
89                    // 読み込み中にエラーが発生した場合
90                    echo "クライアント $client_address からの読み込み中にエラーが発生しました。\n";
91                } else {
92                    // データが正常に受信された場合
93                    echo "クライアント $client_address からデータを受信: " . trim($data) . "\n";
94
95                    // STREAM_SHUT_RDWR を使用して、クライアントソケットの読み書き機能をシャットダウンします。
96                    // これにより、このソケットを介したさらなるデータの送信(書き込み)も受信(読み込み)もできなくなります。
97                    // stream_socket_shutdown はソケット自体を閉じるのではなく、I/Oストリームを停止します。
98                    stream_socket_shutdown($stream, STREAM_SHUT_RDWR);
99                    echo "クライアント $client_address の読み書きをシャットダウンしました (STREAM_SHUT_RDWR)。\n";
100
101                    // シャットダウン後は、このクライアントソケットはもはや通信に使用できないため、
102                    // リソースを解放するために接続を閉じ、監視リストから削除します。
103                    fclose($stream);
104                    echo "クライアント $client_address との接続を閉じました。\n";
105                }
106
107                // シャットダウンまたは切断されたクライアントソケットを監視リストから削除
108                $key = array_search($stream, $read_streams, true);
109                if ($key !== false) {
110                    unset($read_streams[$key]);
111                }
112                unset($clients[(int)$stream]);
113            }
114        }
115    }
116
117    // メインループが終了した場合、サーバーソケットを閉じます
118    fclose($server);
119    echo "サーバーをシャットダウンしました。\n";
120}
121
122// サーバーアプリケーションを実行
123run_server_and_handle_streams();

このPHPコードは、TCPサーバーを構築し、複数のクライアント接続を効率的に管理する方法を示すものです。stream_select関数は、サーバーソケットと接続されたクライアントソケットをノンブロッキングで監視し、新しい接続やデータ受信などのイベントを検出します。これにより、一つのプロセスで同時に多数の接続を処理できます。

STREAM_SHUT_RDWRは、stream_socket_shutdown関数と組み合わせて使用される定数です。このサンプルでは、クライアントからデータを受信した後、stream_socket_shutdown($stream, STREAM_SHUT_RDWR)を呼び出しています。これは、対象のクライアントソケットの「読み込み」と「書き込み」の両方のデータ送受信機能を停止させる指示です。STREAM_SHUT_RDWR自体に引数や戻り値はありませんが、stream_socket_shutdown関数に渡すことでソケットの特定のI/O機能を停止させる役割を果たします。stream_socket_shutdownはソケット自体を閉じるわけではなく、そのソケットを通じたデータI/Oのみを停止させます。このシャットダウン後、コードはfcloseでソケットを完全に閉じ、リソースを解放しています。

STREAM_SHUT_RDWR定数は、stream_socket_shutdown関数で使用し、ソケットの読み書き両方の通信機能を停止します。この定数を使うことで、指定したソケットからのデータ送受信ができなくなります。サンプルではデータ受信後、通信停止と同時にfcloseでソケットを閉じ、リソースを完全に解放しています。shutdownはcloseとは異なり、即座にリソースを解放するわけではない点にご留意ください。また、stream_selectは複数のソケットイベントをノンブロッキングで効率的に監視する際に用いますが、引数の配列が関数内で変更されるため、監視対象リストを毎回コピーして渡す必要があります。ソケットをノンブロッキングモードに設定することが、stream_selectと組み合わせる上で重要です。

PHP stream_socket_serverで全双方向ソケットを閉じる

1<?php
2
3/**
4 * 簡易TCPソケットサーバーを起動し、クライアント接続を受け入れ、
5 * データを送信した後に接続を完全にシャットダウンするサンプルコードです。
6 *
7 * STREAM_SHUT_RDWR 定数を使用して、ソケット接続の読み書き両方を閉じます。
8 *
9 * 実行方法:
10 * 1. ターミナルでこのスクリプトを `php your_script_name.php` と実行します。
11 * 2. 別のターミナルで `nc localhost 8000` (netcat) など、TCPクライアントで接続します。
12 *    (macOS/Linux: `nc localhost 8000`)
13 *    (Windows: CygwinやWSLのnetcat、またはTelnetクライアントなどを使用)
14 *    接続後、サーバーからメッセージが送られ、接続が閉じられることを確認できます。
15 */
16
17// サーバーのアドレスとポートを指定します。
18$host = '127.0.0.1'; // ローカルホストのアドレス
19$port = 8000;      // 使用するポート番号
20
21// stream_socket_server() 関数を使用してソケットサーバーを起動します。
22// 第1引数: 接続を受け付けるアドレス (例: tcp://127.0.0.1:8000)
23// 第2引数: エラーコードを格納する変数 (参照渡し)
24// 第3引数: エラーメッセージを格納する変数 (参照渡し)
25$server = stream_socket_server("tcp://$host:$port", $errno, $errstr);
26
27// サーバーの起動に失敗した場合、エラーメッセージを表示して終了します。
28if (!$server) {
29    echo "サーバーの起動に失敗しました: $errstr ($errno)\n";
30    exit(1);
31}
32
33// サーバーが正常に起動したことを表示します。
34echo "TCPサーバーが $host:$port で起動しました。クライアントの接続を待機中...\n";
35
36// 無限ループでクライアントからの接続を待ち受けます。
37while (true) {
38    // stream_socket_accept() 関数でクライアントからの接続を受け入れます。
39    // 第1引数: サーバーソケット
40    // 第2引数: タイムアウト秒数 (-1は無期限に待機)
41    $client = stream_socket_accept($server, -1);
42
43    // クライアントが接続された場合
44    if ($client) {
45        echo "クライアントが接続しました: " . stream_socket_get_name($client, true) . "\n";
46
47        // クライアントへメッセージを送信します。
48        $message = "Hello, Client! This is a message from the server.\n";
49        fwrite($client, $message);
50        echo "クライアントにメッセージを送信しました。\n";
51
52        // --- ここで STREAM_SHUT_RDWR 定数を使用します ---
53        // stream_socket_shutdown() 関数は、ソケット接続の一部または全体をシャットダウンします。
54        // 第1引数: シャットダウンするソケット接続 (クライアントソケット)
55        // 第2引数: シャットダウンの種類を指定する定数
56        // STREAM_SHUT_RDWR は、接続の読み込み側と書き込み側の両方を閉じます。
57        // これにより、クライアントはこの接続でこれ以上データを送受信できなくなります。
58        echo "接続の読み書き両方をシャットダウンします (STREAM_SHUT_RDWR)。\n";
59        stream_socket_shutdown($client, STREAM_SHUT_RDWR);
60
61        // stream_socket_shutdown() の後でも、ソケットリソースを完全に解放するために
62        // fclose() で明示的に接続を閉じるのが推奨されます。
63        fclose($client);
64        echo "クライアントとの接続を閉じました。\n";
65    }
66}
67
68// このサンプルコードは無限ループを使用しているため、通常この行には到達しません。
69// サーバーを停止する際は、Ctrl+Cなどでプロセスを終了してください。
70// もし、より複雑な終了処理を実装する場合は、fclose($server); が必要になります。
71// fclose($server);
72// echo "サーバーを停止しました。\n";
73
74?>

このPHPコードは、簡易的なTCPソケットサーバーを構築し、クライアントからの接続を受け入れてメッセージを送信した後、その接続を完全にシャットダウンする一連の流れを示しています。まず、stream_socket_server()関数を使用して、指定されたIPアドレスとポートでTCPサーバーを起動します。この関数は、接続を受け入れるためのサーバーソケットリソースを返し、サーバー起動時のエラーは引数に格納されます。次に、無限ループ内でstream_socket_accept()関数によりクライアントの接続を待ち受けます。接続が確立されると、この関数はクライアントとの通信に使用するソケットリソースを返します。サーバーはクライアントにメッセージを送信した後、stream_socket_shutdown()関数を呼び出します。この関数の第1引数にはシャットダウンしたいクライアントソケットを、第2引数にはシャットダウンの種類を指定する定数を渡します。ここで使用するSTREAM_SHUT_RDWR定数は、ソケット接続の読み込み側と書き込み側の両方を完全に閉じます。この定数自体に引数や戻り値はありませんが、stream_socket_shutdown()関数に渡すことで、クライアントとの通信チャネルを双方向で即座に遮断する役割を果たします。これにより、クライアントはこの接続でこれ以上データを送受信できなくなり、リソースの無駄な保持を防ぎます。最終的にfclose()関数でソケットリソースを解放し、接続を閉じます。

STREAM_SHUT_RDWR定数は、TCPソケット接続の読み書き両方を完全にシャットダウンするために使用します。これにより、その接続での送受信が停止します。stream_socket_shutdown関数でシャットダウンした後も、ソケットのリソースを確実に解放するにはfclose関数で明示的に接続を閉じることが重要です。シャットダウンは通信経路の停止を意味し、クローズはリソースの解放を意味するため、この違いを理解してください。また、サンプルコードは無限ループで動作しますので、実行後は手動でプロセスを停止させる必要があります。実運用では、安全な停止処理も検討しましょう。指定ポートが利用できない場合は、他のポート番号に変更して試してください。

関連コンテンツ

関連IT用語

関連プログラミング言語