【PHP8.x】pfsockopen()関数の使い方

Copy
1<?php
2
3/**
4 * 指定されたホストとポートに永続的なソケット接続を試みます。
5 *
6 * pfsockopen は、通常の fsockopen とは異なり、スクリプトの実行が終了しても
7 * 接続が閉じずに維持される可能性がある「永続接続」を確立します。
8 * これは、後続のPHPスクリプト実行で同じ接続を再利用できる場合があります。
9 *
10 * @param string $hostname 接続先のホスト名またはIPアドレス。
11 * @param int $port 接続先のポート番号。
12 * @param float|null $timeout 接続タイムアウト時間（秒）。nullの場合、PHPのデフォルト値が使用されます。
13 * @return resource|false 接続が成功した場合はファイルポインタリソース、失敗した場合は false。
14 */
15function connectToPersistentSocket(string $hostname, int $port, ?float $timeout = null)
16{
17    echo "{$hostname}:{$port} への永続的なソケット接続を試みています...\n";
18
19    $errorCode = null;     // 接続失敗時のエラーコードを格納する変数
20    $errorMessage = null;  // 接続失敗時のエラーメッセージを格納する変数
21
22    // pfsockopen 関数を呼び出して永続的なソケット接続を開きます。
23    // 接続に失敗した場合、エラー情報が $errorCode と $errorMessage に参照渡しで格納されます。
24    $socket = pfsockopen($hostname, $port, $errorCode, $errorMessage, $timeout);
25
26    if ($socket === false) {
27        // 接続失敗時の処理
28        echo "接続に失敗しました。\n";
29        echo "エラーコード: " . ($errorCode ?? '不明') . "\n";
30        echo "エラーメッセージ: " . ($errorMessage ?? '不明') . "\n";
31    } else {
32        // 接続成功時の処理
33        echo "接続に成功しました！\n";
34        echo "接続リソースタイプ: " . get_resource_type($socket) . "\n";
35
36        // 注意: pfsockopen は永続接続のため、通常は fclose() を明示的に呼び出す必要はありません。
37        // PHPプロセスがこの接続を再利用する可能性があります。
38        // ここでデータの送受信を行うことができます。
39        // 例: fwrite($socket, "GET / HTTP/1.1\r\nHost: {$hostname}\r\nConnection: Close\r\n\r\n");
40        // 例: while (!feof($socket)) { echo fgets($socket, 1024); }
41    }
42
43    return $socket; // 接続リソース（成功時）または false（失敗時）を返します
44}
45
46// --- サンプルコードの実行例 ---
47
48// 1. 一般的なウェブサイト (example.com) のポート80への接続を試みます
49//    ほとんどの場合、接続は成功します。
50connectToPersistentSocket('www.example.com', 80, 5.0);
51echo "\n"; // 出力を見やすくするための改行
52
53// 2. 存在しない可能性のあるホストへの接続を試みます
54//    通常、この接続はタイムアウトするか、名前解決に失敗してエラーになります。
55connectToPersistentSocket('nonexistent.example.com', 80, 3.0);
56echo "\n";
57
58// 3. ローカルホストの特定のポートへの接続を試みます
59//    ローカル環境でWebサーバーなどがポート8080で起動している場合、接続が成功する可能性があります。
60connectToPersistentSocket('localhost', 8080, 2.0);
61
62?>

PHP 8のpfsockopen関数は、指定されたホストとポートに永続的なソケット接続を試みるための重要な機能です。この関数は通常のfsockopen関数とは異なり、PHPスクリプトの実行が終了した後も接続が維持される可能性があるため、後続のスクリプト実行で同じ接続を再利用し、処理効率を高めることが期待できます。

引数には、接続先のホスト名またはIPアドレス（$hostname）とポート番号（$port）を指定します。オプションで、接続が確立されるまでの最大待ち時間を示すタイムアウト値（$timeout）を秒単位で設定することも可能です。さらに、接続試行が失敗した場合に詳細なエラー情報を取得するため、エラーコードを格納する変数（&$error_code）とエラーメッセージを格納する変数（&$error_message）を参照渡しで指定できます。これにより、エラーの原因を具体的に把握しやすくなります。

関数は、接続が成功した場合にはそのソケットを表すファイルポインタリソースを戻り値として返します。しかし、何らかの理由で接続に失敗した場合にはfalseを返します。

サンプルコードでは、connectToPersistentSocket関数を用いて、実際のウェブサイト（www.example.com）への接続成功例、存在しないホストへの接続失敗例、そしてローカルホストへの接続例を具体的に示しています。成功時には接続リソースの種類が出力され、失敗時には$error_codeと$error_messageに格納された情報が表示される挙動を確認できます。pfsockopenは永続接続であるため、通常は明示的にfclose()を呼び出して接続を閉じる必要はありません。

Copy
1<?php
2
3/**
4 * pfsockopen 関数を使用して SSL/TLS 接続を試みるサンプルコードです。
5 * pfsockopen は永続的なソケット接続を確立します。
6 *
7 * 注意: pfsockopen 関数自体には、SSL 検証を無効にする直接的な引数はありません。
8 * ホスト名に 'ssl://' プレフィックスを使用することで SSL/TLS 接続を試みますが、
9 * PHP のデフォルトの SSL/TLS 設定に基づいて検証が有効な状態で接続されます。
10 * SSL 検証を無効にする、あるいは細かく制御する場合は、
11 * stream_socket_client と stream_context_create を使用することを検討してください。
12 *
13 * @param string $hostname 接続先のホスト名 (例: 'www.google.com')
14 * @param int $port 接続先のポート番号 (例: 443)
15 * @param float|null $timeout 接続タイムアウト (秒)。null の場合は PHP のデフォルトを使用。
16 * @return string 接続結果のメッセージ
17 */
18function connect_with_pfsockopen_ssl(
19    string $hostname,
20    int $port,
21    ?float $timeout = null
22): string {
23    $error_code = null;
24    $error_message = null;
25
26    // pfsockopen は永続的なソケット接続を確立します。
27    // 'ssl://' プレフィックスで SSL/TLS 接続を試みます。
28    // この関数はSSLコンテキストを直接受け取らないため、検証はPHPのデフォルト設定に従います。
29    $fp = pfsockopen(
30        'ssl://' . $hostname,
31        $port,
32        $error_code,
33        $error_message,
34        $timeout ?? ini_get("default_socket_timeout")
35    );
36
37    if (!$fp) {
38        return "接続エラー ({$error_code}): {$error_message}";
39    }
40
41    // 接続成功。ここでは簡単なHTTP GETリクエストを送信する例を示します。
42    $request = "GET / HTTP/1.1\r\n";
43    $request .= "Host: {$hostname}\r\n";
44    $request .= "Connection: Close\r\n\r\n";
45
46    fwrite($fp, $request);
47
48    $response = '';
49    // サーバーからの応答を読み込みます。
50    while (!feof($fp)) {
51        $response .= fgets($fp, 1024);
52    }
53
54    // pfsockopen は永続接続を確立するため、通常は明示的に閉じませんが、
55    // このサンプルではリソースの解放を明確にするために fclose() を使用します。
56    // PHPプロセスがアクティブな間は、接続が再利用される可能性があります。
57    fclose($fp);
58
59    return "接続成功。受信データの一部:\n" . substr($response, 0, 500) . "...";
60}
61
62// 単体で動作可能なコードとして呼び出し例
63// HTTPS (SSL/TLS) ポート 443 で動作するウェブサイトに接続します。
64$target_host = 'www.google.com';
65$target_port = 443;
66$connection_result = connect_with_pfsockopen_ssl($target_host, $target_port, 5);
67echo $connection_result . PHP_EOL;

pfsockopen関数は、指定されたホストとポートに対し、永続的なソケット接続を確立するために使用されるPHPの関数です。このサンプルコードは、pfsockopenを利用してSSL/TLS接続を試みる方法を示しています。

引数としては、接続先のホスト名を文字列で指定する$hostname、接続ポート番号を整数で指定する$port、そして接続試行の最大時間を秒単位で指定する$timeoutを受け取ります。pfsockopen関数自体は、接続が成功すればソケットリソースを、失敗すればfalseを返しますが、サンプルコードのラッパー関数は接続結果を示すメッセージを文字列で返します。

このコードでは、$hostnameの前にssl://プレフィックスを付けてpfsockopenを呼び出すことで、SSL/TLSを利用したHTTPS接続を試みています。しかし、pfsockopen関数自体にはSSL証明書の検証を直接無効にする引数は提供されていません。そのため、接続時のSSL検証はPHPのデフォルト設定に従って行われます。もしSSL検証を詳細に制御したり、明示的に無効にしたりしたい場合は、stream_socket_client関数とstream_context_create関数を組み合わせて使用することを検討してください。

接続が確立されると、このサンプルでは簡単なHTTP GETリクエストを送信し、サーバーからの応答を読み込んでいます。pfsockopenによる接続はPHPプロセスの終了まで維持される永続的なものですが、このサンプルではリソースを明確にするためにfclose()で閉じています。