Swoole server事件回调函数

在swoole中，一个swoole_server的拥有若干回调函数，这些回调函数决定了swoole_server的相关功能。可以通过

$serv->on( string $event, mixed $callback );

函数来配置. 示例：

class Server
{
    private $serv;
    public function __construct() {
        $this->serv = new swoole_server("0.0.0.0", 9501);
        $this->serv->set(array(
            'worker_num' => 8,
            'daemonize' => false,
            'max_request' => 10000,
            'dispatch_mode' => 2,
            'debug_mode'=> 1
        ));
        $this->serv->on('Start', array($this, 'onStart'));
        $this->serv->on('Connect', array($this, 'onConnect'));
        $this->serv->on('Receive', array($this, 'onReceive'));
        $this->serv->on('Close', array($this, 'onClose'));
        $this->serv->start();
    }
}

全部回调函数以及相关介绍如下：

TOC

1.onReceive

描述：接收数据的回调

函数原型：

function onReceive( swoole_server $serv, $fd, $from_id, $data );

参数	描述
$serv	swoole_server对象
$fd	连接的描述符
$from_id	reactor的id，无用
$data	接收到的数据

说明：每当server接收到客户端发来的数据后，就会通过onReceive回调将数据投递给Worker。如果开启了协议检测，则会在收到完整数据包之后才会响应回调。注意，必须设置该回调函数，否则无法启动服务器。

2.onStart

描述：服务器启动的回调

函数原型：

function onStart( swoole_server $serv);

参数	描述
$serv	swoole_server对象

说明：

onStart事件在Master进程的主线程中被调用。在此回调响应之前Swoole Server已进行了如下操作

• 已创建了manager进程
• 已创建了worker子进程
• 已监听所有TCP/UDP端口
• 已监听了定时器

接下来要执行

• 主Reactor开始接收事件，客户端可以connect到Server

onStart回调中，仅允许echo、打印Log、修改进程名称。不得执行其他操作。onWorkerStart和onStart回调是在不同进程中并行执行的，不存在先后顺序。 可以在onStart回调中，将$serv->master_pid和$serv->manager_pid的值保存到一个文件中。这样可以编写脚本，向这两个PID发送信号来实现关闭和重启的操作。

从1.7.5+ Master进程内不再支持定时器，onMasterConnect/onMasterClose2个事件回调也彻底移除。Master进程内不再保留任何PHP的接口。

在onStart中创建的全局资源对象不能在worker进程中被使用，因为发生onStart调用时，worker进程已经创建好了。新创建的对象在主进程内，worker进程无法访问到此内存区域，因此全局对象创建的代码需要放置在swoole_server_start之前。

3.onWorkerStart

描述：Worker进程启动的回调

函数原型：

function onWorkerStart( swoole_server $serv，int $worker_id);

参数	描述
$serv	swoole_server对象
$worker_id	Worker进程的id

说明：此事件在worker进程/task_worker启动时发生。

发生PHP致命错误或者代码中主动调用exit时，Worker/Task进程会退出，管理进程会重新创建新的进程 onWorkerStart/onStart是并发执行的，没有先后顺序

通过$worker_id参数的值来，判断worker是普通worker还是task_worker。$worker_id>= $serv->setting'worker_num' 时表示这个进程是task_worker。

如果想使用swoole_server_reload实现代码重载入，必须在workerStart中require你的业务文件，而不是在文件头部。在onWorkerStart调用之前已包含的文件，不会重新载入代码。

可以将公用的，不易变的php文件放置到onWorkerStart之前。这样虽然不能重载入代码，但所有worker是共享的，不需要额外的内存来保存这些数据。

onWorkerStart之后的代码每个worker都需要在内存中保存一份 $worker_id是一个从0-$worker_num之间的数字，表示这个worker进程的ID $worker_id和进程PID没有任何关系

4.onConnect

描述：新连接接入时的回调

函数原型：

function onConnect( swoole_server $serv，int $fd, int $from_id);

参数	描述
$serv	swoole_server对象
$fd	连接的描述符
$from_id	reactor的id，无用

说明：有新的连接进入时，在worker进程中回调。onConnect/onClose这2个回调发生在worker进程内，而不是主进程。如果需要在主进程处理连接/关闭事件，请注册onMasterConnect/onMasterClose回调。onMasterConnect/onMasterClose回调总是先于onConnect/onClose被执行

5.onClose

描述：连接关闭时的回调

函数原型：

function onClose( swoole_server $serv，int $fd, int $from_id);

参数	描述
$serv	swoole_server对象
$fd	连接的描述符
$from_id	reactor的id，无用

说明：TCP客户端连接关闭后，在worker进程中回调此函数。无论close由客户端发起还是服务器端主动调用swoole_server_close关闭连接，都会触发此事件。 因此只要连接关闭，就一定会回调此函数。

6.onTask

描述：task_worker进程处理任务的回调

函数原型：

function onTask(swoole_server $serv, int $task_id, int $from_id, string $data);

参数	描述
$serv	swoole_server对象
$task_id	任务ID
$from_id	来自于哪个worker进程
$data	任务内容

说明：在task_worker进程内被调用。worker进程可以使用swoole_server_task函数向task_worker进程投递新的任务。可以直接将任务结果字符串通过return方式返回给worker进程。worker进程将在onFinish回调中收到结果。注：如果serv->set(array('task_worker_num' => 8)) task_id 并不是从1-8 而是递增的。

7.onFinish

描述：task_worker进程处理任务结束的回调

函数原型：

function onFinish(swoole_server $serv, int $task_id, string $data);

参数	描述
$serv	swoole_server对象
$task_id	任务ID
$data	任务结果

说明：在此函数中会收到任务处理的结果，通过task_id和worker_id来区分不同的任务。

8.onTimer

描述：定时器触发的回调

函数原型：

function onTimer(swoole_server $serv, int $interval);

参数	描述
$serv	swoole_server对象
$interval	定时的间隔

说明：定时器被触发时，该函数被调用。通过interval来区分不同时间间隔的定时器。