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

Copy
1<?php
2
3/**
4 * 指定されたURLにUNIXソケット経由でHTTPリクエストを送信し、レスポンスを取得します。
5 *
6 * この関数はCURLOPT_UNIX_SOCKET_PATHを使用して、HTTPリクエストが
7 * 指定されたUNIXソケットを経由するように設定する方法を示します。
8 * 実際のリクエストが成功するには、指定されたUNIXソケットが有効であり、
9 * そのソケットでHTTPサーバーがリッスンしている必要があります。
10 *
11 * @param string $url UNIXソケット経由でアクセスするターゲットURL (例: 'http://localhost/').
12 * @param string $unixSocketPath 使用するUNIXソケットファイルのパス (例: '/tmp/my_app.sock').
13 * @return string|false 成功した場合はHTTPレスポンスの文字列、失敗した場合は false。
14 */
15function makeHttpRequestViaUnixSocket(string $url, string $unixSocketPath): string|false
16{
17    // cURLセッションを初期化します。
18    $ch = curl_init();
19
20    if ($ch === false) {
21        echo 'Error: Failed to initialize cURL session.' . PHP_EOL;
22        return false;
23    }
24
25    // cURLオプションを設定します。
26
27    // アクセス先のURLを設定します。
28    curl_setopt($ch, CURLOPT_URL, $url);
29
30    // HTTPリクエストをUNIXソケット経由で送信するように設定します。
31    // ここでCURLOPT_UNIX_SOCKET_PATHを使用し、ソケットファイルのパスを指定します。
32    curl_setopt($ch, CURLOPT_UNIX_SOCKET_PATH, $unixSocketPath);
33
34    // レスポンスデータを文字列として取得するように設定します。
35    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
36
37    // HTTPリクエストを実行し、結果を取得します。
38    $response = curl_exec($ch);
39
40    // cURLエラーがあるかチェックします。
41    if (curl_errno($ch)) {
42        echo 'cURL Error: ' . curl_error($ch) . PHP_EOL;
43        $response = false;
44    }
45
46    // cURLセッションを閉じます。
47    curl_close($ch);
48
49    return $response;
50}
51
52// --- 使用例 ---
53// 実際のUNIXソケットが存在しない場合、このリクエストは失敗します。
54// 例: NginxやPHP-FPMがUNIXソケットでリッスンしている場合に利用されます。
55$targetUrl = 'http://localhost/';        // UNIXソケット経由でアクセスする論理的なURL
56$socketPath = '/tmp/example_app.sock'; // 仮のUNIXソケットパス
57
58echo "Attempting to make HTTP request to '{$targetUrl}' via UNIX socket '{$socketPath}'..." . PHP_EOL;
59
60$httpResponse = makeHttpRequestViaUnixSocket($targetUrl, $socketPath);
61
62if ($httpResponse !== false) {
63    echo "Request successful. Received response (first 200 chars):" . PHP_EOL;
64    echo substr($httpResponse, 0, 200) . '...' . PHP_EOL;
65} else {
66    echo "Request failed. Please ensure the UNIX socket '{$socketPath}' exists and a server is listening on it." . PHP_EOL;
67}
68
69?>

このPHPサンプルコードは、CURLOPT_UNIX_SOCKET_PATH定数を用いて、HTTPリクエストをUNIXソケット経由で送信する方法を示しています。通常、Webリクエストはネットワーク（TCP/IP）を通じて行われますが、UNIXソケットを利用すると、同一システム内のプロセス間でより効率的かつ安全に通信を行うことができます。

コードでは、まずcurl_init()でcURLセッションを開始します。次に、curl_setopt()関数を使って様々なオプションを設定します。CURLOPT_URLオプションにはアクセスしたいURLを設定し、その後のCURLOPT_UNIX_SOCKET_PATHオプションで、実際に通信に利用するUNIXソケットファイルのパス（例: /tmp/my_app.sock）を指定します。これにより、cURLは通常のネットワーク接続ではなく、指定されたUNIXソケットファイルを通じてリクエストを送信するようになります。CURLOPT_RETURNTRANSFERオプションは、サーバーからのレスポンスを関数が文字列として返すように設定しています。

設定後、curl_exec()でHTTPリクエストを実行し、その結果を取得します。リクエスト中にエラーが発生した場合はcurl_errno()で確認し、最後にcurl_close()でcURLセッションを閉じます。

このサンプルコードに含まれるmakeHttpRequestViaUnixSocket関数は、$url（アクセス先の論理的なURL）と$unixSocketPath（UNIXソケットファイルのパス）の二つの引数を受け取ります。成功した場合はHTTPレスポンスの文字列を返し、失敗した場合はfalseを返します。このコードが実際に機能するためには、指定されたUNIXソケットファイルが存在し、そのソケットでHTTPサーバー（例えばNginxやPHP-FPMなど）がリクエストを待ち受けている必要があります。

Copy
1<?php
2
3/**
4 * cURLを使ってUnixドメインソケット経由での接続と接続タイムアウトを設定する例を示します。
5 *
6 * システムエンジニアを目指す初心者の方へ：
7 * このコードは、通常のネットワーク接続（TCP/IP）ではなく、
8 * 同じサーバー上の別のプロセス（例：WebサーバーのNginxなど）と
9 * Unixドメインソケットという特殊なファイルを通じて通信する方法を示しています。
10 * また、接続が指定された時間内に完了しない場合に処理を中断する「接続タイムアウト」の設定も行っています。
11 */
12function demonstrateCurlUnixSocketConnection(): void
13{
14    // cURLセッションを初期化します。
15    // これは、HTTPリクエストを送信するための準備段階です。
16    $ch = curl_init();
17
18    // cURLセッションの初期化に失敗した場合の処理。
19    if ($ch === false) {
20        echo "エラー: cURLセッションの初期化に失敗しました。\n";
21        return;
22    }
23
24    // Unixドメインソケットファイルのパスを指定します。
25    // このパスは、実際にサーバー上で通信したいプロセスがリッスンしているソケットファイルのパスである必要があります。
26    // 例: '/var/run/nginx.sock' や '/tmp/my_app.sock' など。
27    // このサンプルコードは実行環境に特定のソケットファイルが存在することを前提としないため、
28    // 実際に動作させる場合は、環境に合わせて適切なパスに書き換える必要があります。
29    $unixSocketPath = '/tmp/example.sock'; // ご自身の環境に合わせてパスを変更してください
30
31    // リクエスト先のURLを設定します。
32    // Unixドメインソケットを使用する場合でも、HTTPリクエストのホストヘッダを正しく設定するためにURLは必要です。
33    // ここでは架空のURLを指定していますが、通信はソケット経由で行われます。
34    $targetUrl = 'http://localhost/api/status';
35
36    // cURLオプションを設定します。
37    // CURLOPT_URL: リクエストを送信するURL。
38    curl_setopt($ch, CURLOPT_URL, $targetUrl);
39
40    // CURLOPT_UNIX_SOCKET_PATH:
41    // このオプションにUnixドメインソケットのパスを設定することで、
42    // cURLは通常のTCP/IP接続ではなく、指定されたソケットファイル経由で接続を試みます。
43    curl_setopt($ch, CURLOPT_UNIX_SOCKET_PATH, $unixSocketPath);
44
45    // CURLOPT_CONNECTTIMEOUT:
46    // 接続タイムアウトを設定します。単位は秒です。
47    // cURLがサーバーへの接続を試みて、この時間内に接続が確立できない場合、
48    // cURLはエラーを発生させて接続を中断します。
49    // ここでは5秒に設定しており、5秒以内に接続できない場合は失敗します。
50    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
51
52    // CURLOPT_RETURNTRANSFER:
53    // trueに設定すると、curl_exec()が実行結果を文字列として返します。
54    // falseの場合、結果は直接出力されます。
55    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
56
57    // CURLOPT_FAILONERROR:
58    // HTTPステータスコードが400以上の場合にエラーを発生させます。
59    curl_setopt($ch, CURLOPT_FAILONERROR, true);
60
61    echo "Unixドメインソケット ('{$unixSocketPath}') 経由で '{$targetUrl}' への接続を試行中...\n";
62
63    // cURLセッションを実行し、結果を取得します。
64    $response = curl_exec($ch);
65
66    // cURLリクエストの実行中にエラーが発生したか確認します。
67    if (curl_errno($ch)) {
68        // エラーが発生した場合、エラーコードとメッセージを表示します。
69        echo "cURLエラー: " . curl_error($ch) . " (エラーコード: " . curl_errno($ch) . ")\n";
70        // 特に、ソケットファイルが存在しない、または権限がない場合、
71        // CURLE_COULDNT_CONNECT (7) などのエラーが発生することがあります。
72    } else {
73        // リクエストが成功した場合、レスポンスを表示します。
74        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
75        echo "cURLリクエストが成功しました。HTTPステータスコード: {$httpCode}\n";
76        echo "レスポンス:\n" . $response . "\n";
77    }
78
79    // cURLセッションを閉じ、使用したリソースを解放します。
80    curl_close($ch);
81}
82
83// 定義した関数を実行します。
84demonstrateCurlUnixSocketConnection();

このサンプルコードは、PHPのcURL拡張機能を用いて、Unixドメインソケット経由での通信と接続タイムアウトの設定方法を示すものです。

CURLOPT_UNIX_SOCKET_PATHは、cURLのオプションを定義する定数の一つです。この定数を使用すると、通常のTCP/IPネットワーク接続ではなく、ファイルシステム上に存在するUnixドメインソケットファイルを通じて通信するようcURLに指示できます。これは、主に同じサーバー上で動作する異なるプロセス間で効率的に通信する際に利用されます。この定数自体に引数や戻り値はありませんが、curl_setopt()関数の第二引数として指定し、第三引数にはUnixドメインソケットファイルのパスを文字列で渡します。

CURLOPT_CONNECTTIMEOUTもcURLオプションを定義する定数です。この定数を用いることで、cURLがサーバーへの接続を確立しようとする際の最大待機時間を秒単位で設定できます。設定された時間内に接続が完了しない場合、cURLは接続を中断しエラーを返します。この定数自体も引数や戻り値はありませんが、curl_setopt()の第二引数として指定し、第三引数にはタイムアウト秒数を整数で渡します。

サンプルコードでは、curl_init()でcURLセッションを初期化し、CURLOPT_URLでリクエスト先のURL（主にホストヘッダ用）を設定しています。次に、CURLOPT_UNIX_SOCKET_PATHを用いて通信に使うUnixドメインソケットのパスを、CURLOPT_CONNECTTIMEOUTで接続タイムアウトを5秒にそれぞれ設定しています。これにより、Unixドメインソケットを通じたプロセス間通信の確立に指定時間以上かかった場合に、自動的に処理が中断される堅牢なコードとなります。その後、curl_exec()で実際にリクエストを実行し、成功かエラーかに応じた結果を表示します。最後にcurl_close()でリソースを解放しています。