XCVIIソケット関数

導入

ソケット拡張により、ソケット通信関数への低レベルなインターフェース が実装され、クライアントとしてだけでなく、ソケットサーバーとして動 作することが可能となります。

より一般的なクライアントサイドのソケットインターフェースについては、 fsockopen() および pfsockopen() を参照下さい。

ここで説明するソケット関数を使用する場合、多くの関数は、C言語に同 じ名前の関数が存在しますが、定義が異なっていることに注意して下さい。 混乱を避けるには、説明をよく読んで下さい。

このようにソケットソケットプログラミングと異なっている点はあります が、それでも有用な多くのUNIX man ページを参照することができます。 Web上にC言語のソケットプログラミングのチュートリアル情報が存在し、 その多くは、若干の修正により、PHPにおけるソケットプログラミングに 適当することが可能です。 UNIX Socket FAQ が、手始めと して適しているでしょう。

警告

このモジュールは、 実験的 なものです。これは、これらの関数の動作、関数名は、このドキュメントに書かれて事項と同様に告知なく将来的なPHPのリリースで変更される可能性があります。注意を喚起するとともに、このモジュールは使用者のリスクで使用して下さい。

要件

これらの関数は、標準モジュールの一部と して利用可能であり、常に使用できます。

インストール手順

ここに既述されたソケット関数はPHP拡張モジュールの一部であり、コン パイル時に configure にオプション --enable-sockets を指定することにより使用 可能となります。

実行用の設定

この拡張モジュールは設定ディレクティブを全く 定義しません。

リソース型

この拡張モジュールはリソース型を全く定義し ません。

定義済みの定数

これらの定数は、この拡張モジュールで定義されており、 この拡張モジュールがPHP内部にコンパイルされているか実行時に動的にロー ドされるかのどちらかの場合のみ使用可能です。

AF_UNIX ( integer )

AF_INET ( integer )

SOCK_STREAM ( integer )

SOCK_DGRAM ( integer )

SOCK_RAW ( integer )

SOCK_SEQPACKET ( integer )

SOCK_RDM ( integer )

MSG_OOB ( integer )

MSG_WAITALL ( integer )

MSG_PEEK ( integer )

MSG_DONTROUTE ( integer )

SO_DEBUG ( integer )

SO_REUSEADDR ( integer )

SO_KEEPALIVE ( integer )

SO_DONTROUTE ( integer )

SO_LINGER ( integer )

SO_BROADCAST ( integer )

SO_OOBINLINE ( integer )

SO_SNDBUF ( integer )

SO_RCVBUF ( integer )

SO_SNDLOWAT ( integer )

SO_RCVLOWAT ( integer )

SO_SNDTIMEO ( integer )

SO_RCVTIMEO ( integer )

SO_TYPE ( integer )

SO_ERROR ( integer )

SOL_SOCKET ( integer )

PHP_NORMAL_READ ( integer )

PHP_BINARY_READ ( integer )

SOL_TCP ( integer )

SOL_UDP ( integer )

ソケットのエラー

ソケット拡張モジュールは、強力なBSDソケットへの有用なインターフェ イスを提供するために作成されました。 関数は、Win32およびUNIXの実装において等しく動作するように注意が払 われています。ソケット関数の多くは特定の条件で失敗し、エラーを記 述する E_WARNING メッセージを出力します。 これは、時々開発者が望まない時に発生することがあります。例えば、 関数 socket_read() は突然 E_WARNING メッセージを出力する可能性がありま す。これは、予測しない接続断が発生したためです。 @ 演算子により警告出力を抑制し、 socket_last_error() 関数によりアプリケーション 内でエラーコードを取得することが一般に行われています。 エラーを記述する文字列を取得するためにこのエラーコードを指定して socket_strerror() 関数をコールすることが可能で す。詳細は、この関数の説明を参照して下さい。

注意 E_WARNING メッセージは、ソケット拡張モジュー ルにより英語で生成されますが、取得されるエラーメッセージは、カレ ントのロケール( LC_MESSAGES )に依存します。

Warning - socket_bind() unable to bind address [98]: Die Adresse
wird bereits verwendet


例 1ソケットの例: 簡易TCP/IPサーバー

この例は、簡単な応答サーバーです。変数 addressport を設定と実行環境に合うように変更して下 さい。このサーバーに次のようなコマンドで接続することが可能です。 : telnet 192.168.1.53 10000 (ただし、アドレス とポートは設定に合わせます)入力したものは、サーバー側の出力とな り、エコーバックされます。接続を閉じるには、'quit'を入力します。

 ?php
error_reporting (E_ALL);

/* Allow the script to hang around waiting for connections. */
set_time_limit (0);

$address = '192.168.1.53';
$port = 10000;

if (($sock = socket_create (AF_INET, SOCK_STREAM, 0))   0) {
    echo "socket_create() failed: reason: " . socket_strerror
($sock) . "\n";
}

if (($ret = socket_bind ($sock, $address, $port))   0) {
    echo "socket_bind() failed: reason: " . socket_strerror ($ret)
. "\n";
}

if (($ret = socket_listen ($sock, 5))   0) {
    echo "socket_listen() failed: reason: " . socket_strerror
($ret) . "\n";
}

do {
    if (($msgsock = socket_accept($sock))   0) {
        echo "socket_accept() failed: reason: " . socket_strerror
($msgsock) . "\n";
        break;
    }
    do {
        $buf = socket_read ($msgsock, 2048);
        if ($buf == FALSE) {
            echo "socket_read() failed: reason: " . socket_strerror
($ret) . "\n";
            break 2;
        }
        if (!$buf) {
            break 2;
        }
        $buf = trim ($buf);
        if ($buf == 'quit') {
            socket_close ($msgsock);
            break 2;
        }
        $talkback = "PHP: You said '$buf'.\n";
        socket_write ($msgsock, $talkback, strlen ($talkback));
        echo "$buf\n";
    } while (true);
    socket_close ($msgsock);
} while (true);

socket_close ($sock);
? 


例 2ソケットの例: 簡易 TCP/IP クライアント

この例は、簡単な一回限りのHTTPクライアントです。ここでは、あるペー ジに接続し、HEADリクエストを送信し、応答を出力た後、終了します。

 ?php
error_reporting (E_ALL);

echo " h2 TCP/IP Connection /h2 \n";

/* Get the port for the WWW service. */
$service_port = getservbyname ('www', 'tcp');

/* Get the IP address for the target host. */
$address = gethostbyname ('www.php.net');

/* Create a TCP/IP socket. */
$socket = socket_create (AF_INET, SOCK_STREAM, 0);
if ($socket   0) {
    echo "socket_create() failed: reason: " . socket_strerror
($socket) . "\n";
} else {
    "socket_create() successful: " . socket_strerror ($socket) .
"\n";
}

echo "Attempting to connect to '$address' on port
'$service_port'...";
$result = socket_connect ($socket, $address, $service_port);
if ($result   0) {
    echo "socket_connect() failed.\nReason: ($result) " .
socket_strerror($result) . "\n";
} else {
    echo "OK.\n";
}

$in = "HEAD / HTTP/1.0\r\n\r\n";
$out = '';

echo "Sending HTTP HEAD request...";
socket_write ($socket, $in, strlen ($in));
echo "OK.\n";

echo "Reading response:\n\n";
while ($out = socket_read ($socket, 2048)) {
    echo $out;
}

echo "Closing socket...";
socket_close ($socket);
echo "OK.\n\n";
? 


目次
socket_accept -- ソケットへの接続を許可する
bind -- ソケットに名前をバインドする
socket_clear_error -- Clears the error on the socket or the last error code
socket_close -- ファイル記述子を閉じる
socket_connect -- ソケット上の接続を初期化する
socket_create_listen -- 接続を受けつけるためにポートにソケットをオープンする
socket_create_pair -- 区別できないソケットの組を作成し、fdに保存する
socket_create -- ソケットを作成する(通信時の終端)
socket_get_option -- Gets socket options for the socket
socket_getpeername -- fdを指定、ソケットのリモート側を既述するsa.sin_addrおよび sa.sin_portの値をaddrおよびportの文字列に保存する
socket_getsockname -- fdを指定、ソケットのローカル側を既述するsa.sin_addrおよび sa.sin_portの値をaddrおよびportの文字列に保存する
socket_iovec_add -- 新規ベクトルを収集用配列に追加する
socket_iovec_alloc -- sendmsg, recvmsg, writev, readvで使用するよう'struct iovec'を構築する
socket_iovec_delete -- ベクトルの配列からベクトルを削除する
socket_iovec_fetch -- iovec_id[iovec_position] で指定したiovecに保存されたデータを返す
socket_iovec_free -- iovec_idで指定したiovecを解放する
socket_iovec_set -- iovec_id[iovec_position]に保持されたデータにnew_valを設定する
socket_last_error -- ソケットの直近のエラーを返す/クリアする
socket_listen -- ソケット上で接続待ち(listen)する
socket_read -- ソケットから読みこむ
socket_readv -- iovec_idで定義した収集用配列を用いてfdから読み込む
socket_recv -- 接続したソケットからデータを受信する
socket_recvfrom -- 接続しているかどうかによらず、ソケットからデータを受信する
socket_recvmsg -- 接続用であるかどうかにかかわらずソケットのメッセージを受信する
socket_select -- tv_secとtv_usec で指定した有効時間でselect()システムコールを実行 する
socket_send -- 接続したソケットにデータを送信する
socket_sendmsg -- 接続用であるかどうかにかかわらずソケットにメッセージを送信する
socket_sendto -- 接続しているかどうかによらずソケットにメッセージを送信する
socket_set_nonblock -- ファイル記述子fdを非ブロックモードに設定する
socket_set_option -- Sets socket options for the socket
socket_shutdown -- 受信、送信、または送受信用のソケットをシャットダウンする
socket_strerror -- ソケットエラーの内容を文字列として返す
socket_write -- ソケットに書き込む
socket_writev -- iovec_idで定義した収集用配列を用いてファイル記述子fdに書き込む