【PHP8.x】stream_socket_client関数の使い方

Copy
1<?php
2
3/**
4 * stream_socket_client のサンプルコード
5 */
6function streamSocketClientExample(string $address): void
7{
8    // タイムアウト時間を設定 (秒)
9    $timeout = 5;
10
11    // ソケット接続を試みる
12    $stream = stream_socket_client(
13        $address,
14        $errno,
15        $errstr,
16        $timeout
17    );
18
19    // エラーが発生した場合
20    if (!$stream) {
21        echo "Error: $errstr ($errno)" . PHP_EOL;
22        return;
23    }
24
25    // ソケットが正常に接続された場合
26    echo "Successfully connected to $address" . PHP_EOL;
27
28    // データを送信 (HTTP GET リクエストの例)
29    $request = "GET / HTTP/1.1\r\nHost: example.com\r\nConnection: close\r\n\r\n";
30    fwrite($stream, $request);
31
32    // 応答を読み込む
33    while (!feof($stream)) {
34        echo fgets($stream);
35    }
36
37    // ストリームを閉じる
38    fclose($stream);
39}
40
41// example.comの80番ポートに接続する例
42streamSocketClientExample("tcp://example.com:80");
43
44?>

stream_socket_client関数は、指定されたアドレスへのソケット接続を確立するために使用されます。この関数は、システムエンジニアを目指す初心者にとって、ネットワークプログラミングの基礎を理解する上で重要な役割を果たします。

$address引数には、接続先のソケットアドレスを指定します。例えば、"tcp://example.com:80" のように、プロトコル、ホスト名、ポート番号を含んだ文字列を指定します。$error_codeと$error_message引数には、接続時にエラーが発生した場合、そのエラーコードとエラーメッセージが格納されます。$timeout引数には、接続を試みる際のタイムアウト時間を秒単位で指定します。タイムアウト時間を設定することで、接続がいつまでも確立されない状況を回避できます。

stream_socket_client関数は、接続に成功した場合、ストリームリソースを返します。このリソースを使用して、ソケットとのデータの送受信を行うことができます。接続に失敗した場合は、falseを返します。

サンプルコードでは、まずstream_socket_client関数を使用して "tcp://example.com:80" への接続を試みます。接続に成功した場合、HTTP GETリクエストを送信し、レスポンスを読み込んで表示します。最後に、fclose関数を使用してストリームを閉じます。エラーが発生した場合は、エラーメッセージを表示します。この例は、基本的なHTTPクライアントの実装を示しており、ネットワークプログラミングの入門として役立ちます。

Copy
1<?php
2
3/**
4 * WebSocketクライアント接続サンプル
5 *
6 * @param string $address WebSocketサーバーのアドレス (例: tcp://localhost:8000)
7 * @param string $message 送信するメッセージ
8 * @return string|false 受信したメッセージ、または接続失敗時にfalse
9 */
10function websocket_client(string $address, string $message): string|false
11{
12    $context = stream_context_create([
13        'socket' => [
14            'tcp_nodelay' => true, // Nagleアルゴリズムを無効化 (レイテンシ削減)
15        ],
16    ]);
17
18    $error_code = 0;
19    $error_message = '';
20    $timeout = 5; // 接続タイムアウト (秒)
21
22    $socket = stream_socket_client(
23        $address,
24        $error_code,
25        $error_message,
26        $timeout,
27        STREAM_CLIENT_CONNECT,
28        $context
29    );
30
31    if (!$socket) {
32        error_log("Failed to connect: $error_message (code: $error_code)");
33        return false;
34    }
35
36    fwrite($socket, $message); // メッセージを送信
37    $response = fread($socket, 4096); // 応答を受信 (最大4096バイト)
38    fclose($socket); // ソケットを閉じる
39
40    return $response;
41}
42
43// 使用例:
44$address = 'tcp://localhost:8000'; // WebSocketサーバーのアドレス
45$message = "Hello, WebSocket Server!";
46$response = websocket_client($address, $message);
47
48if ($response !== false) {
49    echo "Received: " . $response . PHP_EOL;
50} else {
51    echo "Connection failed." . PHP_EOL;
52}
53
54?>

PHPのstream_socket_client関数は、ソケットを使用してサーバーに接続するための関数です。このサンプルコードでは、stream_socket_client関数を利用してWebSocketクライアントを実装しています。

websocket_client関数は、WebSocketサーバーのアドレス $address と、送信するメッセージ $message を引数に取ります。stream_socket_client関数を使用してサーバーに接続し、メッセージを送信して応答を受信します。

stream_socket_client関数の第一引数 $address は接続先のアドレスを指定します。第二引数 $error_code と第三引数 $error_message は、接続に失敗した場合にエラーコードとエラーメッセージが格納される変数を参照渡しで指定します。第四引数 $timeout は接続のタイムアウト時間を秒単位で指定します。第五引数 $flags は接続オプションを指定します。ここでは STREAM_CLIENT_CONNECT を指定して接続を確立します。第六引数 $context はストリームコンテキストを指定します。サンプルコードでは、Nagleアルゴリズムを無効にするための設定を行っています。

関数は、サーバーからの応答を文字列で返し、接続に失敗した場合は false を返します。

使用例では、ローカルホストの8000番ポートでWebSocketサーバーが動作していることを想定し、"Hello, WebSocket Server!"というメッセージを送信しています。サーバーからの応答があれば、受信したメッセージを表示し、接続に失敗した場合はその旨を表示します。

このサンプルコードは、WebSocketクライアントの基本的な接続とメッセージ送受信の流れを理解するのに役立ちます。stream_socket_client関数は、WebSocketに限らず、様々な種類のソケット通信に使用できます。