Swoole server事件回調(diào)函數(shù)

在swoole中，一個swoole_server的擁有若干回調(diào)函數(shù)，這些回調(diào)函數(shù)決定了swoole_server的相關(guān)功能?？梢酝ㄟ^

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

函數(shù)來配置. 示例：

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();
    }
}

全部回調(diào)函數(shù)以及相關(guān)介紹如下：

[TOC]

1.onReceive

描述：接收數(shù)據(jù)的回調(diào)
函數(shù)原型：

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

說明：每當server接收到客戶端發(fā)來的數(shù)據(jù)后，就會通過onReceive回調(diào)將數(shù)據(jù)投遞給Worker。如果開啟了協(xié)議檢測，則會在收到完整數(shù)據(jù)包之后才會響應(yīng)回調(diào)。注意，必須設(shè)置該回調(diào)函數(shù)，否則無法啟動服務(wù)器。

2.onStart

描述：服務(wù)器啟動的回調(diào)
函數(shù)原型：

function onStart( swoole_server $serv);

說明：
onStart事件在Master進程的主線程中被調(diào)用。在此回調(diào)響應(yīng)之前Swoole Server已進行了如下操作

• 已創(chuàng)建了manager進程
• 已創(chuàng)建了worker子進程
• 已監(jiān)聽所有TCP/UDP端口
• 已監(jiān)聽了定時器

接下來要執(zhí)行

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

onStart回調(diào)中，僅允許echo、打印Log、修改進程名稱。不得執(zhí)行其他操作。onWorkerStart和onStart回調(diào)是在不同進程中并行執(zhí)行的，不存在先后順序。 可以在onStart回調(diào)中，將$serv->master_pid和$serv->manager_pid的值保存到一個文件中。這樣可以編寫腳本，向這兩個PID發(fā)送信號來實現(xiàn)關(guān)閉和重啟的操作。
從1.7.5+ Master進程內(nèi)不再支持定時器，onMasterConnect/onMasterClose2個事件回調(diào)也徹底移除。Master進程內(nèi)不再保留任何PHP的接口。
在onStart中創(chuàng)建的全局資源對象不能在worker進程中被使用，因為發(fā)生onStart調(diào)用時，worker進程已經(jīng)創(chuàng)建好了。新創(chuàng)建的對象在主進程內(nèi)，worker進程無法訪問到此內(nèi)存區(qū)域，因此全局對象創(chuàng)建的代碼需要放置在swoole_server_start之前。

3.onWorkerStart

描述：Worker進程啟動的回調(diào)
函數(shù)原型：

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

說明：此事件在worker進程/task_worker啟動時發(fā)生。

發(fā)生PHP致命錯誤或者代碼中主動調(diào)用exit時，Worker/Task進程會退出，管理進程會重新創(chuàng)建新的進程 onWorkerStart/onStart是并發(fā)執(zhí)行的，沒有先后順序

通過$worker_id參數(shù)的值來，判斷worker是普通worker還是task_worker。$worker_id>= $serv->setting['worker_num'] 時表示這個進程是task_worker。
如果想使用swoole_server_reload實現(xiàn)代碼重載入，必須在workerStart中require你的業(yè)務(wù)文件，而不是在文件頭部。在onWorkerStart調(diào)用之前已包含的文件，不會重新載入代碼。
可以將公用的，不易變的php文件放置到onWorkerStart之前。這樣雖然不能重載入代碼，但所有worker是共享的，不需要額外的內(nèi)存來保存這些數(shù)據(jù)。
onWorkerStart之后的代碼每個worker都需要在內(nèi)存中保存一份 $worker_id是一個從0-$worker_num之間的數(shù)字，表示這個worker進程的ID $worker_id和進程PID沒有任何關(guān)系

4.onConnect

描述：新連接接入時的回調(diào)
函數(shù)原型：

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

說明：有新的連接進入時，在worker進程中回調(diào)。onConnect/onClose這2個回調(diào)發(fā)生在worker進程內(nèi)，而不是主進程。如果需要在主進程處理連接/關(guān)閉事件，請注冊onMasterConnect/onMasterClose回調(diào)。onMasterConnect/onMasterClose回調(diào)總是先于onConnect/onClose被執(zhí)行

5.onClose

描述：連接關(guān)閉時的回調(diào)
函數(shù)原型：

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

說明：TCP客戶端連接關(guān)閉后，在worker進程中回調(diào)此函數(shù)。無論close由客戶端發(fā)起還是服務(wù)器端主動調(diào)用swoole_server_close關(guān)閉連接，都會觸發(fā)此事件。 因此只要連接關(guān)閉，就一定會回調(diào)此函數(shù)。

6.onTask

描述：task_worker進程處理任務(wù)的回調(diào)
函數(shù)原型：

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

說明：在task_worker進程內(nèi)被調(diào)用。worker進程可以使用swoole_server_task函數(shù)向task_worker進程投遞新的任務(wù)?？梢灾苯訉⑷蝿?wù)結(jié)果字符串通過return方式返回給worker進程。worker進程將在onFinish回調(diào)中收到結(jié)果。注：如果serv->set(array('task_worker_num' => 8)) task_id 并不是從1-8 而是遞增的。

7.onFinish

描述：task_worker進程處理任務(wù)結(jié)束的回調(diào)
函數(shù)原型：

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

說明：在此函數(shù)中會收到任務(wù)處理的結(jié)果，通過task_id和worker_id來區(qū)分不同的任務(wù)。

8.onTimer

描述：定時器觸發(fā)的回調(diào)
函數(shù)原型：

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

說明：定時器被觸發(fā)時，該函數(shù)被調(diào)用。通過interval來區(qū)分不同時間間隔的定時器。