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

Copy
1<?php
2
3/**
4 * PHPのストリーム操作におけるタイムアウト設定とソケットシャットダウンの例。
5 *
6 * この関数は、ローカルホストへのTCP接続を試み、データの送信、
7 * 書き込み側のシャットダウン (STREAM_SHUT_WRの使用)、
8 * そして読み込み操作のタイムアウト設定 (stream_set_timeoutの使用) の方法を示します。
9 *
10 * サーバーがローカルホストの指定ポートでリッスンしていない場合、接続は失敗します。
11 * しかし、その過程でストリーム操作の基本とエラーハンドリングを学ぶことができます。
12 * システムエンジニアを目指す初心者の方が、ネットワーク通信とストリーム制御の
13 * 基本的な概念を理解するのに役立つように設計されています。
14 */
15function demonstrateStreamOperations(): void
16{
17    $host = '127.0.0.1'; // 接続先のホスト (ローカルホスト)
18    $port = 12345;      // 接続先のポート番号 (一般的に未使用のポート)
19    $address = "tcp://{$host}:{$port}";
20
21    echo "{$address} への接続を試みます...\n";
22
23    // stream_socket_client() の最後の引数で接続タイムアウトを秒単位で設定します。
24    // 接続が5秒以内に完了しない場合、エラーが発生します。
25    $errno = 0;
26    $errstr = '';
27    $socket = stream_socket_client($address, $errno, $errstr, 5);
28
29    if (!$socket) {
30        // 接続に失敗した場合、エラーメッセージを表示して終了します。
31        echo "接続に失敗しました: [{$errno}] {$errstr}\n";
32        echo "ヒント: サーバーが {$address} でリッスンしているか確認してください。\n";
33        return;
34    }
35
36    echo "接続に成功しました。\n";
37
38    // サーバーにデータを送信します。
39    $message = "Hello, server!\n";
40    echo "メッセージを送信中: '{$message}'";
41    fwrite($socket, $message);
42    echo "送信完了。\n";
43
44    // ストリームの書き込み側をシャットダウンします。
45    // STREAM_SHUT_WR 定数は、ストリームの書き込み側のみを閉じることを指示します。
46    // これにより、これ以上データをサーバーに送信しないことを示し、
47    // サーバーはクライアントからのデータ送信が完了したことを認識できます。
48    echo "書き込み側をシャットダウンします (STREAM_SHUT_WR を使用)。\n";
49    if (stream_socket_shutdown($socket, STREAM_SHUT_WR)) {
50        echo "書き込み側シャットダウンに成功しました。\n";
51    } else {
52        echo "書き込み側シャットダウンに失敗しました。\n";
53        // 失敗しても読み込みは試みる場合があります。
54    }
55
56    // stream_set_timeout() を使用して、ストリームの読み込み操作に対するタイムアウトを設定します。
57    // 読み込み操作が10秒間ブロックされた場合、タイムアウトが発生します。
58    // これは、応答を無期限に待ち続けないようにするために重要です。
59    echo "読み込みタイムアウトを10秒に設定します。\n";
60    if (stream_set_timeout($socket, 10)) {
61        echo "タイムアウト設定に成功しました。\n";
62    } else {
63        echo "タイムアウト設定に失敗しました。\n";
64        fclose($socket);
65        return;
66    }
67
68    echo "サーバーからの応答を読み込み中...\n";
69    $response = '';
70    while (!feof($socket)) {
71        $readData = fread($socket, 1024); // サーバーからのデータを読み込む
72        if ($readData === false) {
73            echo "読み込みエラーが発生しました。\n";
74            break;
75        }
76        $response .= $readData;
77
78        // stream_get_meta_data() を使用してストリームのメタデータを取得し、
79        // タイムアウトが発生したかどうかをチェックします。
80        $meta = stream_get_meta_data($socket);
81        if ($meta['timed_out']) {
82            echo "読み込み操作がタイムアウトしました。\n";
83            break;
84        }
85    }
86
87    if (!empty($response)) {
88        echo "サーバーからの応答: '{$response}'\n";
89    } else {
90        echo "サーバーからの応答はありませんでした。\n";
91    }
92
93    // ストリーム (ソケット) を閉じます。
94    echo "接続を閉じます。\n";
95    fclose($socket);
96}
97
98// 関数の実行
99demonstrateStreamOperations();

このPHPサンプルコードは、TCPソケット通信の確立、データ送信、ストリームの部分的なシャットダウン、そして読み込み操作のタイムアウト設定という一連の流れをシステムエンジニアを目指す初心者の方にわかりやすく示しています。

まず、stream_socket_client()関数で指定したIPアドレスとポートへTCP接続を試みます。接続が成功すると、fwrite()でサーバーへメッセージを送信します。

次に、stream_socket_shutdown()関数とPHPの定数であるSTREAM_SHUT_WRを組み合わせて使用します。STREAM_SHUT_WRは、ストリームの書き込み側のみを閉じることを指示する定数です。これには引数も戻り値もありません。これにより、クライアントはこれ以上データを送信しないことをサーバーに伝え、サーバーはクライアントからのデータ送信が完了したと認識できます。

続いて、stream_set_timeout()関数を用いて、ストリームの読み込み操作に対するタイムアウトを設定しています。この関数は、ストリームとタイムアウト秒数を引数として受け取り、設定に成功すればtrue、失敗すればfalseを返します。これにより、サーバーからの応答を無期限に待ち続けることを防ぎ、指定時間内にデータが来なければ読み込みを中止するよう設定できます。その後、fread()でサーバーからの応答を読み込み、stream_get_meta_data()でタイムアウトが発生したかどうかを確認しています。

最後に、fclose()でソケット接続を閉じます。これらの操作は、ネットワーク通信におけるデータの送受信とエラーハンドリングの基本を理解する上で非常に重要です。

Copy
1<?php
2
3/**
4 * TCPソケットストリームにおける書き込みバッファリングとシャットダウンの例。
5 *
6 * この関数は、`stream_set_write_buffer()` を使用してストリームの書き込みバッファリングを制御し、
7 * `STREAM_SHUT_WR` 定数を用いてストリームの書き込み側のみをシャットダウンする方法を示します。
8 *
9 * @param string $host 接続するホスト名またはIPアドレス。
10 * @param int $port 接続するポート番号。
11 * @param string $message 送信するメッセージ。
12 * @return void
13 */
14function demonstrateStreamOperations(string $host, int $port, string $message): void
15{
16    // TCPソケットクライアントストリームを作成します。
17    // 実際に接続するには、指定したポートでリッスンしているサーバーが必要です。
18    // エラー抑制演算子(@)を使用していますが、本番環境ではより堅牢なエラーハンドリングが推奨されます。
19    $socket = @stream_socket_client("tcp://$host:$port", $errno, $errstr, 5);
20
21    if (!$socket) {
22        echo "エラー: ソケットに接続できませんでした ($errno) $errstr\n";
23        return;
24    }
25
26    echo "ソケット接続に成功しました: $host:$port\n";
27
28    // stream_set_write_buffer() を使用して書き込みバッファリングを設定します。
29    // ここではバッファサイズを0に設定し、書き込み操作がすぐに基になるストリームにフラッシュされるようにします。
30    // 0以外のサイズを設定すると、データはバッファリングされ、バッファが満たされるか、
31    // stream_flush() が呼び出されるまで書き込まれません。
32    if (stream_set_write_buffer($socket, 0) === 0) {
33        echo "書き込みバッファリングが無効になりました（直接書き込みモード）。\n";
34    } else {
35        echo "エラー: 書き込みバッファリングの設定に失敗しました。\n";
36        fclose($socket);
37        return;
38    }
39
40    // ストリームにデータを書き込みます。
41    // バッファリングが無効なため、この書き込みは即座に基になるソケットに送信されます。
42    $bytesWritten = fwrite($socket, $message);
43    if ($bytesWritten === false) {
44        echo "エラー: ソケットへの書き込みに失敗しました。\n";
45    } else {
46        echo "ソケットに {$bytesWritten} バイトを書き込みました。\n";
47    }
48
49    // STREAM_SHUT_WR 定数を使用して、ストリームの書き込み側のみをシャットダウンします。
50    // これにより、これ以上データが送信されなくなりますが、受信は引き続き可能です。
51    // これは、クライアントが送信を完了したが、サーバーからの応答を待つ場合に便利です。
52    if (stream_socket_shutdown($socket, STREAM_SHUT_WR)) {
53        echo "ストリームの書き込み側をシャットダウンしました。\n";
54    } else {
55        echo "エラー: ストリームの書き込み側のシャットダウンに失敗しました。\n";
56    }
57
58    // ストリームを完全に閉じます。
59    fclose($socket);
60    echo "ストリームを閉じました。\n";
61}
62
63// サンプル実行: ローカルホストの8000番ポートへの接続を試みます。
64// 実際に接続するには、このポートでリッスンしているサーバーが必要です。
65demonstrateStreamOperations("127.0.0.1", 8000, "Hello from PHP stream example!\n");
66

このPHPコードは、TCPソケットストリームにおけるデータの書き込み制御と、ストリームの書き込み側のみをシャットダウンする方法を示しています。

まず、stream_socket_client関数で指定されたホストとポートへ接続し、TCPソケットストリームを作成します。これがネットワーク通信の基盤となります。

次に、stream_set_write_buffer関数を使用して、ストリームの書き込みバッファリングを制御します。この関数は、第一引数にストリームリソース、第二引数にバッファサイズを渡します。サンプルコードではバッファサイズを0に設定しており、これによりfwrite関数で書き込まれたデータがバッファに溜められることなく、即座にネットワークへ送信されます。もし0以外のサイズを設定した場合、データは内部バッファに保持され、バッファが満たされるか、明示的にフラッシュされるまで送信は保留されます。この関数の戻り値は、成功時に0、失敗時にfalseです。

データが書き込まれた後、stream_socket_shutdown関数とSTREAM_SHUT_WR定数を使用して、ストリームの書き込み側のみをシャットダウンします。STREAM_SHUT_WRは、ストリームに対してこれ以上データを送信しないことを示します。これにより、送信は停止しますが、ストリームは開いたままであり、相手からのデータを受信することは引き続き可能です。これは、クライアントがメッセージの送信を完了したが、サーバーからの応答を待ち続ける必要がある場合に特に役立ちます。stream_socket_shutdown関数は、成功時にtrue、失敗時にfalseを返します。

最後にfclose関数でストリームを完全に閉じ、関連するリソースを解放します。この一連の操作を通じて、PHPでネットワーク通信におけるデータの送信方法や接続状態を柔軟に制御できることがわかります。