構造函數 __construct

說明:

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 Workerman\Worker;
use Workerman\Connection\TcpConnection;
use Workerman\Protocols\Http\Request;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('http://0.0.0.0:8686');

$worker->onMessage = function(TcpConnection $connection, Request $request)
{
    $connection->send("hello");
};

// 運行 worker
Worker::runAll();

Worker 作為 websocket 容器監聽處理 websocket 請求

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('websocket://0.0.0.0:8686');

$worker->onMessage = function(TcpConnection $connection, $data)
{
    $connection->send("hello");
};

// 運行 worker
Worker::runAll();

Worker 作為 tcp 容器監聽處理 tcp 請求

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('tcp://0.0.0.0:8686');

$worker->onMessage = function(TcpConnection $connection, $data)
{
    $connection->send("hello");
};

// 運行 worker
Worker::runAll();

Worker 作為 udp 容器監聽處理 udp 請求

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('udp://0.0.0.0:8686');

$worker->onMessage = function(TcpConnection $connection, $data)
{
    $connection->send("hello");
};

// 運行 worker
Worker::runAll();

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

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('unix:///tmp/my.sock');

$worker->onMessage = function(TcpConnection $connection, $data)
{
    $connection->send("hello");
};

// 運行 worker
Worker::runAll();

不執行任何監聽的 Worker 容器,用來處理一些定時任務

use \Workerman\Worker;
use \Workerman\Timer;
require_once __DIR__ . '/vendor/autoload.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 監聽自定義協議的端口

最終的目錄結構

├── 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 文件

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
require_once __DIR__ . '/vendor/autoload.php';

// #### MyTextProtocol worker ####
$text_worker = new Worker("MyTextProtocol://0.0.0.0:5678");

/*
 * 收到一個完整的數據(結尾是換行)後,自動執行 MyTextProtocol::decode('收到的數據')
 * 結果通過$data傳遞給 onMessage 回調
 */
$text_worker->onMessage =  function(TcpConnection $connection, $data)
{
    var_dump($data);
    /*
     * 給客戶端發送數據,會自動調用 MyTextProtocol::encode('hello world') 進行協議編碼,
     * 然後再發送到客戶端
     */
    $connection->send("hello world");
};

// 運行所有 worker
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 world\n

telnet 127.0.0.1 5678
Trying 127.0.0.1...
Connected to 127.0.0.1.
Escape character is '^]'.
hi
hello world