Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

CURLMOPT_PUSHFUNCTION定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

CURLMOPT_PUSHFUNCTION定数は、PHPのcURL拡張機能において、HTTP/2プロトコルにおけるServer Push機能に関連する設定を行うための定数です。この定数は、複数のcURL転送を並行して管理する際に使用するマルチハンドル(curl_multi_*系の関数)に対して、オプションを設定するcurl_multi_setopt関数で使用されます。特に、ウェブサーバーがクライアントからのリクエストを待つことなく、将来必要になると予測されるリソースを先行してプッシュ送信してきた際に、そのプッシュされた転送をどのように処理するかを決定するためのコールバック関数を指定するために用いられます。

この定数を用いてコールバック関数を設定すると、Server Pushイベントが発生した際に、開発者が定義したPHP関数が自動的に呼び出されます。このコールバック関数は、プッシュされたリソースの転送を受け入れるか、あるいは拒否するかをプログラマブルに判断する役割を担います。具体的には、コールバック関数は、元の転送を管理しているcURLハンドル、新しくプッシュされた転送を管理するcURLハンドル、そしてユーザーがオプション設定時に渡した任意のデータという3つの引数を受け取ります。コールバック関数がCURL_PUSHDATA_OKを返すと、プッシュされた転送が続行され、CURL_PUSHDATA_NOを返すと、そのプッシュはキャンセルされて転送は行われません。

このように、CURLMOPT_PUSHFUNCTION定数は、HTTP/2環境下でServer Pushを効率的に制御し、アプリケーションのパフォーマンスを最適化するために不可欠な機能を提供します。不要なリソースの転送を拒否することで、ネットワークリソースの無駄を省き、セキュリティ面でのリスクも軽減できるため、このオプションの適切な利用は、より堅牢で効率的なウェブアプリケーションの構築に貢献します。ただし、Server PushはHTTP/2でのみ有効な機能であり、それ以外のプロトコルや対応していない環境ではこのオプションは効果を発揮しない点にご注意ください。

構文(syntax)

1<?php
2curl_multi_setopt(
3    $curl_multi_handle,
4    CURLMOPT_PUSHFUNCTION,
5    function (
6        $parent_ch,
7        $new_ch,
8        $request_len,
9        $request_body,
10        $request_headers
11    ): int {
12        // ... HTTP/2 Push ストリームの処理ロジック ...
13        return 1; // 1: プッシュを受け入れる, 0: 拒否する
14    }
15);

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHP curl_opt PUSHコールバック設定

1<?php
2
3/**
4 * HTTP/2 PUSHリクエストを処理するためのコールバック関数。
5 *
6 * この関数は、HTTP/2対応サーバーがPUSHリクエスト(サーバーがクライアントの要求なしに
7 * リソースを送信する機能)を送信してきたときに、libcurlによって呼び出されます。
8 *
9 * @param resource $parent_ch 親となるcURLハンドル(元のリクエスト)
10 * @param resource $pushed_ch PUSHされたリクエストのcURLハンドル
11 * @param int $num_headers PUSHされたリクエストのヘッダー数
12 * @param array $headers PUSHされたリクエストのヘッダーの配列
13 * @return int PUSHリクエストを受け入れる場合は CURL_PUSH_OK、拒否する場合は CURL_PUSH_DENY
14 */
15function handlePushRequest($parent_ch, $pushed_ch, $num_headers, $headers): int
16{
17    echo "--- PUSH リクエストが検出されました ---" . PHP_EOL;
18    echo "親ハンドルのID: " . (int)$parent_ch . PHP_EOL;
19    echo "PUSHされたハンドルのID: " . (int)$pushed_ch . PHP_EOL;
20    echo "ヘッダー数: " . $num_headers . PHP_EOL;
21    echo "受信したヘッダー:" . PHP_EOL;
22    foreach ($headers as $header) {
23        echo "  - " . $header . PHP_EOL;
24    }
25
26    // ここでPUSHされたリソースに対する追加の処理を記述できます。
27    // 例: リソースをダウンロードする、キャッシュに入れる、など。
28    // この例では、PUSHされたリソースを受け入れます。
29    return CURL_PUSH_OK;
30}
31
32// cURLマルチハンドラを初期化します。
33// これにより、複数のcURLリクエストを並行して処理できるようになります。
34$mh = curl_multi_init();
35
36// CURLMOPT_PUSHFUNCTION オプションを設定し、上記で定義したコールバック関数を登録します。
37// このオプションは、HTTP/2サーバーからのPUSHリクエストをアプリケーションが
38// プログラムで制御できるようにするために使用されます。
39if (curl_multi_setopt($mh, CURLMOPT_PUSHFUNCTION, 'handlePushRequest')) {
40    echo "CURLMOPT_PUSHFUNCTION が正常に設定されました。" . PHP_EOL;
41} else {
42    // オプション設定に失敗した場合のエラー処理
43    echo "CURLMOPT_PUSHFUNCTION の設定に失敗しました: " . curl_multi_strerror(curl_multi_errno($mh)) . PHP_EOL;
44    curl_multi_close($mh);
45    exit(1);
46}
47
48// 注意: このサンプルコードでは、実際にHTTP/2 PUSHを発生させるサーバーへのリクエストは行いません。
49// そのため、上記の handlePushRequest 関数は通常実行では呼び出されません。
50// このコードは、CURLMOPT_PUSHFUNCTION の設定方法と、そのコールバック関数の形式を示すことが目的です。
51//
52// 実際にPUSHリクエストをテストするには、HTTP/2 PUSHに対応したサーバーと
53// curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_2_0);
54// を設定したcURLハンドルを追加し、curl_multi_exec を実行する必要があります。
55
56// マルチハンドラを閉じます。
57curl_multi_close($mh);
58
59echo "プログラムは終了しました。" . PHP_EOL;
60echo "(PUSHリクエストの検出には、HTTP/2 PUSHに対応したサーバーとの通信が必要です)" . PHP_EOL;
61
62?>

PHPのCURLMOPT_PUSHFUNCTIONは、cURL Multiインターフェースで使用される定数で、HTTP/2サーバーからのプッシュリクエストをプログラムで処理するためのコールバック関数を登録する際に利用されます。HTTP/2プッシュとは、サーバーがクライアントからの明示的な要求なしに、関連するリソースを事前に送信する機能です。

サンプルコードでは、まずhandlePushRequestというコールバック関数を定義しています。この関数は、サーバーからプッシュリクエストが来るとcURLによって自動的に呼び出されます。引数として、元のリクエストの親となるcURLハンドル、プッシュされたリクエストの専用cURLハンドル、そのヘッダー数、そしてヘッダーの配列を受け取ります。この関数は、プッシュリクエストを受け入れる場合はCURL_PUSH_OK、拒否する場合はCURL_PUSH_DENYという整数値を戻り値として返します。

次に、curl_multi_init()でcURLマルチハンドラを初期化し、curl_multi_setopt()関数を使ってCURLMOPT_PUSHFUNCTIONオプションに先ほどのhandlePushRequest関数名を設定しています。これにより、アプリケーションはHTTP/2プッシュリクエストの受信をプログラムで制御できるようになります。このコードはオプションの設定方法を示すものであり、実際にプッシュリクエストをテストするには、HTTP/2プッシュに対応したサーバーとの通信環境が必要です。

このサンプルコードは、HTTP/2のサーバープッシュをアプリケーションで処理するための設定方法を示しています。CURLMOPT_PUSHFUNCTIONはcurl_multi_setoptに設定するオプションであり、通常のcurl_setoptとは異なります。コールバック関数handlePushRequestが実際に呼び出されるには、HTTP/2対応サーバーへのリクエストと、cURLハンドルのHTTPバージョンをCURL_HTTP_VERSION_2_0以上に設定する必要があります。サンプルコード単体ではPUSHリクエストは発生しないため、この関数は実行されません。PUSHされたリソースを受け入れるか拒否するかは、コールバック関数の戻り値でCURL_PUSH_OKまたはCURL_PUSH_DENYを返して制御します。セキュリティやリソース消費を考慮し、不要なPUSHは拒否することも重要です。curl_multi_setoptの戻り値を常に確認し、設定エラーへの対処も忘れないでください。

PHP: CURLMOPT_PUSHFUNCTION でHTTP/2 Pushコールバックを設定する

1<?php
2
3/**
4 * CURLMOPT_PUSHFUNCTION 定数の使用例を示します。
5 * この定数は、cURLマルチハンドルにおいてHTTP/2 Pushストリームを受信した際に
6 * 呼び出されるコールバック関数を設定するために使用されます。
7 *
8 * システムエンジニアを目指す初心者の方へ:
9 * HTTP/2 Pushは、サーバーがクライアントのリクエストに応答する際に、
10 * クライアントが今後必要とするであろう他のリソース(例:CSS、JavaScriptファイル)を
11 * 事前に送るメカニズムです。これにより、クライアントはそれらのリソースを
12 * 個別にリクエストする必要がなくなり、Webサイトの表示速度が向上する可能性があります。
13 *
14 * 注意: このサンプルコードはCURLMOPT_PUSHFUNCTIONの設定方法を示していますが、
15 * 実際にHTTP/2 Pushを受信してコールバック関数が実行されるには、
16 * アクセス先のWebサーバーがHTTP/2 Pushに対応している必要があります。
17 * `https://www.example.com` は通常HTTP/2 Pushを提供しないため、
18 * このコードを実行しても `Push stream received!` のメッセージは表示されない可能性が高いです。
19 */
20function demonstrateCurlPushFunction(): void
21{
22    echo "CURLMOPT_PUSHFUNCTIONのデモンストレーションを開始します。\n";
23
24    // 1. cURLマルチハンドルを初期化
25    // 複数のcURLリクエストを並行して処理するために使用します。
26    $mh = curl_multi_init();
27
28    // 2. HTTP/2 Pushストリームを受信した際に呼び出されるコールバック関数を定義
29    // この関数は、サーバーが新しいPushストリームを開始したときにcURLによって自動的に呼び出されます。
30    // 引数:
31    //   $parent_ch: 親リクエストのcURLイージーハンドル
32    //   $pushed_ch: PUSHされた新しいリクエストのcURLイージーハンドル
33    //   $num_headers: PUSHされたリクエストのHTTPヘッダーの数
34    //   $headers: PUSHされたリクエストのHTTPヘッダーの配列
35    // 戻り値:
36    //   true を返すとPushストリームを受け入れ、処理を続行します。
37    //   false を返すとPushストリームを拒否します。
38    $pushCallback = function ($parent_ch, $pushed_ch, $num_headers, $headers) {
39        echo "\n[PUSH CALLBACK] Push stream received!\n";
40        echo "[PUSH CALLBACK] 親リクエストのハンドルID: " . (int)$parent_ch . "\n";
41        echo "[PUSH CALLBACK] PUSHされた新しいリクエストのハンドルID: " . (int)$pushed_ch . "\n";
42        echo "[PUSH CALLBACK] ヘッダー数: " . $num_headers . "\n";
43        echo "[PUSH CALLBACK] PUSHヘッダー:\n";
44        foreach ($headers as $header) {
45            echo "[PUSH CALLBACK]   - " . $header . "\n";
46        }
47
48        // PUSHされたリクエストに対して、さらにcURLオプションを設定することも可能です。
49        // 例: curl_setopt($pushed_ch, CURLOPT_RETURNTRANSFER, true);
50
51        // この例ではPushストリームを受け入れます。
52        return true;
53    };
54
55    // 3. CURLMOPT_PUSHFUNCTION オプションを設定
56    // cURLマルチハンドルに、上記のコールバック関数を登録します。
57    // これにより、HTTP/2 Pushイベントが発生したときに `$pushCallback` が実行されます。
58    curl_multi_setopt($mh, CURLMOPT_PUSHFUNCTION, $pushCallback);
59
60    // 4. 親となるcURLイージーハンドルを初期化
61    // このリクエストに対して、サーバーがHTTP/2 Pushを行う可能性があります。
62    $ch = curl_init('https://www.example.com'); // HTTP/2 PushをサポートするサーバーのURLに置き換えることができます。
63    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // レスポンスを文字列として取得
64    curl_setopt($ch, CURLOPT_HEADER, false);       // レスポンスヘッダーを含めない
65
66    // HTTP/2プロトコルを使用することを明示的に指定
67    // cURLが古いバージョンの場合、デフォルトではHTTP/1.1を使用することがあります。
68    curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_2_0);
69
70    // SSL証明書の検証設定 (開発/テスト環境でのみ、本番環境では通常 true に設定)
71    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
72    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
73
74    // 5. イージーハンドルをマルチハンドルに追加
75    curl_multi_add_handle($mh, $ch);
76
77    // 6. cURLリクエストを実行
78    // キーワード `curlm_call_multi_perform` は PHP の `curl_multi_exec` を指していると解釈します。
79    // アクティブな転送がなくなるまでループし、処理を進めます。
80    $running = null;
81    do {
82        // cURLリクエストを実行し、進行状況をチェック
83        // $running にはまだ処理中のハンドルの数が設定されます。
84        $status = curl_multi_exec($mh, $running);
85
86        // アクティブな転送がある場合、イベントの発生を待ちます
87        if ($running) {
88            // curl_multi_select は、cURL操作のファイル記述子が読み取り可能または書き込み可能になるまで待機します。
89            //これにより、CPUを効率的に利用できます。
90            curl_multi_select($mh);
91        }
92
93    } while ($running && $status == CURLM_OK); // 処理中のハンドルがあり、かつエラーがない間はループを続行
94
95    // 7. エラー処理
96    if ($status != CURLM_OK) {
97        echo "\ncURL Multi Error: " . curl_multi_strerror($status) . "\n";
98    }
99
100    // 8. 完了した各ハンドルの結果を取得
101    while ($info = curl_multi_info_read($mh)) {
102        if ($info['msg'] == CURLMSG_DONE) {
103            $completed_handle = $info['handle'];
104            $http_code = curl_getinfo($completed_handle, CURLINFO_HTTP_CODE);
105            $response_content = curl_multi_getcontent($completed_handle);
106
107            echo "\nリクエスト完了 (ハンドルID: " . (int)$completed_handle . ")\n";
108            echo "HTTPステータスコード: " . $http_code . "\n";
109            echo "レスポンス内容 (抜粋):\n" . substr($response_content, 0, 200) . "...\n"; // レスポンスの先頭200文字を表示
110
111            // 完了したハンドルをマルチハンドルから削除し、クローズ
112            curl_multi_remove_handle($mh, $completed_handle);
113            curl_close($completed_handle);
114        }
115    }
116
117    // 9. cURLマルチハンドルをクローズし、リソースを解放
118    curl_multi_close($mh);
119
120    echo "\nCURLMOPT_PUSHFUNCTIONのデモンストレーションを終了しました。\n";
121}
122
123// 上記のデモンストレーション関数を実行
124demonstrateCurlPushFunction();
125

PHPのCURLMOPT_PUSHFUNCTIONは、cURLマルチハンドルにおいてHTTP/2のサーバープッシュ機能を利用する際に設定する定数です。HTTP/2プッシュとは、ウェブサーバーがクライアントからのリクエストに対して、将来必要となるであろう関連リソース(例: スタイルシートやJavaScriptファイル)を先読みして、クライアントが明示的に要求する前に送信することで、ウェブサイトの表示速度を向上させる仕組みです。

この定数には、サーバーからHTTP/2プッシュストリームを受信した際に実行されるコールバック関数を設定します。サンプルコードでは、$pushCallbackという関数を定義し、それをcurl_multi_setoptを使ってCURLMOPT_PUSHFUNCTIONに登録しています。

コールバック関数は、親リクエストのcURLイージーハンドル、プッシュされた新しいリクエストのcURLイージーハンドル、プッシュされたリクエストのHTTPヘッダー数とその配列を引数として受け取ります。この関数がtrueを返すとプッシュストリームを受け入れて処理を続行し、falseを返すとプッシュを拒否します。

設定後、curl_multi_execなどを用いて複数のcURLリクエストを並行して実行する中で、サーバーからHTTP/2プッシュが発生すると、登録したコールバック関数が自動的に呼び出されます。ただし、実際にこの機能が動作するには、アクセス先のウェブサーバーがHTTP/2プッシュに対応している必要があります。

このサンプルコードは、アクセス先のサーバーがHTTP/2 Pushに対応していることと、CURLOPT_HTTP_VERSIONオプションでHTTP/2を明示的に指定することが必須です。これらが満たされない場合、プッシュ機能は動作しません。特に本番環境で利用する際は、開発・テスト目的で無効化されているCURLOPT_SSL_VERIFYPEERやCURLOPT_SSL_VERIFYHOSTといったSSL証明書の検証を必ず有効に戻し、セキュリティを確保してください。CURLMOPT_PUSHFUNCTIONに設定するコールバック関数は、Pushストリームを受け入れる場合はtrueを、拒否する場合はfalseを返します。また、処理後はcurl_multi_closeなどで使用したcURLリソースを忘れずに解放することが重要です。提示されたキーワードcurlm_call_multi_performは、PHPでは主にcurl_multi_exec関数に対応します。

関連コンテンツ

関連IT用語

関連プログラミング言語