- 1.1 序言
- 1.2 原理
- 1.3 开发必读
- 1.4 入门指引
- 1.4.1 特性
- 1.4.2 简单的开发示例
- 1.5 安装
- 1.5.1 环境要求
- 1.5.2 下载安装
- 1.5.3 启动停止
- 1.6 开发流程
- 1.6.1 开发前必读
- 1.6.2 目录结构
- 1.6.3 开发规范
- 1.6.4 基本流程
- 1.7 通讯协议
- 1.7.1 通讯协议作用
- 1.7.2 定制通讯协议
- 1.7.3 一些例子
- 1.8 Worker类
- 1.8.1 构造函数
- 1.8.2 属性
- 1.8.2.1 id
- 1.8.2.2 count
- 1.8.2.3 name
- 1.8.2.4 protocol
- 1.8.2.5 transport
- 1.8.2.6 reusePort
- 1.8.2.7 connections
- 1.8.2.8 stdoutFile
- 1.8.2.9 pidFile
- 1.8.2.10 logFile
- 1.8.2.11 user
- 1.8.2.12 reloadable
- 1.8.2.13 daemonize
- 1.8.2.14 globalEvent
- 1.8.3 回调属性
- 1.8.3.1 onWorkerStart
- 1.8.3.2 onWorkerReload
- 1.8.3.3 onConnect
- 1.8.3.4 onMessage
- 1.8.3.5 onClose
- 1.8.3.6 onBufferFull
- 1.8.3.7 onBufferDrain
- 1.8.3.8 onError
- 1.8.4 接口
- 1.8.4.1 runAll
- 1.8.4.2 stopAll
- 1.8.4.3 listen
- 1.9 TcpConnection类
- 1.9.1 属性
- 1.9.1.1 id
- 1.9.1.2 protocol
- 1.9.1.3 worker
- 1.9.1.4 maxSendBufferSize
- 1.9.1.5 defaultMaxSendBufferSize
- 1.9.1.6 defaultMaxPackageSize
- 1.9.2 回调属性
- 1.9.2.1 onMessage
- 1.9.2.2 onClose
- 1.9.2.3 onBufferFull
- 1.9.2.4 onBufferDrain
- 1.9.2.5 onError
- 1.9.3 接口
- 1.9.3.1 send
- 1.9.3.2 getRemoteIp
- 1.9.3.3 getRemotePort
- 1.9.3.4 close
- 1.9.3.5 destroy
- 1.9.3.6 pauseRecv
- 1.9.3.7 resumeRecv
- 1.9.3.8 pipe
- 1.10 AsyncTcpConnection类
- 1.10.1 __construct
- 1.10.2 connect
- 1.10.3 reconnect
- 1.10.4 transport
- 1.11 AsyncUdpConnection类
- 1.11.1 __construct
- 1.11.2 connect
- 1.11.3 send
- 1.11.4 close
- 1.12 Timer定时器类
- 1.12.1 add
- 1.12.2 del
- 1.12.3 定时器注意事项
- 1.14 调试
- 1.14.1 基本调试
- 1.14.2 status命令查看运行状态
- 1.14.3 调试busy进程
- 1.14.4 网络抓包
- 1.14.5 跟踪系统调用
- 1.15 常用组件
- 1.15.1 GlobalData数据共享组件
- 1.15.1.1 GlobalDataServer
- 1.15.1.2 GlobalDataClient
- 1.15.1.2.1 add
- 1.15.1.2.2 cas
- 1.15.1.2.3 increment
- 1.15.2 Channel分布式通讯组件
- 1.15.2.1 ChannelServer
- 1.15.2.2 channelClient
- 1.15.2.2.1 connect
- 1.15.2.2.2 on
- 1.15.2.2.3 publish
- 1.15.2.2.4 unsubsribe
- 1.15.2.3 例子-集群推送
- 1.15.2.4 例子-分组发送
- 1.15.3 FileMonitor文件监控组件
- 1.15.4 MySQL组件
- 1.15.4.1 workerman/mysql
- 1.15.4.2 react/mysql(异步)
- 1.15.4.3 其它数据库类
- 1.15.5 redis组件
- 1.15.5.1 react/redis
- 1.15.6.1 workerman/http-client
- 1.15.6.2 react/http-client
- 1.15.7 异步消息队列组件
- 1.15.7.1 react/zmq
- 1.15.7.2 react/stomp
- 1.15.8 异步MQTT组件
- 1.15.8.1 workemran/mqtt
- 1.15.9.1 react/dns
- 1.15.10 memcache
- 1.16 常见问题
- 1.16.1 心跳
- 1.16.2 客户端连接失败原因
- 1.16.3 是否支持多线程
- 1.16.4 与其它框架整合
- 1.16.5 运行多个workerman
- 1.16.6 支持哪些协议
- 1.16.7 如何设置进程数
- 1.16.8 查看客户端连接数
- 1.16.9 对象和资源的持久化
- 1.16.10 例子无法工作
- 1.16.11 启动失败
- 1.16.12 停止失败
- 1.16.13 支持多少并发
- 1.16.14 更改代码不生效
- 1.16.15 向指定客户端发送数据
- 1.16.16 如何主动推送消息
- 1.16.17 在其它项目中推送
- 1.16.18 如何实现异步任务
- 1.16.19 status里send_fail的原因
- 1.16.20 Windows下开发Linux下部署
- 1.16.21 是否支持socket.io
- 1.16.22 终端关闭导致workerman关闭
- 1.16.23 与nginx apache的关系
- 1.16.24 禁用函数检查
- 1.16.25 平滑重启原理
- 1.16.26 为Flash开843端口
- 1.16.27 如何广播数据
- 1.16.28 如何建立udp服务
- 1.16.29 监听ipv6
- 1.16.30 关闭未认证的连接
- 1.16.31 传输加密-ssl/tls
- 1.16.32 创建wss服务
- 1.16.33 创建https服务
- 1.16.34 workerman作为客户端
- 1.16.35 作为ws/wss客户端
- 1.16.36 微信小程序
- 1.16.37 PHP的几种回调写法
- 1.16.38 透过代理获取客户端真实ip
- 1.16.39 开机启动
- 1.16.40 接收和发送16进制数据
- 1.16.41 接收一定请求后重启
- 1.16.42 win下初始化多个worker
- 1.17.1 优化Linux内核
- 1.17.2 压力测试
- 1.17.3 安装扩展
- 1.17.4 websocket协议
- 1.17.5 ws协议
- 1.17.6 text协议
- 1.17.7 frame协议
- 1.17.8 不支持的函数/特性
1.8.1 构造函数
说明:
Worker::__construct([string $listen , array $context])
初始化一个Worker容器实例,可以设置容器的一些属性和回调接口,完成特定功能。
参数
$listen
(可选参数,不填写表示不监听任何端口)
如果有设置监听$listen
参数,则会执行socket监听。
$listen 的格式为 <协议>://<监听地址>
<协议> 可以为以下格式:
tcp: 例如 tcp://0.0.0.0:8686
udp: 例如 udp://0.0.0.0:8686
unix: 例如 unix:///tmp/my_file
(需要Workerman>=3.2.7)
http: 例如 http://0.0.0.0:80
websocket: 例如 websocket://0.0.0.0:8686
text: 例如 text://0.0.0.0:8686
(text是Workerman内置的文本协议,兼容telnet,详情参见附录Text协议部分)
以及其他自定义协议,参见本手册定制通讯协议部分
<监听地址> 可以为以下格式:
如果是unix套接字,地址为本地一个磁盘路径
非unix套接字,地址格式为 <本机ip>:<端口号>
<本机ip>可以为0.0.0.0
表示监听本机所有网卡,包括内网ip和外网ip及本地回环127.0.0.1
<本机ip>如果以为127.0.0.1
表示监听本地回环,只能本机访问,外部无法访问
<本机ip>如果为内网ip,类似192.168.xx.xx
,表示只监听内网ip,则外网用户无法访问
<本机ip>设置的值不属于本机ip则无法执行监听,并且提示Cannot assign requested address
错误
注意:<端口号>不能大于65535。<端口号>如果小于1024则需要root权限才能监听。监听的端口必须是本机未被占用的端口,否则无法监听,并且提示Address already in use
错误
$context
一个数组。用于传递socket的上下文选项,参见套接字上下文选项
范例
Worker作为http容器监听处理http请求
use WorkermanWorker;
require_once './Workerman/Autoloader.php';
$worker = new Worker('http://0.0.0.0:8686');
$worker->onMessage = function($connection, $request)
{
$connection->send("hello");
};
// 运行worker
Worker::runAll();
Worker作为websocket容器监听处理websocket请求
use WorkermanWorker;
require_once './Workerman/Autoloader.php';
$worker = new Worker('websocket://0.0.0.0:8686');
$worker->onMessage = function($connection, $data)
{
$connection->send("hello");
};
// 运行worker
Worker::runAll();
Worker作为tcp容器监听处理tcp请求
use WorkermanWorker;
require_once './Workerman/Autoloader.php';
$worker = new Worker('tcp://0.0.0.0:8686');
$worker->onMessage = function($connection, $data)
{
$connection->send("hello");
};
// 运行worker
Worker::runAll();
Worker作为udp容器监听处理udp请求
use WorkermanWorker;
require_once './Workerman/Autoloader.php';
$worker = new Worker('udp://0.0.0.0:8686');
$worker->onMessage = function($connection, $data)
{
$connection->send("hello");
};
// 运行worker
Worker::runAll();
Worker监听unix domain套接字(要求Workerman版本>=3.2.7)
use WorkermanWorker;
require_once './Workerman/Autoloader.php';
$worker = new Worker('unix:///tmp/my.sock');
$worker->onMessage = function($connection, $data)
{
$connection->send("hello");
};
// 运行worker
Worker::runAll();
不执行任何监听的Worker容器,用来处理一些定时任务
use WorkermanWorker;
use WorkermanLibTimer;
require_once './Workerman/Autoloader.php';
$task = new Worker();
$task->onWorkerStart = function($task)
{
// 每2.5秒执行一次
$time_interval = 2.5;
Timer::add($time_interval, function()
{
echo "task runn";
});
};
// 运行worker
Worker::runAll();
Worker监听自定义协议的端口
最终的目录结构
├── Protocols // 这是要创建的Protocols目录
│ └── MyTextProtocol.php // 这是要创建的自定义协议文件
├── test.php // 这是要创建的test脚本
└── Workerman // Workerman源码目录,里面代码不要动
1、创建Protocols目录,并创建一个协议文件 Protocols/MyTextProtocol.php(参照上面目录结构)
// 用户自定义协议命名空间统一为Protocols
namespace Protocols;
//简单文本协议,协议格式为 文本+换行
class MyTextProtocol
{
// 分包功能,返回当前包的长度
public static function input($recv_buffer)
{
// 查找换行符
$pos = strpos($recv_buffer, "n");
// 没找到换行符,表示不是一个完整的包,返回0继续等待数据
if($pos === false)
{
return 0;
}
// 查找到换行符,返回当前包的长度,包括换行符
return $pos+1;
}
// 收到一个完整的包后通过decode自动解码,这里只是把换行符trim掉
public static function decode($recv_buffer)
{
return trim($recv_buffer);
}
// 给客户端send数据前会自动通过encode编码,然后再发送给客户端,这里加了换行
public static function encode($data)
{
return $data."n";
}
}
2、使用MyTextProtocol协议监听处理请求
参照上面最终目录结构创建test.php文件
require_once './Workerman/Autoloader.php';
use WorkermanWorker;
// #### MyTextProtocol worker ####
$text_worker = new Worker("MyTextProtocol://0.0.0.0:5678");
/*
* 收到一个完整的数据(结尾是换行)后,自动执行MyTextProtocol::decode('收到的数据')
* 结果通过$data传递给onMessage回调
*/
$text_worker->onMessage = function($connection, $data)
{
var_dump($data);
/*
* 给客户端发送数据,会自动调用MyTextProtocol::encode('hello world')进行协议编码,
* 然后再发送到客户端
*/
$connection->send("hello world");
};
// run all workers
Worker::runAll();
3、测试
打开终端,进入到test.php所在目录,执行php test.php start
php test.php start
Workerman[test.php] start in DEBUG mode
----------------------- WORKERMAN -----------------------------
Workerman version:3.2.7 PHP version:5.4.37
------------------------ WORKERS -------------------------------
user worker listen processes status
root none myTextProtocol://0.0.0.0:5678 1 [OK]
----------------------------------------------------------------
Press Ctrl-C to quit. Start success.
打开终端,利用telnet测试(建议用linux系统的telnet)
假设是本机测试, 终端执行 telnet 127.0.0.1 5678 然后输入 hi回车 会接收到数据hello worldn
telnet 127.0.0.1 5678
Trying 127.0.0.1...
Connected to 127.0.0.1.
Escape character is '^]'.
hi
hello world
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论