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

Copy
1<?php
2
3/**
4 * RTSP ANNOUNCE リクエストを送信し、そのレスポンスを取得する関数。
5 *
6 * この関数は、CURL_RTSPREQ_ANNOUNCE 定数を使用してRTSPプロトコルのANNOUNCEメソッドを
7 * どのように設定し、そのレスポンスをPHPのCURL拡張機能で処理するかを示します。
8 * ANNOUNCEメソッドは、ストリーミングサーバーにセッション記述（SDP）を提供するために使用されます。
9 *
10 * @param string $rtspUrl RTSPサーバーのURL (例: 'rtsp://example.com/stream')
11 * @param string $sdpBody ANNOUNCEリクエストで送信するSDP記述の文字列
12 * @return string|false リクエストのレスポンス文字列、または失敗した場合は false
13 */
14function sendRTSPAnnounceRequest(string $rtspUrl, string $sdpBody = ''): string|false
15{
16    // CURLセッションを初期化
17    $ch = curl_init();
18
19    // 初期化失敗時のエラーハンドリング
20    if ($ch === false) {
21        error_log("CURL初期化に失敗しました。");
22        return false;
23    }
24
25    // ANNOUNCEリクエストのSDPボディのデフォルト例
26    // 実際には、ストリームのメディア情報（コーデック、ポートなど）を記述します。
27    if (empty($sdpBody)) {
28        $sdpBody = <<<SDP
29v=0
30o=- 2890844526 2890842807 IN IP4 127.0.0.1
31s=My Stream
32t=0 0
33a=range:npt=0-
34m=video 5000 RTP/AVP 96
35a=rtpmap:96 H264/90000
36SDP;
37    }
38
39    // CURLオプションを設定
40    curl_setopt_array($ch, [
41        CURLOPT_URL            => $rtspUrl,                         // リクエストを送信するRTSPサーバーのURL
42        CURLOPT_RTSP_REQUEST   => CURL_RTSPREQ_ANNOUNCE,            // ANNOUNCEリクエストを指定
43        CURLOPT_RETURNTRANSFER => true,                             // レスポンスを文字列として取得
44        CURLOPT_HEADER         => true,                             // レスポンスヘッダーも取得
45        CURLOPT_NOBODY         => false,                            // レスポンスボディも取得
46        CURLOPT_TIMEOUT        => 10,                               // 接続タイムアウト (秒)
47        CURLOPT_POSTFIELDS     => $sdpBody,                         // ANNOUNCEリクエストのボディとしてSDPを送信
48        CURLOPT_HTTPHEADER     => [
49            'Content-Type: application/sdp',                        // ボディのContent-Type
50            'CSeq: 1',                                              // RTSPのシーケンス番号 (リクエストごとにインクリメント)
51            'User-Agent: PHP-CURL-Client/8.x',                      // ユーザーエージェント
52        ],
53        // CURLOPT_VERBOSE      => true,                           // デバッグ情報が必要な場合はコメントを外す
54    ]);
55
56    // CURLリクエストを実行し、レスポンスを取得
57    $response = curl_exec($ch);
58
59    // CURLエラーのチェック
60    if (curl_errno($ch)) {
61        $errorMessage = 'CURLエラー (' . curl_errno($ch) . '): ' . curl_error($ch);
62        error_log($errorMessage);
63        curl_close($ch);
64        return false;
65    }
66
67    // CURLセッションを終了し、リソースを解放
68    curl_close($ch);
69
70    // レスポンスが空の場合のチェック
71    if ($response === false) {
72        error_log("RTSP ANNOUNCEリクエストは成功しましたが、レスポンスがありませんでした。");
73        return false;
74    }
75
76    return $response;
77}
78
79// --- 関数実行のサンプル ---
80
81// 実際のRTSPサーバーURLに置き換えてください。
82// このURLは単なる例であり、実際に動作するRTSPサーバーではありません。
83$targetRtspUrl = 'rtsp://your-rtsp-server.com/stream_name';
84
85echo "RTSP ANNOUNCEリクエストを $targetRtspUrl へ送信中...\n\n";
86
87// ANNOUNCEリクエストを送信し、レスポンスを受け取る
88$rtspResponse = sendRTSPAnnounceRequest($targetRtspUrl);
89
90if ($rtspResponse) {
91    echo "--- 受信したRTSPレスポンス ---\n";
92    echo $rtspResponse;
93    echo "\n-----------------------------\n";
94} else {
95    echo "RTSP ANNOUNCEリクエストの実行に失敗しました。\n";
96    echo "注意: この例は `CURL_RTSPREQ_ANNOUNCE` の使い方を示すものです。\n";
97    echo "      実際にこのコードを実行するには、有効なRTSPサーバーに接続できる必要があります。\n";
98}

このサンプルコードは、PHPのCURL拡張機能を使用して、RTSP (Real Time Streaming Protocol) のANNOUNCEリクエストをストリーミングサーバーに送信し、その応答を受け取る方法を示しています。

特に、CURL_RTSPREQ_ANNOUNCE定数は、CURLに対してRTSPプロトコルのANNOUNCEメソッドを実行するよう指示します。ANNOUNCEリクエストは、ストリーミングサーバーへこれから配信するメディア（動画や音声など）の詳細な情報（SDP: Session Description Protocol形式）を通知する際に利用されるものです。

コードでは、まずcurl_init()関数でCURLセッションを初期化し、その後のcurl_setopt_array()関数で様々な通信オプションを設定します。ここでCURLOPT_RTSP_REQUESTオプションにCURL_RTSPREQ_ANNOUNCEを指定することで、ANNOUNCEリクエストの種類を明確にしています。CURLOPT_POSTFIELDSオプションには、ANNOUNCEリクエストの本文としてSDP情報を文字列で設定し、サーバーにメディアの詳細を伝えます。CURLOPT_URLで接続先のRTSPサーバーのURLを指定し、CURLOPT_RETURNTRANSFERをtrueにすることで、サーバーからのレスポンスを関数が文字列として取得できるようにしています。

設定後、curl_exec()関数でリクエストを実行し、サーバーからの応答を取得します。リクエストの実行中にエラーが発生した場合は、curl_errno()関数で確認し、適切なエラー処理を行います。最後に、curl_close()関数でCURLセッションを閉じ、使用したリソースを解放します。

この関数は、引数としてRTSPサーバーのURL ($rtspUrl) と、送信するSDP情報文字列 ($sdpBody) を受け取ります。実行が成功すればサーバーからのレスポンス文字列を返し、失敗した場合はfalseを返します。これは、RTSPプロトコルを介したストリーミングサービスとの連携を学ぶ上で基本的な概念を理解するのに役立つでしょう。

Copy
1<?php
2
3/**
4 * 指定されたURLへのHTTPリクエストを実行し、HTTPステータスコードを取得します。
5 * システムエンジニアを目指す初心者の方へ：
6 * この関数は、ウェブサイトが正常に動作しているか（HTTPステータスコード200）、
7 * ページが見つからないか（404）、サーバーエラーが発生していないか（5xx）などを
8 * プログラムから自動的に確認する際によく利用されます。
9 *
10 * @param string $url リクエストを送信するURL。例: 'https://www.example.com'
11 * @return int|false HTTPステータスコード（例: 200, 404）または、cURLエラー発生時には false。
12 */
13function getHttpStatusCode(string $url): int|false
14{
15    // cURLセッションを初期化します。cURLは様々なプロトコル（HTTP, HTTPS, FTPなど）で
16    // 通信を行うための強力なライブラリです。
17    $ch = curl_init();
18
19    // cURLが正常に初期化できなかった場合はエラーを返し、処理を中断します。
20    if ($ch === false) {
21        // エラーログに出力するなど、適切なエラーハンドリングをここで行うことができます。
22        error_log("cURL 初期化エラー: cURLセッションの作成に失敗しました。");
23        return false;
24    }
25
26    // cURLオプションを設定します。これらのオプションでリクエストの挙動を細かく制御します。
27    // CURLOPT_URL: リクエストを送信するターゲットURLを指定します。
28    curl_setopt($ch, CURLOPT_URL, $url);
29    
30    // CURLOPT_RETURNTRANSFER: curl_exec()関数の戻り値を、取得したデータ（文字列）にします。
31    // これをtrueにしない場合、curl_exec()は直接結果を出力してしまいます。
32    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
33    
34    // CURLOPT_NOBODY: レスポンスのボディ（ウェブページのHTMLコンテンツなど）は取得せず、
35    // ヘッダ情報のみを取得します。これにより、ページの存在確認やステータスコード取得が
36    // 非常に高速に行え、ネットワーク帯域の節約にもなります。
37    curl_setopt($ch, CURLOPT_NOBODY, true);
38    
39    // CURLOPT_TIMEOUT: リクエストがタイムアウトするまでの秒数を設定します。
40    // ここでは10秒に設定されており、これを超えるとエラーが発生します。
41    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
42
43    // --- ここで参照されているCURL_RTSPREQ_ANNOUNCE定数について ---
44    // CURL_RTSPREQ_ANNOUNCE は、RTSP (Real-Time Streaming Protocol) における
45    // ANNOUNCEリクエストタイプを示す定数です。
46    // RTSPは動画や音声などのストリーミング配信を制御するためのプロトコルで、
47    // ANNOUNCEはそのセッション開始をサーバーに通知する際などに利用されます。
48    // この定数はHTTPプロトコルとは異なりますが、同じPHPのcURL拡張機能の一部として提供されています。
49    // 例として、RTSPリクエストを設定する際には、以下のように利用されます:
50    // curl_setopt($ch, CURLOPT_RTSPREQUEST, CURL_RTSPREQ_ANNOUNCE);
51    // ただし、このサンプルコードは一般的なHTTPリクエストとHTTPステータスコードの取得に焦点を当てています。
52
53    // 設定したオプションでcURLリクエストを実行します。
54    // CURLOPT_NOBODY が true なので、$response には空の文字列が格納されることがほとんどです。
55    $response = curl_exec($ch);
56
57    // cURL実行中にエラーが発生したかを確認します。
58    if (curl_errno($ch)) {
59        $error_msg = curl_error($ch);
60        curl_close($ch); // エラー発生時でもセッションを閉じます。
61        error_log("cURL リクエストエラー: {$error_msg} (URL: {$url})");
62        return false;
63    }
64
65    // HTTPステータスコードを取得します。
66    // CURLINFO_HTTP_CODE は、最後に受信したHTTPステータスコード（例: 200, 404, 500）を
67    // 取得するための情報フラグです。
68    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
69
70    // cURLセッションを閉じ、使用したリソースを解放します。
71    curl_close($ch);
72
73    return $httpCode;
74}
75
76// --- サンプル使用例 ---
77// 実際に存在するURLを指定してください。
78// 例1: 正常なページ (200 OK を返す可能性が高い)
79$targetUrl1 = 'https://www.google.com'; 
80// 例2: 存在しないページ (404 Not Found を返す可能性が高い)
81$targetUrl2 = 'https://www.google.com/nonexistent-page-12345'; 
82
83echo "URL '{$targetUrl1}' のHTTPステータスコードを取得中...\n";
84$statusCode1 = getHttpStatusCode($targetUrl1);
85
86if ($statusCode1 !== false) {
87    echo "HTTPステータスコード: {$statusCode1}\n";
88    // 取得したステータスコードに基づいて、処理を分岐させることができます。
89    if ($statusCode1 === 200) {
90        echo "ステータス: 正常 (200 OK).\n\n";
91    } elseif ($statusCode1 === 404) {
92        echo "ステータス: ページが見つかりません (404 Not Found).\n\n";
93    } elseif ($statusCode1 >= 500 && $statusCode1 < 600) {
94        echo "ステータス: サーバーエラーが発生しました ({$statusCode1}).\n\n";
95    } else {
96        echo "ステータス: その他のコード ({$statusCode1}).\n\n";
97    }
98} else {
99    echo "HTTPステータスコードの取得に失敗しました (URL: {$targetUrl1}).\n\n";
100}
101
102echo "URL '{$targetUrl2}' のHTTPステータスコードを取得中...\n";
103$statusCode2 = getHttpStatusCode($targetUrl2);
104
105if ($statusCode2 !== false) {
106    echo "HTTPステータスコード: {$statusCode2}\n";
107    if ($statusCode2 === 200) {
108        echo "ステータス: 正常 (200 OK).\n";
109    } elseif ($statusCode2 === 404) {
110        echo "ステータス: ページが見つかりません (404 Not Found).\n";
111    } else {
112        echo "ステータス: その他のコード ({$statusCode2}).\n";
113    }
114} else {
115    echo "HTTPステータスコードの取得に失敗しました (URL: {$targetUrl2}).\n";
116}

このサンプルコードは、PHPのcURL拡張機能を利用して、指定されたウェブサイトのHTTPステータスコードを取得する方法を示しています。システムエンジニアを目指す初心者の方にとって、ウェブサイトが正常に動作しているか（200 OK）、ページが存在しないか（404 Not Found）、サーバーエラーが発生していないか（5xx）などをプログラムから自動的に監視・確認するための基礎的な技術です。

getHttpStatusCode関数は、リクエストを送信するURLを文字列型（string）で引数に受け取ります。この関数は内部でcURLセッションを初期化し、CURLOPT_URLでターゲットURLを設定します。特に、CURLOPT_NOBODYをtrueに設定することで、ウェブページのコンテンツ（ボディ）全体をダウンロードせずにヘッダ情報のみを取得し、ステータスコードの確認を高速に行います。CURLOPT_RETURNTRANSFERはcurl_exec()の戻り値を文字列として取得するために利用され、CURLOPT_TIMEOUTはリクエストの最大時間を設定します。cURLリクエストの実行後、CURLINFO_HTTP_CODEオプションを使用して最終的なHTTPステータスコードを取得します。処理が成功した場合は取得したHTTPステータスコード（整数型 int）を返し、cURLの初期化や実行中にエラーが発生した場合はfalseを返します。

サンプルコード内で言及されているCURL_RTSPREQ_ANNOUNCE定数は、本コードの主な目的であるHTTPリクエストとは異なり、動画や音声のストリーミング配信で用いられるRTSP（Real-Time Streaming Protocol）のANNOUNCEリクエストタイプを示すものです。この定数自体はPHPのcURL拡張機能の一部ですが、今回のHTTPステータスコード取得の目的では直接使用されていません。