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來區分不同時間間隔的定時器。