Swoole server事件回调函数

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

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

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来区分不一样时间间隔的定时器。