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

Copy
1<?php
2
3/**
4 * CURLMOPT_MAX_HOST_CONNECTIONS の使用例をデモンストレーションします。
5 *
6 * この関数は、cURLマルチハンドラを使用して複数のHTTPリクエストを並行して実行し、
7 * CURLMOPT_MAX_HOST_CONNECTIONS オプションがいかに単一ホストへの同時接続数を
8 * 制限するかを示します。関連オプションとして CURLMOPT_MAX_TOTAL_CONNECTIONS
9 * も設定していますが、この例ではホストごとの制限が主なポイントです。
10 *
11 * システムエンジニアを目指す初心者の方へ：
12 * cURLマルチハンドラは、複数のネットワークリクエストを効率的に並行処理するための
13 * 強力なツールです。このオプションは、特定のウェブサイト（ホスト）へのリクエストが
14 * 多すぎると、サーバーに負担をかけたり、ブロックされたりするのを防ぐのに役立ちます。
15 */
16function demonstrateCurlMultiHostConnections(): void
17{
18    // 1. cURLマルチハンドラを初期化します。
19    //    これは複数のcURLリクエストを同時に管理するための親ハンドラです。
20    $mh = curl_multi_init();
21
22    // 2. マルチハンドラのオプションを設定します。
23    //    CURLMOPT_MAX_HOST_CONNECTIONS は、同じホスト (例: httpbin.org) への
24    //    同時アクティブ接続の最大数を制限します。
25    //    この例では、httpbin.orgへの接続が同時に2つまでしか許可されません。
26    curl_multi_setopt($mh, CURLMOPT_MAX_HOST_CONNECTIONS, 2);
27
28    //    CURLMOPT_MAX_TOTAL_CONNECTIONS は、マルチハンドラ全体で管理する
29    //    全接続の総数を制限します。この例では5つですが、
30    //    CURLMOPT_MAX_HOST_CONNECTIONS の方がより厳しい制限となります。
31    //    (キーワード: curlmopt_max_total_connections)
32    curl_multi_setopt($mh, CURLMOPT_MAX_TOTAL_CONNECTIONS, 5);
33
34    // 3. 実行する複数のURLを定義します。
35    //    httpbin.org はテスト用のHTTPサービスで、/delay/{秒数} で応答を遅延させることができます。
36    $urls = [
37        'https://httpbin.org/delay/1?id=1', // 約1秒遅延
38        'https://httpbin.org/delay/1?id=2', // 約1秒遅延
39        'https://httpbin.org/delay/2?id=3', // 約2秒遅延
40        'https://httpbin.org/delay/0.5?id=4', // 約0.5秒遅延
41        'https://httpbin.org/delay/1.5?id=5', // 約1.5秒遅延
42    ];
43
44    $chHandles = []; // 個々のcURLハンドラを格納する配列
45    echo "--- リクエスト準備開始 ---\n";
46    foreach ($urls as $index => $url) {
47        // 4. 各URLに対する個別のcURLハンドラを初期化します。
48        $ch = curl_init();
49        curl_setopt($ch, CURLOPT_URL, $url);
50        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // 応答を文字列で返す
51        curl_setopt($ch, CURLOPT_HEADER, false);       // 応答ヘッダーを含めない
52
53        // 注: HTTPSサイトへの接続で証明書検証エラーが発生する場合、
54        // 開発・テスト目的で一時的に無効にすることがありますが、
55        // 本番環境ではセキュリティのため、これらのオプションは有効にすることを強く推奨します。
56        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); 
57        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
58
59        // 5. 個別のcURLハンドラをマルチハンドラに追加します。
60        curl_multi_add_handle($mh, $ch);
61        $chHandles[$index] = $ch;
62        echo "  URL {$url} をキューに追加しました。\n";
63    }
64    echo "--- リクエスト準備完了 ---\n\n";
65
66    echo "--- リクエスト処理開始 ---\n";
67    $active = null; // アクティブな接続数を追跡する変数
68    // すべてのリクエストが完了するまでループ
69    do {
70        // 6. cURLマルチハンドラを実行します。
71        //    これによって、利用可能な接続が同時に処理されます。
72        //    CURLMOPT_MAX_HOST_CONNECTIONS の設定により、httpbin.orgへの同時接続数は2に制限されます。
73        $mrc = curl_multi_exec($mh, $active);
74
75        // イベントが発生するまで待機します。
76        // これにより、CPU負荷を軽減しつつ、完了したリクエストや新しいリクエストの開始を効率的に処理できます。
77        if ($active > 0) { // アクティブなハンドルがある場合のみ待機
78            // curl_multi_selectはファイルディスクリプタの変更を監視し、イベント発生まで待機します。
79            // タイムアウトを設けることで、無限ループを防ぎます。
80            if (curl_multi_select($mh, 1.0) == -1) { // 最大1秒待機
81                // エラーまたは待機するものがない場合、短いスリープでCPU負荷を軽減
82                usleep(100); 
83            }
84        }
85    } while ($active > 0 && $mrc == CURLM_OK); // アクティブな接続があり、エラーがない間は続行
86
87    echo "--- リクエスト処理終了 ---\n\n";
88
89    // 7. 各リクエストの結果を取得し、後処理を行います。
90    foreach ($chHandles as $index => $ch) {
91        $info = curl_getinfo($ch); // リクエストの情報を取得
92        $response = curl_multi_getcontent($ch); // 応答ボディを取得
93        $error = curl_error($ch); // エラーメッセージを取得
94
95        if ($error) {
96            echo "  エラー: URL {$urls[$index]} でエラーが発生しました: {$error}\n";
97        } else {
98            echo "  成功: URL {$urls[$index]} (総応答時間: {$info['total_time']}秒) の応答:\n";
99            // デモンストレーションのため、応答の一部のみ表示
100            $responseData = json_decode($response, true);
101            echo "    ID: " . ($responseData['args']['id'] ?? 'N/A') . ", 遅延設定: " . ($responseData['delay'] ?? 'N/A') . "秒\n";
102        }
103
104        // 個別のcURLハンドラをマルチハンドラから削除します。
105        curl_multi_remove_handle($mh, $ch);
106        // 個別のcURLハンドラを閉じます。
107        curl_close($ch);
108    }
109
110    // 8. マルチハンドラを閉じます。
111    curl_multi_close($mh);
112
113    echo "\nデモンストレーションが完了しました。\n";
114}
115
116// 関数を実行します。
117demonstrateCurlMultiHostConnections();

CURLMOPT_MAX_HOST_CONNECTIONSは、PHPのcURL拡張機能で利用される定数の一つです。この定数は、cURLマルチハンドラを使用して複数のネットワークリクエストを並行処理する際に、特定の単一ホストに対して同時に確立できる接続の最大数を制限するために使用されます。この設定により、例えば、同じウェブサイトへのリクエストが一度に集中しすぎて、対象サーバーに過度な負担をかけたり、一時的にアクセスをブロックされたりするのを防ぐことができます。

サンプルコードでは、curl_multi_setopt関数を用いてCURLMOPT_MAX_HOST_CONNECTIONSを「2」に設定しています。これにより、httpbin.orgのような単一のホストに対しては、同時に最大2つのリクエストしかアクティブにならないよう制御され、それ以上のリクエストは待機状態となります。この定数自体には引数や戻り値はありませんが、curl_multi_setopt関数の第二引数として渡すことで、その値を設定します。

関連する定数としてCURLMOPT_MAX_TOTAL_CONNECTIONSがありますが、これはcURLマルチハンドラ全体で管理する接続の総数を制限するものです。CURLMOPT_MAX_HOST_CONNECTIONSは、その全体数の中から、さらにホストごとの具体的な上限を設ける、より詳細な制御を提供する定数です。システムエンジニアを目指す方にとって、外部サービスとの効率的かつ丁寧な通信は重要な技術の一つです。

Copy
1<?php
2
3/**
4 * CURLMOPT_MAX_HOST_CONNECTIONS の使用例。
5 *
6 * この定数は、curl_multi_setopt() 関数で使用され、
7 * cURL multi ハンドルが同時に接続できるホストごとの最大接続数を設定します。
8 * これは主に、同じホストへの多数の並行リクエストが、
9 * サーバーまたはネットワークインフラストラクチャに過剰な負荷をかけないようにするために使用されます。
10 *
11 * この例では、CURLMOPT_MAX_HOST_CONNECTIONS オプションの設定方法と、
12 * それを使って複数の cURL リクエストを並行して処理する方法を示します。
13 */
14function demonstrateCurlMultiMaxHostConnections(): void
15{
16    // 1. マルチ cURL ハンドルを初期化します。
17    // これは複数の独立した cURL リクエストを並行して実行するためのコンテナです。
18    $mh = curl_multi_init();
19
20    if ($mh === false) {
21        echo "エラー: curl_multi_init() に失敗しました。\n";
22        return;
23    }
24
25    // 2. CURLMOPT_MAX_HOST_CONNECTIONS オプションを設定します。
26    // この例では、各ホストへの同時接続数を1に制限します。
27    // 例えば、同じホストに対して2つのリクエストがあっても、同時に確立されるTCP接続は1つまでです。
28    // 実際には、環境や要件に応じて適切な値を設定します（例: 5, 10など）。
29    $maxHostConnections = 1; // 各ホストへの同時接続数を1に制限
30    if (!curl_multi_setopt($mh, CURLMOPT_MAX_HOST_CONNECTIONS, $maxHostConnections)) {
31        echo "エラー: CURLMOPT_MAX_HOST_CONNECTIONS ({$maxHostConnections}) の設定に失敗しました。\n";
32        curl_multi_close($mh);
33        return;
34    }
35
36    echo "CURLMOPT_MAX_HOST_CONNECTIONS を {$maxHostConnections} に設定しました。\n\n";
37
38    // 3. 個々の cURL ハンドルを作成し、マルチ cURL ハンドルに追加します。
39    // ここでは、同じホスト (httpbin.org) への2つのリクエストを作成しています。
40    $urls = [
41        'https://httpbin.org/get?item=1', // テスト用の公開API (応答に数ミリ秒かかる)
42        'https://httpbin.org/get?item=2',
43        // 異なるホストを追加する場合、CURLMOPT_MAX_HOST_CONNECTIONS はホストごとに適用されます。
44        // 'https://example.com/',
45    ];
46    $handles = [];
47
48    foreach ($urls as $key => $url) {
49        $ch = curl_init($url);
50        if ($ch === false) {
51            echo "エラー: curl_init() に失敗しました (URL: {$url})\n";
52            continue;
53        }
54        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // サーバーからの応答を文字列で返すように設定
55        curl_setopt($ch, CURLOPT_HEADER, false);       // 応答ヘッダーは含めない
56        curl_setopt($ch, CURLOPT_TIMEOUT, 5);          // タイムアウトを5秒に設定
57        curl_multi_add_handle($mh, $ch);               // マルチ cURL ハンドルに個々の cURL ハンドルを追加
58        $handles[] = $ch;
59        echo "CURL ハンドルを追加しました: " . $url . "\n";
60    }
61
62    if (empty($handles)) {
63        echo "エラー: 追加する cURL ハンドルがありません。\n";
64        curl_multi_close($mh);
65        return;
66    }
67
68    // 4. cURL リクエストを並行して実行します。
69    // すべてのリクエストが完了するか、エラーが発生するまでループします。
70    $running = null; // 実行中のハンドルの数
71    do {
72        // cURL イベントを処理し、ブロックせずに待機します。
73        // $running にはまだ実行中のハンドルの数が設定されます。
74        $status = curl_multi_exec($mh, $running);
75
76        // まだ実行中のハンドルがある場合、ソケットアクティビティを待機します。
77        // これにより、CPU使用率を抑えつつ、I/Oイベントを効率的に待ちます。
78        if ($status === CURLM_OK && $running > 0) {
79            // 最大1秒間、ソケットアクティビティを待機します。
80            curl_multi_select($mh, 1.0);
81        }
82    } while ($running > 0 && $status === CURLM_OK);
83
84    if ($status !== CURLM_OK) {
85        echo "エラー: curl_multi_exec() の実行中に問題が発生しました。 エラーコード: " . $status . "\n";
86    }
87
88    // 5. 各リクエストの結果を取得し、cURL ハンドルをクリーンアップします。
89    foreach ($handles as $ch) {
90        $info = curl_getinfo($ch);    // リクエストに関する詳細情報を取得
91        $content = curl_multi_getcontent($ch); // サーバーからの応答内容を取得
92        $error = curl_error($ch);     // エラーメッセージを取得
93
94        echo "\n--- リクエスト結果 ({$info['url']}) ---\n";
95        if ($error) {
96            echo "エラー: " . $error . "\n";
97        } else {
98            echo "HTTP コード: " . $info['http_code'] . "\n";
99            echo "コンテンツの長さ: " . strlen($content) . " バイト\n";
100            // 必要であれば、コンテンツの一部を表示できます。
101            // echo "コンテンツ: " . substr($content, 0, 100) . "...\n";
102        }
103        curl_multi_remove_handle($mh, $ch); // マルチ cURL ハンドルから個々の cURL ハンドルを削除
104        curl_close($ch);                     // 個々の cURL ハンドルをクローズ
105    }
106
107    // 6. マルチ cURL ハンドルをクローズし、リソースを解放します。
108    curl_multi_close($mh);
109    echo "\nすべての cURL ハンドルをクリーンアップしました。\n";
110}
111
112// 関数の実行
113demonstrateCurlMultiMaxHostConnections();
114
115?>

CURLMOPT_MAX_HOST_CONNECTIONS は PHP の cURL 拡張機能で利用される定数で、複数の cURL リクエストを同時に扱う際に使用するマルチ cURL ハンドルに対して、各ホストへの最大同時接続数を設定するために用いられます。この定数自体は引数や戻り値を持たず、curl_multi_setopt() 関数にオプションとして渡すことでその値を設定します。

提供されたサンプルコードでは、まず curl_multi_init() でマルチ cURL ハンドルを初期化し、複数のリクエストを並行して管理する準備をしています。次に、curl_multi_setopt() 関数を使って CURLMOPT_MAX_HOST_CONNECTIONS を設定しています。この例では値を「1」に設定しており、これにより、同じホストに対して同時に確立できるネットワーク接続が1つに制限されます。例えば、同じサーバーへの複数のリクエストがあったとしても、1つの接続が完了するか、他の接続が利用可能になるまで、次の接続は待機することになります。

その後、同じホストへの複数の cURL リクエストを作成し、マルチハンドルに追加しています。curl_multi_exec() を用いてこれらのリクエストを並行実行しますが、設定した CURLMOPT_MAX_HOST_CONNECTIONS の効果により、同じホストへの接続は同時に1つだけがアクティブになります。これにより、特定のサーバーに対して過度な負荷がかかるのを防ぎ、ネットワークやサーバーリソースを効率的に管理できます。最後に、各リクエストの結果を取得し、使用した cURL リソースを適切に解放しています。この定数は、多数の外部サービスへのリクエストを安定して実行したい場合に役立ちます。