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

Copy
1<?php
2
3/**
4 * Attempts to establish a client socket connection to a host and port
5 * using the STREAM_CLIENT_PERSISTENT flag.
6 *
7 * STREAM_CLIENT_PERSISTENT is a flag used with stream_socket_client() that
8 * instructs PHP to attempt to reuse an existing persistent connection
9 * to the same host/port if available, or to establish a new connection
10 * that may be marked for persistence. This can improve performance by
11 * reducing connection setup overhead in environments like PHP-FPM.
12 *
13 * @param string $host The hostname or IP address to connect to.
14 * @param int $port The port number to connect to.
15 * @return bool True on successful connection attempt (even if subsequently closed), false on failure.
16 */
17function demonstratePersistentClientConnection(string $host, int $port): bool
18{
19    echo "Attempting to connect to {$host}:{$port} using STREAM_CLIENT_PERSISTENT...\n";
20
21    $errno = null;    // Variable to store the error number.
22    $errstr = null;   // Variable to store the error string.
23    $timeout = 30;    // Connection timeout in seconds.
24
25    // Use STREAM_CLIENT_CONNECT to initiate a connection and
26    // STREAM_CLIENT_PERSISTENT to request a persistent connection.
27    // The '|' operator combines these flags.
28    $socket = stream_socket_client(
29        "tcp://{$host}:{$port}",
30        $errno,
31        $errstr,
32        $timeout,
33        STREAM_CLIENT_CONNECT | STREAM_CLIENT_PERSISTENT
34    );
35
36    if (!$socket) {
37        // Connection failed.
38        echo "Failed to connect: [{$errno}] {$errstr}\n";
39        return false;
40    }
41
42    // Connection successful.
43    echo "Successfully established (or reused) a connection to {$host}:{$port}.\n";
44    echo "You could now perform read/write operations using the \$socket resource.\n";
45
46    // In a simple script, it's generally good practice to close the socket
47    // when operations are complete, even with a persistent flag, unless
48    // specifically managing resource persistence across multiple requests (e.g., in a web server environment).
49    fclose($socket);
50    echo "Connection closed.\n";
51
52    return true;
53}
54
55// --- サンプルコードの実行例 ---
56// 広く利用されているウェブサイトのHTTPポート(80)をターゲットに指定します。
57// これにより、stream_socket_client が実際に接続を試みる様子を確認できます。
58$targetHost = 'www.example.com';
59$targetPort = 80;
60
61demonstratePersistentClientConnection($targetHost, $targetPort);
62
63echo "\n--- 失敗例 --- \n";
64// 存在しないホストやポートへの接続試行でエラーハンドリングを確認。
65demonstratePersistentClientConnection('nonexistent.invalid', 80);
66demonstratePersistentClientConnection('127.0.0.1', 99999); // 通常は使用されていないポート
67

このPHPサンプルコードは、STREAM_CLIENT_PERSISTENT定数を利用して、永続的なクライアントソケット接続を確立する方法を示しています。demonstratePersistentClientConnection関数は、引数として指定された$host（接続先のホスト名またはIPアドレス）と$port（接続先のポート番号）を用いて、ソケット接続を試みます。

関数内部では、stream_socket_client関数が接続処理を実行します。この際、STREAM_CLIENT_CONNECTフラグで接続開始を指示し、さらにSTREAM_CLIENT_PERSISTENTフラグを|演算子で組み合わせて渡しています。STREAM_CLIENT_PERSISTENTは、既存の永続接続が利用可能であればそれを再利用するか、または新しい接続を永続的なものとして確立するようPHPに指示するもので、PHP-FPMのような環境で接続設定のオーバーヘッドを減らし、パフォーマンス向上に貢献する可能性があります。

接続が成功した場合、この関数はブール値のtrueを返し、成功メッセージが表示されます。一方、接続に失敗した場合はfalseを返し、エラーコードとエラーメッセージが出力されます。接続が確立された後は、ソケットリソースを使ってデータの送受信が可能ですが、この例では処理完了後にfclose($socket)でソケットを閉じています。コードの実行例では、www.example.comへの接続試行と、存在しないホストやポートへの接続失敗例を通じて、これらの挙動を確認できます。

Copy
1<?php
2
3/**
4 * PHP 8 でのネットワークストリーム操作の基本を示します。
5 * STREAM_CLIENT_PERSISTENT を使用した永続接続の試みと、
6 * stream_set_timeout を使用した通信タイムアウトの設定方法を理解するのに役立ちます。
7 *
8 * @param string $host 接続先のホスト名（例: 'www.example.com'）
9 * @param int $port 接続先のポート番号（例: 80）
10 * @param int $connectionTimeout 初期接続試行のタイムアウト時間（秒）
11 * @param int $readWriteTimeout ストリームの読み書き操作のタイムアウト時間（秒）
12 * @return void
13 */
14function demonstratePersistentClientAndTimeout(
15    string $host = 'www.example.com',
16    int $port = 80,
17    int $connectionTimeout = 5,
18    int $readWriteTimeout = 2
19): void {
20    echo "{$host}:{$port} への永続接続を試行中...\n";
21
22    $errno = 0; // 接続エラーコード
23    $errstr = ''; // 接続エラーメッセージ
24
25    // stream_socket_client() を使用してネットワーク接続を開きます。
26    // STREAM_CLIENT_PERSISTENT フラグを指定することで、PHP はこの接続を永続化しようと試みます。
27    // 同じホストとポートへの後続の接続要求があった場合、既存の接続が再利用される可能性があります。
28    $client = stream_socket_client(
29        "tcp://{$host}:{$port}",
30        $errno,
31        $errstr,
32        $connectionTimeout,
33        STREAM_CLIENT_CONNECT | STREAM_CLIENT_PERSISTENT
34    );
35
36    if (!$client) {
37        echo "エラー: {$host}:{$port} に接続できませんでした。 ({$errno}) {$errstr}\n";
38        return;
39    }
40
41    echo "接続に成功しました。ストリームのタイムアウトを設定中...\n";
42
43    // stream_set_timeout() を使用して、ストリームの読み書き操作のタイムアウトを設定します。
44    // 指定された時間内にデータが送受信されない場合、操作はタイムアウトします。
45    stream_set_timeout($client, $readWriteTimeout);
46
47    // 簡単な HTTP GET リクエストを送信します。
48    $request = "GET / HTTP/1.0\r\nHost: {$host}\r\nConnection: close\r\n\r\n";
49    fwrite($client, $request);
50    echo "リクエストを送信しました。レスポンスを待機中 (最大 {$readWriteTimeout} 秒)...\n";
51
52    $response = '';
53    while (!feof($client)) {
54        $chunk = fread($client, 1024); // 最大 1024 バイト読み込み
55        if ($chunk === false || $chunk === '') {
56            // ストリームのメタデータをチェックしてタイムアウトが発生したか確認します。
57            $meta = stream_get_meta_data($client);
58            if ($meta['timed_out']) {
59                echo "警告: 読み込み操作が {$readWriteTimeout} 秒でタイムアウトしました。\n";
60            }
61            break; // 読み込み失敗またはストリーム終了でループを抜けます
62        }
63        $response .= $chunk;
64    }
65
66    echo "レスポンスを受信しました（またはタイムアウト）。\n";
67    // レスポンスの最初の 200 文字までを表示します。
68    echo substr($response, 0, 200) . (strlen($response) > 200 ? '...' : '') . "\n";
69
70    // ストリームを閉じます。
71    // STREAM_CLIENT_PERSISTENT を使用した場合でも、明示的に閉じることは良い習慣です。
72    // PHPエンジンは、同じホスト/ポートへの後続の要求のために基礎となるTCP接続をオープンに保つ可能性があります。
73    fclose($client);
74    echo "接続を閉じました。\n";
75}
76
77// サンプルコードの実行
78demonstratePersistentClientAndTimeout();
79
80// タイムアウトの動作をより明確に確認するために、存在しないポートや
81// 応答が遅いサーバーへの接続を試すこともできます。
82// 例:
83// demonstratePersistentClientAndTimeout('127.0.0.1', 8080, 2, 1);

このPHPサンプルコードは、ネットワーク接続の永続化と、ストリームの読み書きタイムアウト設定の基本を示しています。

STREAM_CLIENT_PERSISTENTは、stream_socket_client関数で使用される定数です。この定数を用いることで、PHPは同じホストとポートへの接続を永続的に保とうと試みます。一度確立された接続は、スクリプトの実行が完了してもすぐに閉じられず、同じサーバーへの後続の接続要求で再利用される可能性があるため、接続のオーバーヘッドを削減できます。この定数自体に引数や戻り値はありません。

stream_set_timeout関数は、指定されたストリームの読み書き操作にタイムアウトを設定します。この関数には、ストリームリソースとタイムアウト秒数を引数として渡し、戻り値はありません。もし設定された時間内にストリームからのデータ受信やストリームへのデータ送信が完了しなかった場合、操作はタイムアウトし、プログラムはそれ以上待機せずに処理を進めることができます。これにより、ネットワークの遅延やサーバーの無応答によってプログラムが長時間ブロックされることを防ぎ、アプリケーションの応答性を向上させます。

サンプルコードでは、まずstream_socket_clientで永続接続を試み、その後にstream_set_timeoutで通信のタイムアウトを設定しています。その後、HTTPリクエストを送信し、freadでレスポンスを読み込みます。読み込み中にタイムアウトが発生した場合は、stream_get_meta_dataでその状況を検出し、適切なメッセージを表示します。最後にfcloseで接続を閉じますが、永続接続の性質上、PHPエンジンが基礎となるTCP接続を保持する場合があります。このコードは、堅牢なネットワーク通信を実装するための重要な概念を理解するのに役立ちます。