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

Copy
1<?php
2
3/**
4 * STREAM_SOCK_DGRAM を使用してUDPサーバーを起動し、クライアントからのメッセージに応答します。
5 *
6 * システムエンジニアを目指す初心者向けに、PHPのソケット通信の基本を簡潔に示します。
7 */
8function runUdpServerWithStreamSockDgram(): void
9{
10    // サーバーが待ち受けるIPアドレスとポートを設定します。
11    $host = '127.0.0.1';
12    $port = 12345;
13    $serverAddress = "udp://$host:$port";
14
15    // ソケットコンテキストを作成し、ソケットタイプをデータグラム (UDP) に指定します。
16    // STREAM_SOCK_DGRAM 定数は、このソケットがコネクションレスなデータグラムソケットであることを示します。
17    $context = stream_context_create([
18        'socket' => [
19            'socket_type' => STREAM_SOCK_DGRAM,
20            // 必要に応じて、他のソケットオプションもここに追加できます。
21        ],
22    ]);
23
24    // stream_socket_server を使用してUDPサーバーソケットを作成します。
25    // 第1引数: サーバーアドレス (UDPプロトコルを指定)。
26    // 第4引数: STREAM_SERVER_BIND はソケットを指定されたアドレスにバインドすることを示します。
27    // 第5引数: 作成したコンテキストを渡すことで、STREAM_SOCK_DGRAM で指定されたソケットタイプが適用されます。
28    $serverSocket = stream_socket_server($serverAddress, $errno, $errstr, STREAM_SERVER_BIND, $context);
29
30    if (!$serverSocket) {
31        // ソケット作成に失敗した場合のエラーハンドリング
32        echo "エラー: UDPサーバーソケットの作成に失敗しました ($errno) $errstr\n";
33        return;
34    }
35
36    echo "UDPサーバーが $serverAddress で待機中です...\n";
37    echo "停止するには Ctrl+C を押してください。\n";
38
39    // 無限ループでクライアントからのデータ受信を待ちます。
40    while (true) {
41        // stream_socket_recvfrom でクライアントからのデータを受信します。
42        // 第2引数: 受信する最大バイト数。
43        // 第4引数: $peerName には送信元クライアントのアドレスとポートが格納されます。
44        $message = stream_socket_recvfrom($serverSocket, 1024, 0, $peerName);
45
46        if ($message === false) {
47            echo "エラー: データ受信中に問題が発生しました。\n";
48            continue;
49        }
50
51        // 受信したメッセージから空白文字を取り除き、送信元情報と共に表示します。
52        $trimmedMessage = trim($message);
53        echo "クライアント ($peerName) から受信: \"$trimmedMessage\"\n";
54
55        // 受信したメッセージに基づいて応答を作成します。
56        $response = "サーバー応答: あなたのメッセージは \"$trimmedMessage\" でした。";
57
58        // stream_socket_sendto でクライアントに応答を送信します。
59        // 第2引数: 送信するデータ。
60        // 第4引数: 送信先クライアントのアドレスとポート ($peerNameを使用)。
61        stream_socket_sendto($serverSocket, $response, 0, $peerName);
62        echo "クライアント ($peerName) へ送信: \"$response\"\n";
63    }
64
65    // スクリプト終了時にソケットはPHPによって自動的に閉じられますが、明示的に閉じることも可能です。
66    // stream_socket_close($serverSocket);
67}
68
69// サーバーアプリケーションを実行します。
70runUdpServerWithStreamSockDgram();

このサンプルコードは、PHPでUDPサーバーを起動し、クライアントとデータグラム通信を行う方法を示しています。特に、コネクションレスな通信を可能にするSTREAM_SOCK_DGRAM定数の使い方を簡潔に紹介しています。

STREAM_SOCK_DGRAMは、PHPのストリーム拡張機能の一部として提供される定数で、ソケット通信の種類をデータグラム（UDPプロトコルで使用される方式）に指定する際に用いられます。この定数自体には引数や戻り値はなく、ソケットの動作モードを設定するための識別子として機能します。

コードではまず、stream_context_create関数を使ってソケットコンテキストを生成します。このコンテキスト内で'socket_type' => STREAM_SOCK_DGRAMと指定することで、後で作成するソケットがUDPタイプであることを定義しています。次に、stream_socket_server関数を使用して、このUDP設定を含むコンテキストを渡しながら、指定されたIPアドレスとポートでUDPサーバーソケットを構築します。

サーバーが起動すると、無限ループでクライアントからのデータグラムメッセージの受信を待ちます。stream_socket_recvfrom関数がメッセージを受信し、送信元クライアントの情報も同時に取得します。その後、受信したメッセージに対する応答を作成し、stream_socket_sendto関数を使って、元のクライアントへ応答メッセージを送信します。この一連の流れを通じて、PHPで基本的なUDPサーバーを構築し、データグラム通信を行う方法を学ぶことができます。

Copy
1<?php
2
3/**
4 * TCPサーバーを起動し、クライアントからの接続を受け入れるシンプルな例。
5 * stream_socket_accept 関数を使用して、新しいクライアント接続を処理します。
6 * STREAM_SOCK_DGRAM はデータグラムソケット（UDPなど）を指す定数であり、
7 * stream_socket_accept が使用される接続指向型ソケット（TCPなど）とは異なるため、
8 * このサンプルコードには直接登場しません。
9 */
10function runTcpServer(): void
11{
12    // サーバーのアドレスとポートを指定
13    $host = '127.0.0.1';
14    $port = 12345;
15    $serverAddress = "tcp://$host:$port";
16
17    // stream_socket_server を使用してサーバーソケットを作成します。
18    // STREAM_SERVER_BIND: 指定されたアドレスとポートにバインドします。
19    // STREAM_SERVER_LISTEN: 接続待機状態にします。
20    $server = stream_socket_server($serverAddress, $errno, $errstr);
21
22    if (false === $server) {
23        echo "エラー: サーバーソケットを作成できませんでした ($errno) $errstr" . PHP_EOL;
24        return;
25    }
26
27    echo "TCPサーバーが $serverAddress で待機中です..." . PHP_EOL;
28    echo "別のターミナルで 'nc $host $port' を実行して接続してください。" . PHP_EOL;
29    echo "終了するには Ctrl+C を押してください。" . PHP_EOL;
30
31    // 無限ループでクライアントからの接続を待ち続けます。
32    while (true) {
33        // stream_socket_accept を使用してクライアント接続を受け入れます。
34        // ここでプログラムの実行はブロックされ、クライアントが接続するまで待機します。
35        // 第2引数の -1 はタイムアウトなしを意味します。
36        $client = stream_socket_accept($server, -1);
37
38        if (false === $client) {
39            echo "エラー: クライアント接続を受け入れられませんでした。" . PHP_EOL;
40            continue;
41        }
42
43        // 接続してきたクライアントのアドレスとポートを取得し表示します。
44        echo "クライアントが " . stream_socket_get_name($client, true) . " から接続しました。" . PHP_EOL;
45
46        // クライアントからのデータを受信します。
47        // 最大1024バイトまで読み取ります。
48        $data = stream_socket_recvfrom($client, 1024);
49
50        if (false === $data || '' === $data) {
51            echo "クライアントが切断したか、データが送信されませんでした。" . PHP_EOL;
52        } else {
53            echo "クライアントから受信: " . trim($data) . PHP_EOL;
54
55            // クライアントへ応答メッセージを送信します。
56            $response = "サーバーからの応答: あなたは '" . trim($data) . "' と送信しました。" . PHP_EOL;
57            stream_socket_sendto($client, $response);
58            echo "クライアントへ送信: " . trim($response) . PHP_EOL;
59        }
60
61        // クライアントとの通信が完了したら、クライアントソケットを閉じます。
62        fclose($client);
63        echo "クライアント接続を閉じました。" . PHP_EOL;
64    }
65
66    // 無限ループのため、通常はここには到達しませんが、リソースクリーンアップのため記載します。
67    fclose($server);
68}
69
70// サーバー機能を実行します。
71runTcpServer();

このサンプルコードは、PHPを使って簡単なTCPサーバーを構築し、クライアントからの接続を処理する基本的な流れを示しています。まず、stream_socket_server関数で指定されたアドレスとポートにサーバーソケットを作成し、クライアントからの接続を待ち受ける状態にします。

その後、プログラムは無限ループに入り、stream_socket_accept関数を使ってクライアントからの接続を待ちます。この関数は、第1引数に渡されたサーバーソケットに対して、新しいクライアントが接続するまで処理を一時停止（ブロック）させます。クライアントが接続に成功すると、そのクライアントとの通信に特化した新しいソケットリソースを返します。第2引数に-1を指定することで、タイムアウトなしで無期限に接続を待ちます。接続に失敗した場合はfalseが戻り値となります。

接続が受け入れられた後は、stream_socket_recvfromでクライアントからデータを受信し、stream_socket_sendtoで応答メッセージを送信します。一連の通信が完了すると、fcloseでクライアントソケットを閉じ、次のクライアント接続を待ちます。

リファレンス情報にあるSTREAM_SOCK_DGRAM定数は、データグラム（UDPなど）方式のソケットを扱う際に利用されるもので、このTCP接続を扱うサンプルコードでは直接使用されていません。