[翻译] PHP的Socket函数参考

文章: Sockets

书名: 《Core PHP Programming》Third Edition

翻译: heiyeluren <heiyeluren_at_gmail.com>

这些Socket函数直接跟互联网的协议进行发送信息。相对于fopensock的流来讲,他们操作在一个比较底层的级别。通常，他们都是对C函数进行封装，并且名称都类似。如果你有使用C进行socket编程的经验，那么使用这些函数将是非常熟练的。我们这里不讨论特别详细的socket编程。

使用这些函数能够解决高层级别函数所不能解决的难题。使用这些函数能够实现类似fopen的功能，你也许有很多方法来实现socket的功能，比如在PHP中使用CLI（Command-line Interface）来实现的Internet守护进程。

resource socket_accept(resource socket)

在你的脚本服务器端中，使用socket_accept接受一个进入的连接。你必须首先产生一个socket，绑定它到一个名字，并且设置它监听一个端口。在块模式中，socket_accept将产生一个唯一接受后的连接。在非块模式中，它没有建立连接则返回false。另外，当你有了一个新的socket资源后就能够进行读写操作。

下面我们将示范一个简单的回显服务器端。它运行在CLI（命令行）下面，它在12345端口等待客户端的连接。

socket_accept

<?php

set_time_limit(0);

//create the socket

if(($socket = socket_create(AF_INET, SOCK_STREAM, 0)) < 0)

{

print("Couldn't create socket: " . socket_strerror(socket_last_error()) . "\n");

}

//bind it to the given address and port

if(($error = socket_bind($socket, gethostbyname($_SERVER['HOSTNAME']), 12345)) < 0)

{

print("Couldn't bind socket: " . socket_strerror(socket_last_error()) . "\n");

}

if(($error = socket_listen($socket, 5)) < 0)

{

print("Couldn't list on socket: " .

socket_strerror(socket_last_error()) . "\n");

}

while(TRUE)

{

//wait for connection

if(($accept = socket_accept($socket)) < 0)

{

print("Error while reading: " . socket_strerror($message) . "\n");

break;

}

//send welcome message

socket_write($accept, "Connection accepted\n");

print(date('Y-m-d H:i:s') . " STATUS: Connection accepted\n");

ob_flush();

while(TRUE)

{

//read line from client

if(FALSE === ($line = socket_read($accept, 1024)))

{

print("Couldn't read from socket: " .

socket_strerror(socket_last_error()) . "\n");

break 2;

}

if(accept]!@socket_write($accept, "ECHO: $line"))

{

print(date('Y-m-d H:i:s') . " STATUS: Connection interrupted\n");

break;

}

print(date('Y-m-d H:i:s') . " READ: $line");

ob_flush();

}

socket_close($accept);

}

bool socket_bind(resource socket, string address, integer port)

这个socket_bind()把一个socket资源绑定在一个地址上。这个socket必须由socket_create()函数返回的一个资源。这个地址必须是一个IP地址或者是一个保存Unix socket的路径。如果是运行在Internet上的socket，你还必须提供一个端口。

socket_clear_error(resource socket)

这个函数能够清除制定socket的错误，如果没有指定参数，那么将清除所有socket的错误。

socket_close(resource socket)

socket_close函数关闭一个socket并且清除该socket所占用的内存资源。

boolean socket_connect(resource socket, string address, integer port)

这个函数创建一个客户端到一个端口或者socket的连接。你必须提供一个由socket_create产生的socket。这个address参数必须到一个socket的路径或者是一个IP地址。如果是后者，还必须跟一个数字的端口号。

下面例子演示了使用UDP协议的连接到游戏服务器然后获取信息的过程。

socket_connect

<?php

//create UDP socket

if(($socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) < 0)

{

print("Couldn't create socket: " .

socket_strerror(socket_last_error()) . "\n");

}

//timeout after 5 seconds

socket_set_option($socket, SOL_SOCKET,

SO_RCVTIMEO, array('sec'=>5,'usec'=>0));

//connect to the RtCW master server

if(!socket_connect($socket, 'wolfmaster.idsoftware.com', 27950))

{

print("Couldn't connect: " .

socket_strerror(socket_last_error()) . "\n");

}

//send request for servers

socket_write($socket, "\xFF\xFF\xFF\xFFgetservers\x00");

//get servers

$server = array();

while(FALSE !== ($line = @socket_read($socket, 4096)))

{

//parse data

for($i=22; ($i+5) < strlen($line); $i += 7)

{

$ip = ord(substr($line, $i+1, 1)) . '.' .

ord(substr($line, $i+2, 1)) . '.' .

ord(substr($line, $i+3, 1)) . '.' .

ord(substr($line, $i+4, 1));

$port = (ord(substr($line, $i+5, 1)) * 256) +

ord(substr($line, $i+6, 1));

$server[] = array('ip'=>$ip, 'port'=>$port);

}

print("<h1>" . count($server) . " Servers</h1>\n");

//loop over servers, getting status

foreach($server as $s)

{

print("<h1>{$s['ip']}:{$s['port']}</h1>\n");

//connect to RtCW server

if(!socket_connect($socket, $s['ip'], $s['port']))

{

print("<p>\n" .

socket_strerror(socket_last_error()) .

"\n</p>\n");

continue;

}

//send request for status

socket_write($socket, "\xFF\xFF\xFF\xFFgetstatus\x00");

//get status from server

if(FALSE === ($line = @socket_read($socket, 1024)))

{

print("<p>\n" .

socket_strerror(socket_last_error()) .

"\n</p>\n");

continue;

}

$part = explode("\n", $line);

//settings are in second line separated by backslashes

$setting = explode("\\", $part[1]);

print("<h2>Configuration</h2>\n");

print("<p>\n");

for($s=1; $s < count($setting); $s += 2)

{

print("\t\t{$setting[$s]} = {$setting[$s+1]}<br>\n");

}

print("</p>\n");

print("<h2>Players</h2>\n");

$lastPlayer = count($part) - 1;

for($p=2; $p < $lastPlayer; $p++)

{

$player = explode(" ", $part[$p]);

print("{$player[2]} Score={$player[0]} " .

"Ping={$player[1]}<br>\n");

}

print("</p>\n");

ob_flush();

}

print("</table>\n");

socket_close($socket);

resource socket_create(integer family, integer socket_type, integer protocol)

socket_create初始化一个socket的结构。第一个参数是一个protocol family，或者域。你必须使用AF_INET来指定一个Internet连接，或者使用AF_UNIX来指定一个Unix socket连接。第二个参数是一个socket的类型，你可以从下面的表中选择。一般情况下，使用SOCK_STREAM来使用TCP协议，UDP协议使用SOCK_DGRAM。第三个参数指定为一个协议。使用SOL_TCP或SOL_UDP来分别对应TCP和UDP协议。还有一个选择是你能够使用getprotobyname函数来处理。

Socket 类型

常量描述

SOCK_DGRAM 自动寻址数据包socket

SOCK_RAW RAW协议接口

SOCK_RDM 可靠交换消息

SOCK_SEQPACKET 顺序数据包socket

SOCK_STREAM 流socket

resource socket_create_listen(integer port, integer backlog)

使用socket_create_listen是一种比socket_create更简单的产生一个socket进行监听。这个产生的socket将监听指定的端口，后面可选的参数backlog是设置允许最大的连接数。

boolean socket_create_pair(integer family, integer socket_type, integer protocol, array handles)

socket_create_pair函数产生一对socket连接。首先前三个参数是对一个socket_create的描述，这个handles参数是一个包含两个socket资源的数组。该函数是对C里面socketpair函数的封装。

socket_create_pair

<?php

if(!socket_create_pair(AF_UNIX, SOCK_STREAM, 0, $socket))

{

print("Couldn't make sockets!\n");

exit();

}

$child = pcntl_fork();

if($child == -1)

{

print("Couldn't fork!\n");

exit();

}

elseif($child > 0)

{

//parent

socket_close($socket[0]);

print("Parent: waiting for message\n");

$message = socket_read($socket[1], 1024, PHP_NORMAL_READ);

print("Parent: got message--$message\n");

socket_write($socket[1], "Hello, Child Process!\n");

pcntl_waitpid($child, $status);

}

else

{

//child

socket_close($socket[1]);

socket_write($socket[0], "Hello, Parent Process!\n");

print("Child: waiting for message\n");

$message = socket_read($socket[0], 1024, PHP_NORMAL_READ);

print("Child: got message--$message\n");

exit(0);

}

value socket_get_option(resource socket, integer level, integer option)

socket_get_option函数返回一个下表中所列的一个添加值，你必须提供一个由socket_create产生的socket资源和一个等级。这个获取的socket级别，可以使用SOL_SOCKET来确定这个级别参数。另外，使用协议，比如象SOL_TCP来表示一个TCP协议。这些选项可能是由socket_set_option设置的。

socket_get_options

<?php

$socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);

print('SO_BROADCAST: ' .