构造函数 __construct

说明:

  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请求

  1. use Workerman\Worker;
  2. require_once './Workerman/Autoloader.php';
  3. $worker = new Worker('http://0.0.0.0:8686');
  4. $worker->onMessage = function($connection, $data)
  5. {
  6. var_dump($_GET, $_POST);
  7. $connection->send("hello");
  8. };
  9. // 运行worker
  10. Worker::runAll();

Worker作为websocket容器监听处理websocket请求

  1. use Workerman\Worker;
  2. require_once './Workerman/Autoloader.php';
  3. $worker = new Worker('websocket://0.0.0.0:8686');
  4. $worker->onMessage = function($connection, $data)
  5. {
  6. $connection->send("hello");
  7. };
  8. // 运行worker
  9. Worker::runAll();

Worker作为tcp容器监听处理tcp请求

  1. use Workerman\Worker;
  2. require_once './Workerman/Autoloader.php';
  3. $worker = new Worker('tcp://0.0.0.0:8686');
  4. $worker->onMessage = function($connection, $data)
  5. {
  6. $connection->send("hello");
  7. };
  8. // 运行worker
  9. Worker::runAll();

Worker作为udp容器监听处理udp请求

  1. use Workerman\Worker;
  2. require_once './Workerman/Autoloader.php';
  3. $worker = new Worker('udp://0.0.0.0:8686');
  4. $worker->onMessage = function($connection, $data)
  5. {
  6. $connection->send("hello");
  7. };
  8. // 运行worker
  9. Worker::runAll();

Worker监听unix domain套接字(要求Workerman版本>=3.2.7)

  1. use Workerman\Worker;
  2. require_once './Workerman/Autoloader.php';
  3. $worker = new Worker('unix:///tmp/my.sock');
  4. $worker->onMessage = function($connection, $data)
  5. {
  6. $connection->send("hello");
  7. };
  8. // 运行worker
  9. Worker::runAll();

不执行任何监听的Worker容器,用来处理一些定时任务

  1. use \Workerman\Worker;
  2. use \Workerman\Lib\Timer;
  3. require_once './Workerman/Autoloader.php';
  4. $task = new Worker();
  5. $task->onWorkerStart = function($task)
  6. {
  7. // 每2.5秒执行一次
  8. $time_interval = 2.5;
  9. Timer::add($time_interval, function()
  10. {
  11. echo "task run\n";
  12. });
  13. };
  14. // 运行worker
  15. Worker::runAll();

Worker监听自定义协议的端口

最终的目录结构

  1. ├── Protocols // 这是要创建的Protocols目录
  2. └── MyTextProtocol.php // 这是要创建的自定义协议文件
  3. ├── test.php // 这次要创建的test脚本
  4. └── Workerman // Workerman源码目录,里面代码不要动

1、创建Protocols目录,并创建一个协议文件
Protocols/MyTextProtocol.php(参照上面目录结构)

  1. // 用户自定义协议命名空间统一为Protocols
  2. namespace Protocols;
  3. //简单文本协议,协议格式为 文本+换行
  4. class MyTextProtocol
  5. {
  6. // 分包功能,返回当前包的长度
  7. public static function input($recv_buffer)
  8. {
  9. // 查找换行符
  10. $pos = strpos($recv_buffer, "\n");
  11. // 没找到换行符,表示不是一个完整的包,返回0继续等待数据
  12. if($pos === false)
  13. {
  14. return 0;
  15. }
  16. // 查找到换行符,返回当前包的长度,包括换行符
  17. return $pos+1;
  18. }
  19. // 收到一个完整的包后通过decode自动解码,这里只是把换行符trim掉
  20. public static function decode($recv_buffer)
  21. {
  22. return trim($recv_buffer);
  23. }
  24. // 给客户端send数据前会自动通过encode编码,然后再发送给客户端,这里加了换行
  25. public static function encode($data)
  26. {
  27. return $data."\n";
  28. }
  29. }

2、使用MyTextProtocol协议监听处理请求

参照上面最终目录结构创建test.php文件

  1. require_once './Workerman/Autoloader.php';
  2. use Workerman\Worker;
  3. // #### MyTextProtocol worker ####
  4. $text_worker = new Worker("MyTextProtocol://0.0.0.0:5678");
  5. /*
  6. * 收到一个完整的数据(结尾是换行)后,自动执行MyTextProtocol::decode('收到的数据')
  7. * 结果通过$data传递给onMessage回调
  8. */
  9. $text_worker->onMessage = function($connection, $data)
  10. {
  11. var_dump($data);
  12. /*
  13. * 给客户端发送数据,会自动调用MyTextProtocol::encode('hello world')进行协议编码,
  14. * 然后再发送到客户端
  15. */
  16. $connection->send("hello world");
  17. };
  18. // run all workers
  19. Worker::runAll();

3、测试

打开终端,进入到test.php所在目录,执行php test.php start

  1. php test.php start
  2. Workerman[test.php] start in DEBUG mode
  3. ----------------------- WORKERMAN -----------------------------
  4. Workerman version:3.2.7 PHP version:5.4.37
  5. ------------------------ WORKERS -------------------------------
  6. user worker listen processes status
  7. root none myTextProtocol://0.0.0.0:5678 1 [OK]
  8. ----------------------------------------------------------------
  9. Press Ctrl-C to quit. Start success.

打开终端,利用telnet测试(建议用linux系统的telnet)

假设是本机测试,
终端执行 telnet 127.0.0.1 5678
然后输入 hi回车
会接收到数据hello world\n

  1. telnet 127.0.0.1 5678
  2. Trying 127.0.0.1...
  3. Connected to 127.0.0.1.
  4. Escape character is '^]'.
  5. hi
  6. hello world