tcpserver_io

简介

这是一个服务端连接后对这个 fd 操作的抽象类，这类并不是每次有新连接后都实例化一次，而是线程类初始化完成后紧跟着初始化一次
然后通过 php 线程全局对象指针指向某个 fd 进行操作
这个类必须被继承，并且一定要实现 recv 方法，每次服务端触发 recv 函数时候这个 fd 都至少有1个字节可读
继承这个类后的所有属性将不被载入，所以扩展这个类的所有属性都是无效的
比如
class my_io_class_test extends tcpserver_io
{
	public $name = '阿尔萨斯'; //这个属性并不会随着实例化后更新到 fd 的上下文
}
不过可以在构造函数里写属性，连接建立完成后总是会调用 __construct 方法
还有这个类的 __construct 和 __destruct 方法除外其他方法都是不可覆盖的
任何时候服务端触发的方法在最终返回结果不为 true 总是立即断开连接并且释放这个连接的上下文

类摘要

abstract tcpserver {
- abstract recv(void) //用户必须实现这个方法
- /* 方法 */
- void __construct(void) //连接构造函数
- void __destruct(void) //连接析构函数
- void __set(string $key, string $value) //（php魔术方法）添加一条记录
- mixed __get(string $key) //（php魔术方法）查询一条记录
- bool __isset(string $key) //（php魔术方法）判断记录是否存在
- void __unset(string $key) //（php魔术方法）删除一条记录
- int peek(string &$buffer, int $length) //窥视连接数据
- int read(string &$buffer, int $length) //读取连接数据
- int send(string $buffer) //发送连接数据
- int write(string $buffer) //写入连接数据
- bool sendfile(string $filename) //向连接发送文件
- bool end(void) //向连接发送关闭发送信号
- object thread(void) //获取当前线程实例化对象
- object server(void) //获取服务端实例化对象
- mixed sync(callable $callback) //同步回调
- int id(void) //获取连接的 id
- string ip_info(void) //获取连接的 IP 信息
- string ip_addr(void) //获取连接的 IP 地址
- string ip_port(void) //获取连接的 IP 端口
- int set_channel(string $name) //设置连接频道
- int send_them(string $buffer) //发送数据给除当前连接以外的所有连接
- bool buffer_new(int $size) //创建一个用户缓冲区
- int buffer_add(void) //将 socket 缓冲区数据读取到用户缓冲区
- string buffer_cut(int $length) //裁剪出用户缓冲区数据
- int buffer_pos(string $needle [, int $offset]) //在用户缓冲区找特定字符串
- string buffer_dup([bool $all = false]) //导出用户缓冲区数据
- string buffer_sub(int $start, int $length) //截取用户缓冲区数据
- bool wait_recv(int $timeout) //实验性，阻塞等待可读取事件
}

__construct

任何时候新的连接建立完成后会调用这个方法

class my_io_class_test extends tcpserver_io
{
	function __construct()
	{
		$this->name = '阿尔萨斯'; //这样写才有效
		return TRUE;
	}
}

__destruct

任何时候连断开后总是会调用这个方法

class my_io_class_test extends tcpserver_io
{
	function __destruct()
	{
		$this->server()->console_log('ID:%d 断开了连接', $this->id());
	}
}

__set

php 的魔术方法，保存这个连接上下文key=value的方法，目前只支持字符串

class my_io_class_test extends tcpserver_io
{
	function __construct()
	{
		$this->name = '阿尔萨斯';
		return TRUE;
	}
}

__get

php 的魔术方法，查询这个上下文key，失败返回 NULL

class my_io_class_test extends tcpserver_io
{
	function __construct()
	{
		$this->name = '阿尔萨斯';
		return TRUE;
	}
	function recv()
	{
		$len = $this->read($buf, 1024);
		$this->send($this->name . $buf);
		return TRUE;
	}
}

__isset

php 的魔术方法，查询这个上下文key是否存在，返回 true 或者 false

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		if(isset($this->name))
		{
			//...
		}
		return TRUE;
	}
}

__unset

php 的魔术方法，删除这个上下文key=value

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		if(isset($this->name))
		{
			unset($this->name);
		}
		return TRUE;
	}
}

peek

读取这个 fd 数据，并不会从 socket 缓冲区里移除这些读取到的数据，返回实际读取长度
第一个参数是引用把数据传递给某个变量，第二个参数是需要读取多少数据
注意如果不把数据读从 socket 缓冲区移除而继续丢进 IOCP 队列，会马上继续激活 recv 函数
所以每次尽量吧 socket 缓冲区数据全部移除
注意每次服务端触发 recv 方法总是可以读到至少1个字节
如果后续继续读取数据并且非阻塞 socket 没有数据时候返回 0，只有在遇到错误才返回 -1

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		$len = $this->peek($buf, 128);
		return TRUE;
	}
}

read

读取这个 fd 数据，并且从 socket 缓冲区移除读取到的数据，除外与 peek 函数调用方法一致

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		$len = $this->read($buf, 128);
		return TRUE;
	}
}

send

发送数据给这个 fd，返回实际写入长度，在遇到错误时候返回 -1
这个函数目前与 write 函数无任何区别，但是在未来的版本中不影响用户逻辑的情况下将变成异步发送机制
如果用户期望某些逻辑确定需要使用同步发送机制请用 write 方法
如果用户期望某些逻辑使用异步发送机制请用 send 代替，尽管它现在还不是异步的，以后可能就是异步的-_-b

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		$len = $this->send('最近还好吗？');
		return TRUE;
	}
}

write

写入这个 fd 数据，返回实际写入长度，在遇到错误时候返回 -1
这个函数是同步的，在没有错误的时候总是会返回与实际写入长度一致的结果

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		$len = $this->write('最近还好吗？');
		return TRUE;
	}
}

sendfile

发送一个文件，成功返回 true 失败返回 false
注意这个方法在 tcp 模式下调用 Windows 的 TransmitFile API
在 ssl 模式下使用的是通常的循环拷贝写入的做法

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		$len = $this->sendfile('./av-998.avi');
		return TRUE;
	}
}

end

向这个 fd 写入关闭发送通知，只关闭发送，成功返回 true 失败返回 false
注意这里仅关闭发送，还可以收到这个 fd 发来的数据，但是服务端却不可以在向这个 fd 继续写数据

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		return $this->end(); //可以用来做控制机制
	}
}

thread

获取当前线程实例化对象

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		print_r($this->thread());
		return TRUE;
	}
}

server

获取服务端实例化对象

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		print_r($this->server());
		return TRUE;
	}
}

sync

同步调用回调一个函数

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		$result = $this->sync(function($num){
			return $num;
		}, 123);
		return TRUE;
	}
}

id

取得当前 fd 的 id， id 范围是从 0 到最大连接数减1

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		$this->id();
		return TRUE;
	}
}

ip_info

取得当前 fd 的 ip 协议信息

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		echo $this->ip_info(), "\n";
		return TRUE;
	}
}

ip_addr

取得当前 fd 的 ip 协议地址，它是总是返回16进制32长度的字符串

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		echo $this->ip_addr(), "\n";
		return TRUE;
	}
}

ip_port

取得当前 fd 的 ip 协议端口，它是总是返回16进制4长度的字符串

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		echo $this->ip_port(), "\n";
		return TRUE;
	}
}

set_channel

设置当前 fd 所在频道，返回设置频道字符串的 hash 值 int 类型
注意这里使用的 php 内部的 hash 算法也是 times33 算法

class my_io_class_test extends tcpserver_io
{
	function __construct()
	{
		$this->set_channel('诺森德');
		return TRUE;
	}
}

send_them

把数据发送给除当前 fd 以外的所有连接

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		$this->send_them('嗨！大家好');
		return TRUE;
	}
}

buffer_new

创建一个用户缓冲区，用户缓冲区只能创建一个，推荐写在连接最终确定生效后，成功返回 true，失败返回 false

class my_io_class_test extends tcpserver_io
{
	function __construct()
	{
		return $this->buffer_new(1024); //向操作系统申请一个1024字节的缓冲区
	}
}

buffer_add

将 socket 缓冲区数据读取到用户缓冲区，返回当前缓冲区数据长度

class my_io_class_test extends tcpserver_io
{
	function __construct()
	{
		return $this->buffer_new(1024); //向操作系统申请一个1024字节的缓冲区
	}
	function recv()
	{
		$len = $this->buffer_add(); //使用这个函数来代替 read 或 peek 方法
		var_dump($len);
		return TRUE;
	}
}

buffer_cut

裁剪出用户缓冲区数据，下面是一个固定长度包的处理列子
注意：当使用 buffer_cut 方法后数据才被真正从用户缓冲区裁剪移除，目前也就只有这个一个方法

class my_io_class_test extends tcpserver_io
{
	function __construct()
	{
		return $this->buffer_new(8); //向操作系统申请一个8字节的缓冲区
	}
	function recv()
	{
		if($this->buffer_add() < 8) //使用这个函数来代替 read 或 peek 方法
		{
			//小于8字节数据继续读取
			return TRUE;
		}
		$buf = $this->buffer_cut(8); //裁剪出8个字节数据
		var_dump($buf);
		return TRUE;
	}
}

buffer_pos

在用户缓冲区找特定字符串，二进制安全，参数2是需要偏移值
找到返回位置 + 需要查找的字符串长度，其他返回 -1，可以配合 buffer_cut 使用
默认为上次缓冲区数据偏移 - 需要查找的字符串，这样有助于搜索速度找过的数据没有必要在从头找一遍，除非用户自己设定偏移值

class my_io_class_test extends tcpserver_io
{
	function __construct()
	{
		return $this->buffer_new(8192); //向操作系统申请一个8192字节的缓冲区
	}
	function recv()
	{
		$len = $this->buffer_add(); //使用这个函数来代替 read 或 peek 方法
		$pos = $this->buffer_pos("\r\n"); //找 "\r\n" 出现处
		if($pos !== -1) //判断是否找到数据
		{
			$buf = $this->buffer_cut($pos); //配合 buffer_cut 使用
			var_dump($buf); //这样就不会出现粘包现象了
		}
		return TRUE;
	}
}

buffer_dup

导出用户缓冲区数据，默认只导出这次接收到的数据，参数2为 true 时将导出所有缓冲区数据，但是对于大缓冲区不建议这样做
其实这个方法是留给开发协议的时候检查数据用的任何时候导出大缓冲区数据都是不好的行为
如果只需要部分数据可以看看 buffer_sub 方法

class my_io_class_test extends tcpserver_io
{
	function __construct()
	{
		return $this->buffer_new(8192); //向操作系统申请一个8192字节的缓冲区
	}
	function recv()
	{
		$len = $this->buffer_add(); //使用这个函数来代替 read 或 peek 方法
		var_dump($this->buffer_dup()); //查看这次接收到什么数据
		return TRUE;
	}
}

buffer_sub

截取用户缓冲区数据，2个参数都是必填，参数1偏移值，参数2需要多少数据
如果你看到这里这个几个 buffer_ 开头的方法几乎能完成一般的协议关键包处理
后续如果还需要缓冲区的需求，请用 php 的临时文件机制处理吧，记得在析构函数里删除这个零时文件
想～～～，不对你在开发什么服务端？？需要这么复杂的数据包处理！！！

class my_io_class_test extends tcpserver_io
{
	function __construct()
	{
		return $this->buffer_new(65538); //向操作系统申请一个65538字节的缓冲区
	}
	function recv()
	{
		$len = $this->buffer_add(); //使用这个函数来代替 read 或 peek 方法
		if(len >= 2) //判断用户缓冲区时候有足够多的数据
		{
			$head = $this->buffer_sub(0, 2); //截取用户缓冲区偏移从0开始后的4个长度数据
			$need = unpack('S', $head); //转化长度，确定后续需要读取多少数据
			if($len >= $need) //判断用户缓冲区数据长度是否达到有效负载数据长度
			{
				$data = $this->buffer_cut($need); //裁剪出用户缓冲区数据
				// $this->my_callback($data); //开始调用自己写好的逻辑机制
			}
		}
		return $len < 65538; //用户缓冲区还有空间，当使用 buffer_cut 方法后数据才被真正从用户缓冲移除
	}
}

wait_recv

等待当前 fd 有数据接收，有数据接收返回 true，其他返回 false
可以理解为阻塞等待读取，不过多了一个超时设置，并且这个超时最大是 65535 秒
这个函数是实验性质，可能在未来的版本中移除，实在想不出有什么情况下会用到，又怕用到的时候没有所以暂时留下了
如果说很多地方需要那么我只能说你服务端逻辑方式有点问题，换种思路试试，不过有时候还真能解决一些头疼的问题
这里使用的是 Windows 的 WSAEventSelect 和 WaitForSingleObject API
注意的是当有可读事件会马上返回

class my_io_class_test extends tcpserver_io
{
	function recv()
	{
		$len = $this->read($buf, 1024);
		//...
		if($this->wait_recv(8)) //最多给你8秒钟考虑时间，注意这里线挂起的，这个线程就这么被无情的霸占了
		{
			//注意的是当有可读事件会马上返回，并不会真的等到8秒
			$len = $this->read($buf, 1024);
			return TRUE;
		}
		return FALSE;
	}
}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tcpserver_io.md

tcpserver_io.md

tcpserver_io

简介

类摘要

__construct

__destruct

__set

__get

__isset

__unset

peek

read

send

write

sendfile

end

thread

server

sync

id

ip_info

ip_addr

ip_port

set_channel

send_them

buffer_new

buffer_add

buffer_cut

buffer_pos

buffer_dup

buffer_sub

wait_recv

Files

tcpserver_io.md

Latest commit

History

tcpserver_io.md

File metadata and controls

tcpserver_io

简介

类摘要

__construct

__destruct

__set

__get

__isset

__unset

peek

read

send

write

sendfile

end

thread

server

sync

id

ip_info

ip_addr

ip_port

set_channel

send_them

buffer_new

buffer_add

buffer_cut

buffer_pos

buffer_dup

buffer_sub

wait_recv