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

Copy
1<?php
2
3/**
4 * Demonstrates the use of stream_select() for monitoring multiple I/O streams,
5 * with a conceptual link to the STREAM_CAST_FOR_SELECT constant.
6 *
7 * STREAM_CAST_FOR_SELECT is a constant indicating that a stream should be
8 * prepared or "cast" into a form suitable for the underlying operating system's
9 * select() or poll() system calls. While PHP's stream_select() function
10 * internally handles this conversion for the stream resources you provide,
11 * this constant defines the specific flag used by functions like stream_cast()
12 * to achieve that purpose, allowing lower-level interaction if needed.
13 */
14function monitor_multiple_streams()
15{
16    echo "--- Stream Monitoring Example ---\n";
17    echo "This program monitors STDIN (your keyboard input) and a simulated internal socket.\n";
18    echo "Type something and press Enter to see it echoed. Observe automatic socket messages.\n";
19    echo "Press Ctrl+C to stop the program.\n\n";
20
21    // Initialize an array to hold streams we want to monitor for reading.
22    $read_streams = [];
23
24    // --- 1. Monitor STDIN (Standard Input) ---
25    // Open STDIN as a stream.
26    $stdin = fopen('php://stdin', 'r');
27    if ($stdin === false) {
28        die("Error: Could not open STDIN.\n");
29    }
30    // Set STDIN to non-blocking mode, so stream_select doesn't block indefinitely
31    // if there's no input.
32    stream_set_blocking($stdin, false);
33    $read_streams[] = $stdin;
34    echo "Monitoring STDIN (your keyboard input).\n";
35
36    // Conceptual use of STREAM_CAST_FOR_SELECT:
37    // If you needed to get the raw underlying file descriptor (e.g., for C-level select()),
38    // you would use stream_cast() with STREAM_CAST_FOR_SELECT.
39    // PHP's stream_select() typically works with the higher-level PHP stream resource directly.
40    $raw_stdin_fd = stream_cast($stdin, STREAM_CAST_FOR_SELECT);
41    if ($raw_stdin_fd !== false) {
42        // We won't use $raw_stdin_fd directly with PHP's stream_select,
43        // but this demonstrates how the constant is used to get the raw descriptor.
44        echo "  (STREAM_CAST_FOR_SELECT would conceptually prepare STDIN for OS select() calls.)\n";
45    } else {
46        echo "  (Failed to cast STDIN using STREAM_CAST_FOR_SELECT, which might happen on some systems.)\n";
47    }
48
49    // --- 2. Monitor a self-connected socket pair ---
50    // stream_socket_pair creates two connected, bi-directional streams (like a pipe).
51    // We'll write to $socket_sender and read from $socket_receiver to simulate network activity.
52    if (!stream_socket_pair(STREAM_PF_UNIX, STREAM_SOCK_STREAM, STREAM_IPPROTO_IP, $socket_sender, $socket_receiver)) {
53        die("Error: Could not create socket pair.\n");
54    }
55    // Set both sockets to non-blocking mode.
56    stream_set_blocking($socket_sender, false);
57    stream_set_blocking($socket_receiver, false);
58    // Add the receiver socket to our monitoring list.
59    $read_streams[] = $socket_receiver;
60    echo "Monitoring an internal socket for messages.\n";
61
62    // Keep original streams to close them later.
63    $all_active_streams = $read_streams;
64    $all_active_streams[] = $socket_sender; // Add sender socket for proper closing
65
66    $last_socket_write_time = microtime(true);
67    $write_interval_seconds = 2; // Send a message through the socket every 2 seconds
68
69    echo "\nStarting monitoring loop...\n";
70    while (true) {
71        // stream_select modifies the arrays passed by reference.
72        // We must create copies for each iteration.
73        $current_read_set = $read_streams;
74        $write_set = [];   // Not monitoring for write readiness in this example
75        $except_set = [];  // Not monitoring for exceptional conditions in this example
76
77        // Timeout: 1 second. stream_select will wait for up to 1 second.
78        // If no activity, it returns 0. If activity, it returns sooner.
79        $timeout_seconds = 1;
80        $timeout_microseconds = 0; // No microseconds timeout
81
82        // Call stream_select to wait for activity on any of the streams.
83        // It returns the number of ready streams, 0 on timeout, or false on error.
84        $num_ready_streams = stream_select(
85            $current_read_set,  // Streams to check for reading
86            $write_set,         // Streams to check for writing
87            $except_set,        // Streams to check for exceptions
88            $timeout_seconds,
89            $timeout_microseconds
90        );
91
92        if ($num_ready_streams === false) {
93            echo "Error: stream_select failed.\n";
94            break;
95        } elseif ($num_ready_streams === 0) {
96            // No activity detected during the timeout period.
97            echo "[No activity]\n";
98        } else {
99            // Activity detected on one or more streams.
100            echo "[Activity detected on $num_ready_streams stream(s)]\n";
101            foreach ($current_read_set as $ready_stream) {
102                if ($ready_stream === $stdin) {
103                    // STDIN is ready to be read from (user typed something).
104                    $input = trim(fgets($stdin));
105                    if ($input !== '') {
106                        echo "  STDIN input: '{$input}'\n";
107                    }
108                } elseif ($ready_stream === $socket_receiver) {
109                    // The receiver socket has data.
110                    $data = fread($socket_receiver, 1024); // Read up to 1024 bytes.
111                    if ($data !== false && $data !== '') {
112                        echo "  Socket received: '{$data}'\n";
113                    }
114                }
115            }
116        }
117
118        // --- Simulate sending data through the socket periodically ---
119        if ((microtime(true) - $last_socket_write_time) >= $write_interval_seconds) {
120            $message = "Hello from internal socket! (" . date('H:i:s') . ")\n";
121            fwrite($socket_sender, $message); // Write to the sender socket.
122            echo "  Socket sent: '{$message}'"; // Newline already in message
123            $last_socket_write_time = microtime(true);
124        }
125
126        // Small delay to prevent busy-looping, especially if select returns very quickly.
127        usleep(10000); // 10 milliseconds
128    }
129
130    // Clean up: Close all active streams.
131    echo "\nShutting down and closing streams...\n";
132    foreach ($all_active_streams as $stream) {
133        if (is_resource($stream)) {
134            fclose($stream);
135        }
136    }
137    echo "All streams closed. Exiting.\n";
138}
139
140// Execute the stream monitoring function.
141monitor_multiple_streams();

このPHPコードは、stream_select()関数を使用して複数の入出力ストリームを同時に監視する方法を示しています。stream_select()は、ファイルやソケットなどのストリームが読み込み可能、書き込み可能、または例外的な状態になったかどうかを効率的に待機する関数です。引数には監視したいストリームの配列や待機時間を指定し、準備ができたストリームの数を戻り値として返します。

STREAM_CAST_FOR_SELECTは、PHPがストリームをオペレーティングシステムの低レベルな入出力監視機構に適した形式に変換する際に使用される定数です。これはstream_cast()関数と組み合わせて、ストリームの生のファイルディスクリプタを取得する際に使用されますが、stream_select()は通常、PHPストリームリソースを直接処理し、この内部変換を自動で行います。

サンプルでは、キーボードからの入力（標準入力）と、内部で接続されたソケットからのデータ受信を同時に監視しています。stream_select()がどちらかのストリームに活動を検知すると、そのストリームからデータを読み取り、定期的にソケットへメッセージを送信するシミュレーションも行っています。これにより、プログラムが複数の非同期イベントに効率的に応答できる様子が分かります。

Copy
1<?php
2
3/**
4 * シンプルなノンブロッキングTCPサーバーを起動し、複数のクライアント接続を処理します。
5 * このサーバーは、新しい接続の受け入れと、既存のクライアントからのデータ読み取りを
6 * stream_select 関数を使用して効率的に管理します。
7 *
8 * @param string $host サーバーがリッスンするIPアドレス。
9 * @param int $port サーバーがリッスンするポート番号。
10 */
11function runNonBlockingTcpServer(string $host = '127.0.0.1', int $port = 8000): void
12{
13    // サーバーソケットを作成します。
14    // stream_socket_server は、指定されたアドレスとポートでリッスンするソケットを作成します。
15    $serverSocket = stream_socket_server("tcp://{$host}:{$port}", $errno, $errstr);
16
17    if (false === $serverSocket) {
18        echo "サーバーの起動に失敗しました: {$errstr} ({$errno})\n";
19        return;
20    }
21
22    // サーバーソケットを非ブロッキングモードに設定します。
23    // これにより、stream_socket_accept や他の操作がすぐに戻り、サーバーが他の処理を続行できます。
24    stream_set_blocking($serverSocket, false);
25
26    echo "TCPサーバーを {$host}:{$port} で起動しました。\n";
27    echo "クライアントは 'telnet {$host} {$port}' などで接続できます。\n";
28    echo "Ctrl+C で終了します。\n";
29
30    // 監視対象のクライアントソケットを保持する配列。
31    // 最初はサーバーソケットのみを監視します。
32    $clients = [$serverSocket];
33
34    // メインのイベントループ
35    while (true) {
36        $read = $clients; // 読み込み準備ができたソケットを検出するために、現在の全ソケットをコピー
37        $write = [];      // 書き込み準備ができたソケット (この例では使用しないが、引数として必須)
38        $except = [];     // 例外状態のソケット (この例では使用しないが、引数として必須)
39
40        // stream_select は、監視対象のソケットの中から、読み込み・書き込み・例外の準備ができたものを検出します。
41        // 最後の引数 '0' はタイムアウト値で、0秒は「すぐに返す」（ノンブロッキング）を意味します。
42        // STREAM_CAST_FOR_SELECT は、stream_cast 関数でストリームを stream_select で監視可能なファイルディスクリプタに
43        // キャストする際に使われる定数です。stream_select は通常、PHPストリームを内部的に適切に処理します。
44        $numReady = stream_select($read, $write, $except, 0);
45
46        if (false === $numReady) {
47            echo "stream_select エラーが発生しました。\n";
48            break;
49        }
50
51        if ($numReady === 0) {
52            // タイムアウトし、準備ができたソケットがない場合
53            usleep(10000); // CPU使用率を抑えるために少し待機
54            continue;
55        }
56
57        // サーバーソケットが $read 配列に含まれている場合、新しい接続があります。
58        if (in_array($serverSocket, $read, true)) {
59            // stream_socket_accept で新しいクライアント接続を受け入れます。
60            // サーバーソケットが非ブロッキングなので、accept もすぐに戻ります。
61            $newClient = stream_socket_accept($serverSocket, 0); // タイムアウト0で非ブロッキング
62
63            if (false !== $newClient) {
64                // 新しいクライアントソケットも非ブロッキングモードに設定します。
65                stream_set_blocking($newClient, false);
66                $clients[] = $newClient; // 監視対象に追加
67                echo "新しいクライアントが接続しました: " . stream_socket_get_name($newClient, true) . "\n";
68            }
69
70            // サーバーソケットは処理済みなので、$read から削除し、以降のループでクライアント処理に移る
71            $read = array_diff($read, [$serverSocket]);
72        }
73
74        // $read 配列に残っているのは、データが読み取り可能なクライアントソケットです。
75        foreach ($read as $clientSocket) {
76            // クライアントソケットからデータを読み込みます。
77            $data = fread($clientSocket, 8192); // 最大8192バイトを読み込み
78
79            if ($data === '' || $data === false) {
80                // データがない（空文字列）または読み込みエラー（false）の場合、接続が切断されたと判断します。
81                echo "クライアントが切断しました: " . stream_socket_get_name($clientSocket, true) . "\n";
82                // 監視対象からソケットを削除し、閉じます。
83                $key = array_search($clientSocket, $clients, true);
84                if (false !== $key) {
85                    unset($clients[$key]);
86                }
87                fclose($clientSocket);
88                continue; // 次のクライアントへ
89            }
90
91            $clientName = stream_socket_get_name($clientSocket, true);
92            echo "クライアント {$clientName} からデータを受信しました: " . trim($data) . "\n";
93
94            // クライアントに応答を送信します。
95            $response = "サーバーからの応答: " . trim($data) . "\n";
96            fwrite($clientSocket, $response);
97            echo "クライアント {$clientName} に応答を送信しました。\n";
98        }
99    }
100
101    // ループが終了した場合、サーバーソケットを閉じます。
102    // （通常、このコードはCtrl+Cなどで中断されるため、ここに到達することは稀です。）
103    echo "サーバーをシャットダウンします。\n";
104    fclose($serverSocket);
105}
106
107// サーバーを起動します。
108runNonBlockingTcpServer();

このPHPコードは、stream_socket_server関数を使用してTCPサーバーを起動し、複数のクライアント接続を効率的に管理するノンブロッキングサーバーの実装を示しています。サーバーソケットと新しく接続されたクライアントソケットは、stream_set_blockingにより非ブロッキングモードに設定されます。これにより、stream_socket_acceptで新しい接続を受け入れる際も、処理がブロックされることなくすぐに制御が返され、サーバーは他のクライアント処理を継続できます。

メインのイベントループでは、stream_select関数が利用され、読み込み準備ができたソケットや新しい接続要求を監視します。stream_selectのタイムアウト値を0秒に設定することで、すぐに結果を返し、ノンブロッキングな動作を実現しています。STREAM_CAST_FOR_SELECT定数は、stream_select関数がストリームを内部的にファイルディスクリプタとして扱う際に参照される定数の一つであり、stream_selectがPHPストリームを適切に処理できることを示します。

新しいクライアントが接続すると、stream_socket_acceptにより接続が確立され、そのクライアントソケットは監視対象に追加されます。クライアントからデータを受信するとfreadで読み込み、fwriteで応答を送信します。接続が切断された場合は、ソケットを閉じ、監視リストから削除することで、サーバーは多数のクライアントと同時に効率的に通信できます。