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

Copy
1<?php
2
3/**
4 * CURLOPT_EXPECT_100_TIMEOUT_MS の使用例を示す関数。
5 *
6 * このオプションは、HTTP POSTリクエストで "Expect: 100-continue" ヘッダを
7 * 使用する場合に、サーバーからの "100 Continue" 応答を待つ最大時間をミリ秒単位で設定します。
8 *
9 * "Expect: 100-continue" ヘッダは、大きなリクエストボディを送信する前に、
10 * サーバーがリクエストを受け入れる準備ができているかを確認するために使用されます。
11 * このタイムアウト時間内にサーバーから "100 Continue" 応答がない場合、
12 * cURLはサーバーの応答を待たずにボディの送信を続行します。
13 */
14function demonstrateCurlExpect100Timeout(): void
15{
16    // cURL セッションを初期化
17    $ch = curl_init();
18
19    // リクエスト先のURLを設定
20    // この例ではダミーのURLを使用しますが、実際のPOSTリクエストを処理できるURLに置き換えてください。
21    $url = "http://example.com"; 
22
23    // POSTリクエストに必要なオプションを設定
24    curl_setopt($ch, CURLOPT_URL, $url);
25    curl_setopt($ch, CURLOPT_POST, true); // POSTリクエストであることを示す
26    
27    // ボディが大きめのデータを送信する場合に "Expect: 100-continue" ヘッダが有効になります。
28    // この例では、1MBのダミーデータを作成しています。
29    $postData = str_repeat('A', 1024 * 1024); // 1MBのダミーデータ
30    curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
31
32    // CURLOPT_EXPECT_100_TIMEOUT_MS を設定
33    // サーバーが "100 Continue" 応答を返すのを待つ最大時間を500ミリ秒に設定します。
34    // この時間内に応答がない場合、cURLはボディの送信を続行します。
35    curl_setopt($ch, CURLOPT_EXPECT_100_TIMEOUT_MS, 500);
36
37    // 戻り値を文字列で取得する設定
38    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
39
40    echo "cURLリクエストを開始します (CURLOPT_EXPECT_100_TIMEOUT_MS を 500ms に設定)。\n";
41    echo "URL: " . $url . "\n";
42    echo "送信するデータサイズ: " . (strlen($postData) / (1024 * 1024)) . "MB\n";
43
44    // cURL リクエストを実行
45    $response = curl_exec($ch);
46
47    // エラーチェック
48    if (curl_errno($ch)) {
49        echo 'cURLエラー: ' . curl_error($ch) . "\n";
50    } else {
51        echo "cURLリクエストが成功しました。\n";
52        // 必要に応じて $response の内容を表示
53        // echo "レスポンスの最初の100文字:\n" . substr($response, 0, 100) . "...\n";
54    }
55
56    // cURL セッションを閉じる
57    curl_close($ch);
58}
59
60// 関数を実行して、CURLOPT_EXPECT_100_TIMEOUT_MS の動作を示します。
61demonstrateCurlExpect100Timeout();
62

CURLOPT_EXPECT_100_TIMEOUT_MSは、PHPのcURL拡張機能で利用される定数です。この定数は、HTTP POSTリクエストにおいて「Expect: 100-continue」ヘッダを使用する際に、サーバーから返される「100 Continue」応答を待つ最大時間をミリ秒単位で指定するために用いられます。「Expect: 100-continue」ヘッダは、特に大量のデータをPOSTする前に、サーバーがそのリクエストを受け入れる準備ができているかを事前に確認するための標準的な仕組みです。

サンプルコードでは、約1MBのダミーデータをPOSTリクエストで送信するケースを想定し、CURLOPT_EXPECT_100_TIMEOUT_MSに500ミリ秒を設定しています。これにより、cURLはサーバーからの「100 Continue」応答を最大500ミリ秒間待ちます。この指定された時間内にサーバーから応答がなかった場合、cURLは「100 Continue」応答を待つことなく、すぐにリクエストボディの送信を開始します。

このオプションを設定することで、ネットワークの遅延やサーバーの応答速度のばらつきによって「100 Continue」応答が遅れる場合でも、cURLが不必要に待機し続けることを防ぎ、リクエスト処理の効率を向上させることができます。この定数自体に引数はなく、curl_setopt関数で設定する値は整数型（ミリ秒）であり、定数自体の値も整数型です。

Copy
1<?php
2
3/**
4 * cURLリクエストでHTTPの「Expect: 100-continue」ヘッダに対するタイムアウトを設定する例。
5 *
6 * この関数は、`CURLOPT_EXPECT_100_TIMEOUT_MS`定数を使用して、
7 * サーバーが「100 Continue」応答を返すのを待つ最大ミリ秒数を設定する方法を示します。
8 * 主に大きなデータをPOSTする際に、「Expect: 100-continue」ヘッダと組み合わせて使用されます。
9 */
10function demonstrateCurlExpect100Timeout(): void
11{
12    // cURLセッションを初期化
13    $ch = curl_init();
14
15    if ($ch === false) {
16        echo "cURL初期化に失敗しました。\n";
17        return;
18    }
19
20    // リクエスト先のURLを設定 (実際の動作確認には有効なPOSTエンドポイントを指定してください)
21    curl_setopt($ch, CURLOPT_URL, 'https://example.com/api/upload');
22
23    // POSTリクエストを有効にする
24    curl_setopt($ch, CURLOPT_POST, true);
25
26    // 送信するデータを設定 (例として小さなデータを使用)
27    // 実際には大きなデータでExpect: 100-continueが意味を持ちます
28    $postData = ['key' => 'value', 'data' => str_repeat('A', 1024 * 10)]; // 10KBのデータ
29
30    // POSTデータをHTTPクエリ形式でエンコード
31    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postData));
32
33    // HTTPヘッダを設定
34    // "Expect: 100-continue" ヘッダを含めることで、cURLはボディ送信前にサーバーからの
35    // "100 Continue" 応答を待ちます。
36    curl_setopt($ch, CURLOPT_HTTPHEADER, [
37        'Content-Type: application/x-www-form-urlencoded',
38        'Expect: 100-continue', // このヘッダが存在する場合に CURLOPT_EXPECT_100_TIMEOUT_MS が有効になります
39    ]);
40
41    // サーバーが「100 Continue」応答を返すのを待つ最大ミリ秒数を設定
42    // ここでは500ミリ秒（0.5秒）に設定しています。
43    // サーバーがこの時間内に応答しない場合、cURLはボディの送信を開始します。
44    // 0に設定すると、この待機は無効になります。
45    curl_setopt($ch, CURLOPT_EXPECT_100_TIMEOUT_MS, 500);
46
47    // 転送結果を文字列として返すように設定
48    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
49
50    // cURLセッションを実行し、応答を取得
51    $response = curl_exec($ch);
52
53    // エラーが発生したかを確認
54    if (curl_errno($ch)) {
55        // エラーコードとエラーメッセージを表示
56        echo 'cURL Error (' . curl_errno($ch) . '): ' . curl_error($ch) . "\n";
57    } else {
58        // 成功した場合、応答を表示
59        echo "cURL Response:\n";
60        echo $response . "\n";
61    }
62
63    // cURLリソースを解放
64    curl_close($ch);
65}
66
67// 関数を実行
68demonstrateCurlExpect100Timeout();

PHPのCURLOPT_EXPECT_100_TIMEOUT_MSは、cURLリクエストでHTTPの「Expect: 100-continue」ヘッダを使用する際に、サーバーからの「100 Continue」応答を待つ最大時間をミリ秒単位で設定するための定数です。この定数自体は引数を取らず、その値は整数として扱われます。

この設定は、特に大きなデータをサーバーにPOSTする際に役立ちます。cURLは、データの本体を送信する前に、まずヘッダだけを送信し、サーバーがデータを受け取る準備ができているかを示す「100 Continue」応答を待ちます。これにより、サーバーがデータを受け付けられない場合に、大きなデータの送信を途中で中止し、ネットワーク帯域の無駄を避けることができます。

サンプルコードでは、curl_setopt()関数を用いてCURLOPT_EXPECT_100_TIMEOUT_MSに500ミリ秒を設定しています。これは、cURLがサーバーからの「100 Continue」応答を最大0.5秒間待つことを意味します。もしこの時間内に応答がなければ、cURLは待機を中止し、データの本体送信を続行します。この値を0に設定すると、この待機は無効となります。この設定は、ネットワーク状況やサーバーの応答が遅い場合でも、クライアントがデータ送信のために長時間待ち続けることを避けるために重要です。