PHP与socket编程

前言

PHP的socket连接函数有三种方案

• 1、集成于内核的socket
  • fsockopen
  • pfsockopen
• 2、PHP扩展模块带有的socket功能， 编译PHP时必须在配置中添加 --enable-sockets 配置项来启用
  • socket_create
  • socket_bind
  • socket_connect
  • socket_accept
• 3、基于Streams流化概念的功能
  • stream_socket_server
  • stream_socket_client
  • stream_socket_accept

本文档讨论第二种方案

Socket 基础

PHP 使用Berkley的socket库来创建它的连接。socket只不过是一个数据结构。使用socket数据结构去开启一个客户端和服务器之间的会话。服务器一直在监听准备产生一个新的会话。当一个客户端连接服务器，它就打开服务器正在进行监听的一个端口进行会话。这时，服务器端接受客户端的连接请求，那么就进行一次循环。现在这个客户端就能够发送信息到服务器，服务器也能发送信息给客户端。
产生一个Socket，需要三个变量：一个协议、一个socket类型和一个公共协议类型。

• 一：协议

名字/常量	描述
AF_INET	这是大多数用来产生socket的协议，使用TCP或UDP来传输，用在IPv4的地址
AF_INET6	与上面类似，不过是来用在IPv6的地址
AF_UNIX	本地协议，使用在Unix和Linux系统上，它很少使用，一般都是当客户端和服务器在同一台及其上的时候使用

• 二：Socket类型

名字/常量	描述
SOCK_STREAM	这个协议是按照顺序的、可靠的、数据完整的基于字节流的连接。这是一个使用最多的socket类型，这个socket是使用TCP来进行传输。
SOCK_DGRAM	这个协议是无连接的、固定长度的传输调用。该协议是不可靠的，使用UDP来进行它的连接。
SOCK_SEQPACKET	这个协议是双线路的、可靠的连接，发送固定长度的数据包进行传输。必须把这个包完整的接受才能进行读取。
SOCK_RAW	这个socket类型提供单一的网络访问，这个socket类型使用ICMP公共协议。（ping、traceroute使用该协议）
SOCK_RDM	这个类型是很少使用的，在大部分的操作系统上没有实现，它是提供给数据链路层使用，不保证数据包的顺序

• 三：公共协议

名字/常量	描述
ICMP	互联网控制消息协议，主要使用在网关和主机上，用来检查网络状况和报告错误信息
UDP	用户数据报文协议，它是一个无连接，不可靠的传输协议
TCP	传输控制协议，这是一个使用最多的可靠的公共协议，它能保证数据包能够到达接受者那儿，如果在传输过程中发生错误，那么它将重新发送出错数据包。

使用PHP socket扩展

• 服务器端代码：

编写服务器时，首先必须在服务器套接字上使用stream_socket_accept功能执行"accept"操作。此函数阻塞，直到客户端连接到服务器，否则超时超时。

//确保在连接客户端时不会超时
set_time_limit(0);
//设置IP和端口号
$address = "127.0.0.1";
$port    = 2046;

/**
 * 创建一个SOCKET
 * AF_INET=是ipv4 如果用ipv6，则参数为 AF_INET6
 * SOCK_STREAM为socket的tcp类型，如果是UDP则使用SOCK_DGRAM
 */
$sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP) or die_error();
//阻塞模式
socket_set_block($sock) or die_error();
//绑定到socket端口
$result = socket_bind($sock, $address, $port) or die_error();
//开始监听
$result = socket_listen($sock, 4) or die_error();
echo "OK\nBinding the socket on $address:$port ... ";
echo "OK\nNow ready to accept connections.\nListening on the socket ... \n";
do {
    // never stop the daemon
    //它接收连接请求并调用一个子连接Socket来处理客户端和服务器间的信息
    $msgsock = socket_accept($sock) or die_error();

    //读取客户端数据
    echo "Read client data \n";
    //socket_read函数会一直读取客户端数据,直到遇见\n,\t或者\0字符.PHP脚本把这写字符看做是输入的结束符.
    $buf = socket_read($msgsock, 8192);
    echo "Received msg: $buf  \n";

    //数据传送 向客户端写入返回结果
    $msg = "welcome \n";
    socket_write($msgsock, $msg, strlen($msg)) or die_error();
    //一旦输出被返回到客户端,父/子socket都应通过socket_close($msgsock)函数来终止
    socket_close($msgsock);
} while (true);
socket_close($sock);

/**
 * 展示错误
 * @return string
 */
function die_error(){
    $errorcode = socket_last_error();
    $errormsg = socket_strerror($errorcode);
    die("Couldn't create socket: [$errorcode] $errormsg" . PHP_EOL);
}

• 客户端代码：

set_time_limit(0);

$host   = "127.0.0.1";
$port   = 2046;
// 创建一个Socket
$socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP) or die_error();

// 连接socket
$connection = socket_connect($socket, $host, $port) or die_error();
// 数据传送 向服务器发送消息
socket_write($socket, "hello socket") or die_error();
while ($buff = socket_read($socket, 1024, PHP_NORMAL_READ)) {
    echo ("Response was:" . $buff . "\n");
}
socket_close($socket);

/**
 * 展示错误
 * @return string
 */
function die_error(){
    $errorcode = socket_last_error();
    $errormsg = socket_strerror($errorcode);
    die("Couldn't create socket: [$errorcode] $errormsg" . PHP_EOL);
}

PHP_BINARY_READ - 使用系统recv（）函数。用于读取二进制数据的安全。 （在PHP>"默认= 4.1.0）
PHP_NORMAL_READ - 读停在\ n或\r（在PHP <= 4.0.6默认）
针对参数PHP_NORMAL_READ ，如果服务器的响应结果没有\ n。造成socket_read(): unable to read from socket

Socket函数

函数名	描述
socket_accept()	接受一个Socket连接
socket_bind()	把socket绑定在一个IP地址和端口上
socket_clear_error()	清除socket的错误或者最后的错误代码
socket_close()	关闭一个socket资源
socket_connect()	开始一个socket连接
socket_create_listen()	在指定端口打开一个socket监听
socket_create_pair()	产生一对没有区别的socket到一个数组里
socket_create()	产生一个socket，相当于产生一个socket的数据结构
socket_get_option()	获取socket选项
socket_getpeername()	获取远程类似主机的ip地址
socket_getsockname()	获取本地socket的ip地址
socket_iovec_add()	添加一个新的向量到一个分散/聚合的数组
socket_iovec_alloc()	这个函数创建一个能够发送接收读写的iovec数据结构
socket_iovec_delete()	删除一个已经分配的iovec
socket_iovec_fetch()	返回指定的iovec资源的数据
socket_iovec_free()	释放一个iovec资源
socket_iovec_set()	设置iovec的数据新值
socket_last_error()	获取当前socket的最后错误代码
socket_listen()	监听由指定socket的所有连接
socket_read()	读取指定长度的数据
socket_readv()	读取从分散/聚合数组过来的数据
socket_recv()	从socket里结束数据到缓存
socket_recvfrom()	接受数据从指定的socket，如果没有指定则默认当前socket
socket_recvmsg()	从iovec里接受消息
socket_select()	多路选择
socket_send()	这个函数发送数据到已连接的socket
socket_sendmsg()	发送消息到socket
socket_sendto()	发送消息到指定地址的socket
socket_set_block()	在socket里设置为块模式
socket_set_nonblock()	socket里设置为非块模式
socket_set_option()	设置socket选项
socket_shutdown()	这个函数允许你关闭读、写、或者指定的socket
socket_strerror()	返回指定错误号的详细错误
socket_write()	写数据到socket缓存
socket_writev()	写数据到分散/聚合数组

基于Streams流的Socket

• 服务端：

# server.php
$addr  = '127.0.0.1';
$port  = 80;
/**
 * 指定协议，绑定端口，添加引用两个错误信息提示参数
 * 这一步完成了sokect 绑定
 */
$server = stream_socket_server("tcp://$addr:$port", $errno, $errorMessage);

if ($server === false) {
    throw new UnexpectedValueException("Could not bind to socket: $errorMessage");
}

for (;;) {
    //它接收连接请求并调用一个子连接Socket来处理客户端和服务器间的信息
    $client = @stream_socket_accept($server);

    if ($client) {
        //从第一个参数的流中复制字节，将其作为第二个参数流,返回客户端请求内容
        stream_copy_to_stream($client, $client);
        //关闭客户端连接
        fclose($client);
    }
}

• 客户端：

# client.php
//连接的主机的IP地址
//$addr = gethostbyname("www.example.com");
$addr = '127.0.0.1';
$port = 80;
//创建socket连接
$client = stream_socket_client("tcp://$addr:$port", $errno, $errorMessage);

if ($client === false) {
    throw new UnexpectedValueException("Failed to connect: $errorMessage");
}

//套接字连接由stream_socket_client是溪流，就像通过fopen打开文件
fwrite($client, "GET / HTTP/1.0\r\nHost: www.example.com\r\nAccept: */*\r\n\r\n");
//获取响应
echo stream_get_contents($client);
fclose($client);