# 构造函数 \_\_construct
## 说明:
```php
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```](http://0.0.0.0:80%60%60%60)
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的上下文选项,参见[套接字上下文选项](http://php.net/manual/zh/context.socket.php)
## 范例
Worker作为http容器监听处理http请求
```php
use Workerman\Worker;
require_once './Workerman/Autoloader.php';
$worker = new Worker('http://0.0.0.0:8686');
$worker->onMessage = function($connection, $data)
{
var_dump($_GET, $_POST);
$connection->send("hello");
};
// 运行worker
Worker::runAll();
```
Worker作为websocket容器监听处理websocket请求
```php
use Workerman\Worker;
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请求
```php
use Workerman\Worker;
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请求
```php
use Workerman\Worker;
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)```
```php
use Workerman\Worker;
require_once './Workerman/Autoloader.php';
$worker = new Worker('unix:///tmp/my.sock');
$worker->onMessage = function($connection, $data)
{
$connection->send("hello");
};
// 运行worker
Worker::runAll();
```
不执行任何监听的Worker容器,用来处理一些定时任务
```php
use \Workerman\Worker;
use \Workerman\Lib\Timer;
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 run\n";
});
};
// 运行worker
Worker::runAll();
```
**Worker监听自定义协议的端口**
最终的目录结构
```php
├── Protocols // 这是要创建的Protocols目录
│ └── MyTextProtocol.php // 这是要创建的自定义协议文件
├── test.php // 这是要创建的test脚本
└── Workerman // Workerman源码目录,里面代码不要动
```
1、创建Protocols目录,并创建一个协议文件
Protocols/MyTextProtocol.php(参照上面目录结构)
```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文件
```php
require_once './Workerman/Autoloader.php';
use Workerman\Worker;
// #### 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
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 world\\n
```php
telnet 127.0.0.1 5678
Trying 127.0.0.1...
Connected to 127.0.0.1.
Escape character is '^]'.
hi
hello world
```
- 序言
- 原理
- 开发必读
- 入门指引
- 特性
- 简单的开发示例
- 安装
- 环境要求
- 下载安装
- 启动停止
- 开发流程
- 开发前必读
- 目录结构
- 开发规范
- 基本流程
- 通讯协议
- 通讯协议作用
- 定制通讯协议
- 一些例子
- Worker类
- 构造函数
- 属性
- id
- count
- name
- protocol
- transport
- reusePort
- connections
- stdoutFile
- pidFile
- logFile
- user
- reloadable
- daemonize
- globalEvent
- 回调属性
- onWorkerStart
- onWorkerReload
- onConnect
- onMessage
- onClose
- onBufferFull
- onBufferDrain
- onError
- 接口
- runAll
- stopAll
- listen
- TcpConnection类
- 属性
- id
- protocol
- worker
- maxSendBufferSize
- defaultMaxSendBufferSize
- maxPackageSize
- 回调属性
- onMessage
- onClose
- onBufferFull
- onBufferDrain
- onError
- 接口
- send
- getRemoteIp
- getRemotePort
- close
- destroy
- pauseRecv
- resumeRecv
- pipe
- AsyncTcpConnection类
- 构造函数
- connect
- reconnect
- transport
- Timer定时器类
- add
- del
- 定时器注意事项
- WebServer
- 调试
- 基本调试
- 查看运行状态
- 网络抓包
- 跟踪系统调用
- 常用组件
- GlobalData数据共享组件
- GlobalDataServer
- GlobalDataClient
- Channel分布式通讯组件
- ChannelServer
- channelClient
- 例子-集群推送
- 例子-分组发送
- FileMonitor文件监控组件
- MySQL组件
- workerman/mysql
- swoole/mysql(异步)
- redis组件
- swoole/redis
- 异步http组件
- swoole/http-client
- 异步消息队列组件
- react/zmq
- react/stomp
- 异步dns组件
- swoole/dns
- 常见问题
- 心跳
- 客户端链接失败原因
- 是否支持多线程
- 与其它框架整合
- 运行多个workerman
- 支持哪些协议
- 如何设置进程数
- 查看客户端连接数
- 对象和资源的持久化
- 例子无法工作
- 启动失败
- 停止失败
- 支持多少并发
- 更改代码不生效
- 向指定客户端发送数据
- 如何主动推送消息
- 在其它项目中推送
- 如何实现异步任务
- status里send_fail的原因
- Windows下开发Linux下部署
- 是否支持socket.io
- 终端关闭导致workerman关闭
- 与nginx apache的关系
- 禁用函数检查
- 平滑重启原理
- 为Flash开843端口
- 如何广播数据
- 如何建立udp服务
- 监听ipv6
- 关闭未认证的链接
- 传输加密-ssl/tsl
- 创建wss服务
- 创建https服务
- workerman作为客户端
- 作为ws/wss客户端
- PHP的几种回调写法
- 附录
- Linux内核调优
- 压力测试
- 安装扩展
- websocket协议
- ws协议
- text协议
- frame协议
- 不支持的函数/特性
- 版权信息