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

【PHP8.x】stream_socket_recvfrom()関数の使い方

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

作成日: 更新日:

基本的な使い方

stream_socket_recvfrom関数は、ネットワーク通信で使用されるソケットからデータを安全に読み込む機能を提供する関数です。この関数は、すでに接続が確立されたソケットからも、接続されていないソケットからもデータを受信することができます。特に、UDPなどのコネクションレスなプロトコルを用いた通信において、データを受信する際にその真価を発揮します。

この関数の大きな特徴は、データを受信すると同時に、そのデータを送信したリモートホストのアドレス情報を取得できる点です。これにより、サーバー側が複数のクライアントからのデータを受け取る際に、それぞれのデータがどのクライアントから送られてきたのかを正確に識別することが可能になります。関数には、読み込み対象となるソケットリソース、読み込みたい最大バイト数、オプションのフラグ、そして送信元アドレスを格納するための変数を渡します。

ネットワークアプリケーション、特に多数のクライアントと非同期に通信を行うサーバープログラムにおいて、クライアントからのリクエストデータと送信元を紐付ける必要がある場合に非常に役立ちます。データの読み込みに成功した場合は読み込んだデータ文字列を返し、エラーが発生した場合はブール値のfalseを返します。バイナリデータも安全に扱えるため、幅広いデータ形式の受信に対応しています。

構文(syntax)

1<?php
2
3// UDPサーバーソケットを作成
4// 実際には、"udp://0.0.0.0:12345"のようにアドレスとポートを指定します
5$socket = stream_socket_server("udp://127.0.0.1:12345");
6
7if ($socket === false) {
8    exit(1);
9}
10
11// 受信する最大バイト数
12$length = 1024;
13
14// フラグ (例: MSG_PEEKなど、通常は0)
15$flags = 0;
16
17// 送信元のアドレスが格納される変数 (参照渡し)
18$remoteAddress = null;
19
20// stream_socket_recvfrom 関数を呼び出し、ソケットからデータを受信
21$receivedData = stream_socket_recvfrom(
22    $socket,
23    $length,
24    $flags,
25    $remoteAddress
26);
27
28if ($receivedData !== false) {
29    // データが正常に受信された場合の処理
30    // $receivedData には受信された文字列データが、
31    // $remoteAddress には送信元のアドレスが格納されます。
32    // 例: echo "Received: " . $receivedData . " from " . $remoteAddress . "\n";
33} else {
34    // データ受信に失敗した場合の処理
35    // 例: echo "Failed to receive data.\n";
36}
37
38// ソケットを閉じる
39fclose($socket);
40
41?>

引数(parameters)

resource $socket, int $length, int $flags = 0, ?string &$address = null

  • resource $socket: 読み取り対象のソケットリソース
  • int $length: 読み取る最大バイト数
  • int $flags = 0: オプションフラグ
  • ?string &$address = null: 接続元のアドレス情報(出力用)

戻り値(return)

string|false

ストリームソケットから受信したデータを文字列で返します。データの受信に失敗した場合は false を返します。

サンプルコード

PHP stream_socket_serverとstream_socket_recvfromでUDPサーバーを実装する

1<?php
2
3/**
4 * UDPサーバーを作成し、クライアントからのデータを受信します。
5 * stream_socket_serverとstream_socket_recvfrom関数の基本的な使用方法を示します。
6 *
7 * このスクリプトを実行後、別のターミナルからUDPクライアント(例: netcat)を使用して
8 * データを送信することで動作を確認できます。
9 * 例: echo "Hello PHP Server!" | nc -u 127.0.0.1 12345
10 */
11
12// サーバーがリッスンするホストとポートを設定します。
13$host = '127.0.0.1'; // ローカルホスト
14$port = 12345;       // 任意の空いているポート番号
15$serverAddress = "udp://$host:$port";
16
17// stream_socket_serverを使用してUDPサーバーソケットを作成します。
18// STREAM_SERVER_BIND フラグは、ソケットをバインドするがリッスンしないことを意味します(UDPの場合)。
19// $errno と $errstr には、エラー発生時にエラーコードとメッセージが格納されます。
20$serverSocket = stream_socket_server($serverAddress, $errno, $errstr, STREAM_SERVER_BIND);
21
22// ソケットの作成に失敗した場合、エラーメッセージを表示して終了します。
23if (!$serverSocket) {
24    echo "エラー: サーバーソケットを作成できませんでした ($errno) $errstr\n";
25    exit(1);
26}
27
28echo "UDPサーバーが {$serverAddress} で待機中です...\n";
29echo "Ctrl+C で終了します。\n";
30
31// 無限ループでクライアントからのデータ受信を待ちます。
32while (true) {
33    // stream_socket_recvfrom関数を使用して、UDPソケットからデータを受信します。
34    // 第1引数: 受信するソケットリソース。
35    // 第2引数: 受信する最大バイト数。
36    // 第3引数: フラグ(通常は0)。
37    // 第4引数: 参照渡しで、データを送信したクライアントのアドレス(IP:ポート)が格納されます。
38    $data = stream_socket_recvfrom($serverSocket, 1024, 0, $address);
39
40    // データ受信に失敗した場合、エラーメッセージを表示し、次のループに進みます。
41    if ($data === false) {
42        echo "エラー: データの受信に失敗しました。\n";
43        continue;
44    }
45
46    // 受信したデータと送信元アドレスを表示します。
47    // trim() はデータの末尾にある改行コードなどを除去します。
48    echo "クライアント {$address} からデータを受信: " . trim($data) . "\n";
49
50    // 必要であれば、ここでクライアントに応答を返す処理を追加できます。
51    // stream_socket_sendto($serverSocket, "Echo: " . $data, 0, $address);
52}
53
54// サーバーソケットを閉じます。
55// (通常、上記の無限ループのため、この行に到達することはありません。)
56fclose($serverSocket);
57
58?>

stream_socket_recvfrom関数は、PHPでネットワーク通信、特にUDPプロトコルを使用してクライアントからデータを受信するために使用されます。この関数は、stream_socket_serverなどで作成されたソケットリソースからデータを受け取る役割を担います。

第一引数$socketには、データを受信するネットワークソケットのリソースを指定します。第二引数$lengthは、一度に受信するデータの最大バイト数を指定する整数です。第三引数$flagsは通常0を指定しますが、特別な受信動作を制御するためのフラグとして利用されます。第四引数&$addressは参照渡しで、データを受信すると、そのデータを送信したクライアントのIPアドレスとポート番号がこの変数に自動的に格納されます。これにより、どの送信元からデータが来たかを特定できます。

関数が成功すると、受信したデータが文字列として返されます。データ受信に失敗した場合はfalseが返されるため、戻り値を確認してエラー処理を行うことが重要です。

提供されたサンプルコードでは、まずstream_socket_server関数を使ってUDPサーバーソケットを作成し、その後無限ループの中でstream_socket_recvfrom関数を繰り返し呼び出すことで、クライアントからのメッセージを継続的に待ち受け、受信したデータとその送信元アドレスを表示しています。これにより、PHPで簡単なUDPサーバーを構築し、外部からのデータを受信する仕組みを実装できるのです。

サーバー起動時には、ポートが使用中などのエラーが発生する可能性があるため、stream_socket_server関数の戻り値とエラー情報($errno, $errstr)を必ず確認し、適切に処理することが重要です。stream_socket_recvfrom関数の第二引数$lengthは一度に受信できる最大バイト数を指定します。受信データがこのサイズを超える場合、データは切り捨てられるため、アプリケーションで必要な適切な値を設定してください。第四引数&$addressには参照渡しでデータ送信元のアドレスが格納され、UDP通信ではクライアントを識別するために不可欠です。サンプルコードは無限ループで動作しますが、実際のシステムではサーバーを安全に停止させ、使用したリソースを解放する仕組みを考慮する必要があります。受信データは文字列として扱われるため、必要に応じて加工し、セキュリティに注意してください。

PHPでTCPサーバーとデータ受信

1<?php
2
3/**
4 * TCPサーバーを起動し、クライアントからの接続を受け入れてデータを受信するサンプルコード。
5 * stream_socket_accept() でクライアント接続を受け入れ、
6 * stream_socket_recvfrom() でクライアントから送信されたデータを受信します。
7 *
8 * このスクリプトを実行後、別のターミナルで以下のようなコマンドを実行して
9 * サーバーに接続し、データを送信できます:
10 *
11 * 例: "Hello from client!" という文字列を送信
12 * echo "Hello from client!" | nc 127.0.0.1 8000
13 *
14 * @return void
15 */
16function runTcpServerWithRecvfrom(): void
17{
18    $host = '127.0.0.1'; // サーバーがリッスンするIPアドレス
19    $port = 8000;       // サーバーがリッスンするポート番号
20    $serverSocketAddress = "tcp://{$host}:{$port}"; // ソケットアドレス形式
21
22    // サーバーソケットを作成し、指定されたアドレスとポートにバインドします。
23    // STREAM_SERVER_BIND: ソケットをアドレスにバインドします。
24    // STREAM_SERVER_LISTEN: クライアントからの接続をリッスン(待機)します。
25    // stream_context_create: ソケットオプションを設定するためのコンテキストを作成します。
26    // 'so_reuseaddr': サーバーが予期せず終了した場合でも、ポートをすぐに再利用できるようにします。
27    $serverSocket = stream_socket_server(
28        $serverSocketAddress,
29        $errno, // エラーコードが格納される変数
30        $errstr, // エラーメッセージが格納される変数
31        STREAM_SERVER_BIND | STREAM_SERVER_LISTEN,
32        stream_context_create(['socket' => ['so_reuseaddr' => true]])
33    );
34
35    if (!$serverSocket) {
36        // ソケット作成に失敗した場合のエラーハンドリング
37        echo "エラー: サーバーソケットの作成に失敗しました ($errno) $errstr\n";
38        return;
39    }
40
41    echo "TCPサーバーが {$serverSocketAddress} で待機中です...\n";
42
43    // 無限ループでクライアントからの接続を待ち受けます(Ctrl+Cで終了)。
44    while (true) {
45        echo "新しいクライアント接続を待機中...\n";
46
47        // stream_socket_accept(): クライアントからの接続要求を受け入れます。
48        // 接続が確立されると、そのクライアントとの通信に使用する新しいソケットリソースを返します。
49        // 第2引数のタイムアウトを -1 に設定すると、無期限に接続を待機します。
50        $clientSocket = stream_socket_accept($serverSocket, -1);
51
52        if (!$clientSocket) {
53            // クライアント接続の受け入れに失敗した場合
54            echo "警告: クライアント接続の受け入れに失敗しました。\n";
55            continue; // 次のループへ進み、再度接続を待ちます。
56        }
57
58        echo "クライアントが接続しました。\n";
59
60        // stream_socket_recvfrom(): ソケットからデータを受信します。
61        // TCPのようなコネクション指向ソケットでは、接続済み相手からのデータを読み込みます。
62        // 第2引数: 読み取る最大バイト数。
63        // 第3引数: フラグ(通常は0)。
64        // 第4引数 ($peerAddress): 接続している相手(ピア)のアドレス情報が格納されます。
65        $peerAddress = null; // 送信元アドレスを格納する変数
66        $data = stream_socket_recvfrom($clientSocket, 1024, 0, $peerAddress);
67
68        if ($data === false) {
69            // データ受信中にエラーが発生した場合
70            echo "エラー: データ受信に失敗しました。\n";
71        } elseif ($data === '') {
72            // クライアントが接続を正常に閉じた場合、空の文字列が返されることがあります。
73            echo "クライアントが接続を閉じました。\n";
74        } else {
75            // 受信したデータと送信元アドレスを表示
76            echo "受信元アドレス: {$peerAddress}\n";
77            echo "受信データ: '{$data}'\n";
78        }
79
80        // クライアントとの通信が終了したら、そのクライアントソケットを閉じます。
81        fclose($clientSocket);
82        echo "クライアントソケットを閉じました。\n";
83    }
84
85    // 無限ループのため、通常はここには到達しません。
86    // プログラムを終了する場合は、サーバーソケットも閉じるべきです。
87    // fclose($serverSocket);
88}
89
90// TCPサーバーを開始
91runTcpServerWithRecvfrom();

PHP 8のstream_socket_recvfrom関数は、指定されたソケットからデータを受信するために使用されます。主にTCPのようなコネクション指向型のソケットにおいて、接続が確立された相手からのデータ読み込みに利用される点が特徴です。

この関数は4つの引数を取ります。最初の$socket引数には、データを読み込む対象となるソケットリソースを指定します。サンプルコードでは、stream_socket_accept関数で接続を受け入れたクライアントとの通信に使うソケットがこれに該当します。次に$length引数で、読み取る最大バイト数を指定します。$flags引数は通常0を指定します。最後の&$address引数は参照渡しで、データ送信元のアドレス情報が文字列としてこの変数に格納されます。

戻り値は、データの受信に成功した場合は受信したデータを示す文字列を返します。エラーが発生した場合はfalseを返します。また、TCPソケットの場合、接続しているクライアントが正常に接続を閉じた際には空の文字列が返されることがあります。

提供されたサンプルコードでは、TCPサーバーがstream_socket_accept関数でクライアントからの接続を受け入れた後、その確立されたクライアントとの通信ソケットをstream_socket_recvfrom関数の第一引数に渡し、クライアントから送信されたデータを受信しています。この際、データの送信元アドレスも同時に取得し、表示する流れが示されています。

stream_socket_recvfromをTCPソケットで使用する場合、接続済みのクライアントからデータを受信します。TCPはストリーム指向のため、一度の受信で指定したバイト数全てが届くとは限りません。受信データが不足したり、複数回に分かれて届いたりする可能性があり、アプリケーション側でデータの継続的な処理が必要です。引数$addressには接続元のアドレスが格納されますが、TCPソケットでは通常固定です。データ受信時にエラーが発生するとfalse、クライアントが接続を正常に閉じると空文字列が返されるため、これらの戻り値の確認は非常に重要です。サンプルコードはサーバーソケットのクローズ処理が含まれていませんが、プログラム終了時には適切にソケットを閉じるようにしましょう。

関連コンテンツ

関連IT用語

関連プログラミング言語