[edit] Last updated: Fri, 25 May 2012

stream_socket_server

(PHP 5)

stream_socket_server — インターネットドメインまたは Unix ドメインのサーバーソケットを作成する

説明

resource stream_socket_server ( string $local_socket [, int &$errno [, string &$errstr [, int $flags = STREAM_SERVER_BIND | STREAM_SERVER_LISTEN [, resource $context ]]]] )

local_socket で指定された接続ポイントに、ストリームまたはデータグラムソケットによる接続を作成します。

この関数は、ソケットのみを作成します。接続待ちの状態に入るには、 stream_socket_accept() 関数を使います。

パラメータ

local_socket

作成されるソケットのタイプは、[トランスポート]://[ターゲット] という形式の URL フォーマットによって指定されたトランスポートによって決定されます:

TCP や UDP といったインターネットドメインのソケット (AF_INET) には、remote_socket パラメータの ターゲット の部分は、ホスト名または IP アドレスと、それに続くコロンで区切られたポート番号から構成されていなければなりません。 Unix ドメインのソケットの場合は、ターゲット の部分は、ファイルシステムにおけるソケットのファイルを指定しなくてはいけません。

システムの種類によって、Unix ドメインのソケットが利用できない場合があります。利用できるトランスポートの種類は、stream_get_transports() によって知ることができます。組み込みのトランスポートのリストは、サポートされるソケットトランスポートのリストを参照ください。

errno

オプションの errno と errstr パラメータが存在するときは、そこにシステムレベルの socket()、bind() および listen() のコールにおいて発生した実際のシステムレベルのエラーを返します。もし、errno に返された値が 0 で、かつ FALSE が返された場合、bind() コールを行う前にエラーが発生したことを示しており、これは多くの場合ソケットの初期化に失敗したことを示しています。 errno と errstr パラメータは常に参照渡しとなることに留意してください。

errstr

errno の説明を参照ください。

flags

ソケット作成フラグの任意の組み合わせを指定できるビットフィールドです。

注意:
UDP ソケットに対しては、STREAM_SERVER_BIND を flags パラメータとして使用する必要があります。

context

返り値

作成したストリーム、あるいはエラー時に FALSE を返します。

例

例1 TCP サーバーソケットの使用


<?php
$socket = stream_socket_server("tcp://0.0.0.0:8000", $errno, $errstr);
if (!$socket) {
  echo "$errstr ($errno)<br />\n";
} else {
  while ($conn = stream_socket_accept($socket)) {
    fwrite($conn, 'The local time is ' . date('n/j/Y g:i a') . "\n");
    fclose($conn);
  }
  fclose($socket);
}
?>

下記の例は、PHP のスクリプトが、どうやって stream_socket_client() で示したような、問い合わせに応答するタイムサーバーとして機能するかを示したものです。

注意: 1024 番よりも小さいポート番号のサーバーソケットを作成する場合、多くのシステムでは root 権限が必要となります。

例2 UDP サーバーソケットを利用する


<?php
$socket = stream_socket_server("udp://127.0.0.1:1113", $errno, $errstr, STREAM_SERVER_BIND);
if (!$socket) {
    die("$errstr ($errno)");
}

do {
    $pkt = stream_socket_recvfrom($socket, 1, 0, $peer);
    echo "$peer\n";
    stream_socket_sendto($socket, date("D M j H:i:s Y\r\n"), 0, $peer);
} while ($pkt !== false);

?>

注意

注意: 数値で IPv6 アドレスを指定するときは、 (例 fe80::1) アドレスを角カッコでくくらなくてはなりません。たとえば、 tcp://[fe80::1]:80.

参考

stream_socket_client() - インターネットドメインまたは Unix ドメインのソケット接続を開く
stream_set_blocking() - ストリームのブロックモードを有効にする / 解除する
stream_set_timeout() - ストリームにタイムアウトを設定する
fgets() - ファイルポインタから 1 行取得する
fgetss() - ファイルポインタから 1 行取り出し、HTML タグを取り除く
fwrite() - バイナリセーフなファイル書き込み処理
fclose() - オープンされたファイルポインタをクローズする
feof() - ファイルポインタがファイル終端に達しているかどうか調べる
Curl 拡張モジュール

stream_socket_shutdown

stream_socket_sendto

[edit] Last updated: Fri, 25 May 2012

add a note User Contributed Notes stream_socket_server

Aurelien Marchand 11-Mar-2011 11:54


In the case of AF_UNIX sockets, note the named sockets that will be created respects your umask(). So if you wanted your named socket to be writeable to all, do umask(0) prior to calling stream_socket_server().



AM

frxstrem 26-Jun-2010 10:18


Using the OpenSSL extension, PHP can automatically generate self-signed SSL certificates, which can be used for basic authentication and encryption (although I would recommend to use a signed certificate instead) for SSL servers.



I have extended the script by 'e at osterman dot com' to automatically create self-signed certificates:



<?php

// Hello World! SSL HTTP Server.

// Tested on PHP 5.1.2-1+b1 (cli) (built: Mar 20 2006 04:17:24)



// Certificate data:

$dn = array(

    "countryName" => "UK",

    "stateOrProvinceName" => "Somerset",

    "localityName" => "Glastonbury",

    "organizationName" => "The Brain Room Limited",

    "organizationalUnitName" => "PHP Documentation Team",

    "commonName" => "Wez Furlong",

    "emailAddress" => "wez@example.com"

);



// Generate certificate

$privkey = openssl_pkey_new();

$cert    = openssl_csr_new($dn, $privkey);

$cert    = openssl_csr_sign($cert, null, $privkey, 365);



// Generate PEM file

# Optionally change the passphrase from 'comet' to whatever you want, or leave it empty for no passphrase

$pem_passphrase = 'comet';

$pem = array();

openssl_x509_export($cert, $pem[0]);

openssl_pkey_export($privkey, $pem[1], $pem_passphrase);

$pem = implode($pem);



// Save PEM file

$pemfile = './server.pem';

file_put_contents($pemfile, $pem);



$context = stream_context_create();



// local_cert must be in PEM format

stream_context_set_option($context, 'ssl', 'local_cert', $pemfile);

// Pass Phrase (password) of private key

stream_context_set_option($context, 'ssl', 'passphrase', $pem_passphrase);



stream_context_set_option($context, 'ssl', 'allow_self_signed', true);

stream_context_set_option($context, 'ssl', 'verify_peer', false);



// Create the server socket

$server = stream_socket_server('ssl://0.0.0.0:9001', $errno, $errstr, STREAM_SERVER_BIND|STREAM_SERVER_LISTEN, $context);



while(true)

{

    $buffer = '';

    print "waiting...";

    $client = stream_socket_accept($server);

    print "accepted " . stream_socket_get_name( $client, true) . "\n";

    if( $client )

    {

        // Read until double CRLF

        while( !preg_match('/\r?\n\r?\n/', $buffer) )

            $buffer .= fread($client, 2046); 

        // Respond to client

        fwrite($client,  "200 OK HTTP/1.1\r\n"

                         . "Connection: close\r\n"

                         . "Content-Type: text/html\r\n"

                         . "\r\n"

                         . "Hello World! " . microtime(true)

                         . "<pre>{$buffer}</pre>");

        fclose($client);

    } else {

        print "error.\n";

    }

}



?>

peterjb at me dot com 02-Jan-2010 03:48


I had a horrible time trying to shove a TLS socket into an existing TCP program.  It appears to me that functions like stream_socket_recvfrom and stream_socket_sendto don't work with TLS/SSL (which may be obvious to PHP gurus...sorry if it is, I'm in a bit over my head here).



In the end I ended up doing all my IO with fread() and fwrite(), which solved all my problems.

davidm at marketo dot com 22-Nov-2009 04:15


In some specialized scenarios, you may want to create an AF_INET socket (UDP or TCP) but let the system select an unused port for you.  This is a standard feature of internet sockets but it doesn't seem to be documented how to do this for the stream_socket_server function.  It appears you can get this behavior by selecting zero for the port number, for example, my test below printed "127.0.0.1:4960".





<?php


  $sock = stream_socket_server("udp://127.0.0.1:0"); 


  $name = stream_socket_get_name($sock);


  echo $name;


?>

Julien Picalausa 24-May-2009 01:27


You may have noticed that, unlike socket_listen, stream_socket_server doesn't have a backlog parameter. From the source code of php 5.2.9, it looks like the backlog parameter to the actual listen call is hardcoded to be 5. If this value doesn't suit your needs, you'll have to use the lower-level socket functions.

Neil Munro 05-Jul-2006 01:26


If you want a high speed socket server, use the low-level sockets instead (socket_create/bind/listen). The stream_socket_server version appears to have internal fixed 8k buffers that will overflow if you don't keep up by reading.



This is a serious problem if you an application that reads the socket for messages and then, say, saves the result in a database. The delay while it is busy processing means you can't read the data in time unless you get involved in muti-threading.



With the the low-level functions, the OS quietly buffers TCP/IP packets so there is no problem (tested on Windows XP Professional).

andrey at php dot net 07-Aug-2004 09:02


Just a small example how to use this function and also stream_select() to make a server that accepts more than one connections (can have many clients connected):

In master we hold all opened connections. Just before calling stream select we copy the array to $read and then pass it ot stream_select(). In case that we may read from at least one socket, $read will contain socket descriptors. $master is needed not to lose references to the opened connections we have.

stream_server.php : 

<?php



$master = array();

$socket = stream_socket_server("tcp://0.0.0.0:8000", $errno, $errstr);

if (!$socket) {

    echo "$errstr ($errno)<br />\n";

} else {

    $master[] = $socket;

    $read = $master;

    while (1) {

        $read = $master;

        $mod_fd = stream_select($read, $_w = NULL, $_e = NULL, 5);

        if ($mod_fd === FALSE) {

            break;

        }

        for ($i = 0; $i < $mod_fd; ++$i) {

            if ($read[$i] === $socket) {

                $conn = stream_socket_accept($socket);

                fwrite($conn, "Hello! The time is ".date("n/j/Y g:i a")."\n");

                $master[] = $conn;

            } else {

                $sock_data = fread($read[$i], 1024);

                var_dump($sock_data);

                if (strlen($sock_data) === 0) { // connection closed

                    $key_to_del = array_search($read[$i], $master, TRUE);

                    fclose($read[$i]);

                    unset($master[$key_to_del]);

                } else if ($sock_data === FALSE) {

                    echo "Something bad happened";

                    $key_to_del = array_search($read[$i], $master, TRUE);

                    unset($master[$key_to_del]);

                } else {

                    echo "The client has sent :"; var_dump($sock_data);

                    fwrite($read[$i], "You have sent :[".$sock_data."]\n");

                    fclose($read[$i]);

                     unset($master[array_search($read[$i], $master)]);

                }

            }

        }

    }

}

?>

stream_client.php:

<?php

$fp = stream_socket_client("tcp://127.0.0.1:8000", $errno, $errstr, 30);

if (!$fp) {

    echo "$errstr ($errno)<br />\n";

} else {

    fwrite($fp, "Aloha");

    while (!feof($fp)) {

        var_dump(fgets($fp, 1024));

    }

    fclose($fp);

}

?>



Thanks

add a note