# add
```php
int \Workerman\Lib\Timer::add(float $time_interval, callable $callback [,$args = array(), bool $persistent = true])
```
定時執行某個函數或者類方法。
注意:定時器是在當前進程中運行的,workerman中不會創建新的進程或者線程去運行定時器。
### 參數
`time_interval`
多長時間執行一次,單位秒,支持小數,可以精確到0.001,即精確到毫秒級別。
`callback`
回調函數```注意:如果回調函數是類的方法,則方法必須是public屬性```
`args`
回調函數的參數,必須為數組,數組元素為參數值
`persistent`
是否是持久的,如果只想定時執行一次,則傳遞false(只執行一次的任務在執行完畢后會自動銷毀,不必調用```Timer::del()```)。默認是true,即一直定時執行。
### 返回值
返回一個整數,代表計時器的timerid,可以通過調用```Timer::del($timerid)```銷毀這個計時器。
### 示例
#### 1、定時函數為匿名函數(閉包)
```php
use \Workerman\Worker;
use \Workerman\Lib\Timer;
require_once __DIR__ . '/Workerman/Autoloader.php';
$task = new Worker();
// 開啟多少個進程運行定時任務,注意業務是否在多進程有并發問題
$task->count = 1;
$task->onWorkerStart = function($task)
{
// 每2.5秒執行一次
$time_interval = 2.5;
Timer::add($time_interval, function()
{
echo "task run\n";
});
};
// 運行worker
Worker::runAll();
```
### 2、只在指定進程中設置定時器
一個worker實例有4個進程,只在id編號為0的進程上設置定時器。
```php
use Workerman\Worker;
use Workerman\Lib\Timer;
require_once __DIR__ . '/Workerman/Autoloader.php';
$worker = new Worker();
$worker->count = 4;
$worker->onWorkerStart = function($worker)
{
// 只在id編號為0的進程上設置定時器,其它1、2、3號進程不設置定時器
if($worker->id === 0)
{
Timer::add(1, function(){
echo "4個worker進程,只在0號進程設置定時器\n";
});
}
};
// 運行worker
Worker::runAll();
```
### 3、定時函數為匿名函數,利用閉包傳遞參數
```php
use \Workerman\Worker;
use \Workerman\Lib\Timer;
require_once __DIR__ . '/Workerman/Autoloader.php';
$ws_worker = new Worker('websocket://0.0.0.0:8080');
$ws_worker->count = 8;
// 連接建立時給對應連接設置定時器
$ws_worker->onConnect = function($connection)
{
// 每10秒執行一次
$time_interval = 10;
$connect_time = time();
// 給connection對象臨時添加一個timer_id屬性保存定時器id
$connection->timer_id = Timer::add($time_interval, function()use($connection, $connect_time)
{
$connection->send($connect_time);
});
};
// 連接關閉時,刪除對應連接的定時器
$ws_worker->onClose = function($connection)
{
// 刪除定時器
Timer::del($connection->timer_id);
};
// 運行worker
Worker::runAll();
```
### 4、定時器函數為匿名函數,利用定時器接口傳遞參數
```php
use \Workerman\Worker;
use \Workerman\Lib\Timer;
require_once __DIR__ . '/Workerman/Autoloader.php';
$ws_worker = new Worker('websocket://0.0.0.0:8080');
$ws_worker->count = 8;
// 連接建立時給對應連接設置定時器
$ws_worker->onConnect = function($connection)
{
// 每10秒執行一次
$time_interval = 10;
$connect_time = time();
// 給connection對象臨時添加一個timer_id屬性保存定時器id
$connection->timer_id = Timer::add($time_interval, function()
{
$connection->send($connect_time);
}, array($connection, $connect_time));
};
// 連接關閉時,刪除對應連接的定時器
$ws_worker->onClose = function($connection)
{
// 刪除定時器
Timer::del($connection->timer_id);
};
// 運行worker
Worker::runAll();
```
### 5、定時函數為普通函數
```php
use \Workerman\Worker;
use \Workerman\Lib\Timer;
require_once __DIR__ . '/Workerman/Autoloader.php';
// 普通的函數
function send_mail($to, $content)
{
echo "send mail ...\n";
}
$task = new Worker();
$task->onWorkerStart = function($task)
{
$to = 'workerman@workerman.net';
$content = 'hello workerman';
// 10秒后執行發送郵件任務,最后一個參數傳遞false,表示只運行一次
Timer::add(10, 'send_mail', array($to, $content), false);
};
// 運行worker
Worker::runAll();
```
### 6、定時函數為類的方法
```php
use \Workerman\Worker;
use \Workerman\Lib\Timer;
require_once __DIR__ . '/Workerman/Autoloader.php';
class Mail
{
// 注意,回調函數屬性必須是public
public function send($to, $content)
{
echo "send mail ...\n";
}
}
$task = new Worker();
$task->onWorkerStart = function($task)
{
// 10秒后發送一次郵件
$mail = new Mail();
$to = 'workerman@workerman.net';
$content = 'hello workerman';
Timer::add(10, array($mail, 'send'), array($to, $content), false);
};
// 運行worker
Worker::runAll();
```
### 7、定時函數為類方法(類內部使用定時器)
```php
use \Workerman\Worker;
use \Workerman\Lib\Timer;
require_once __DIR__ . '/Workerman/Autoloader.php';
class Mail
{
// 注意,回調函數屬性必須是public
public function send($to, $content)
{
echo "send mail ...\n";
}
public function sendLater($to, $content)
{
// 回調的方法屬于當前的類,則回調數組第一個元素為$this
Timer::add(10, array($this, 'send'), array($to, $content), false);
}
}
$task = new Worker();
$task->onWorkerStart = function($task)
{
// 10秒后發送一次郵件
$mail = new Mail();
$to = 'workerman@workerman.net';
$content = 'hello workerman';
$mail->sendLater($to, $content);
};
// 運行worker
Worker::runAll();
```
### 8、定時函數為類的靜態方法
```php
use \Workerman\Worker;
use \Workerman\Lib\Timer;
require_once __DIR__ . '/Workerman/Autoloader.php';
class Mail
{
// 注意這個是靜態方法,回調函數屬性也必須是public
public static function send($to, $content)
{
echo "send mail ...\n";
}
}
$task = new Worker();
$task->onWorkerStart = function($task)
{
// 10秒后發送一次郵件
$to = 'workerman@workerman.net';
$content = 'hello workerman';
// 定時調用類的靜態方法
Timer::add(10, array('Mail', 'send'), array($to, $content), false);
};
// 運行worker
Worker::runAll();
```
### 9、定時函數為類的靜態方法(帶命名空間)
```php
namespace Task;
use \Workerman\Worker;
use \Workerman\Lib\Timer;
require_once __DIR__ . '/Workerman/Autoloader.php';
class Mail
{
// 注意這個是靜態方法,回調函數屬性也必須是public
public static function send($to, $content)
{
echo "send mail ...\n";
}
}
$task = new Worker();
$task->onWorkerStart = function($task)
{
// 10秒后發送一次郵件
$to = 'workerman@workerman.net';
$content = 'hello workerman';
// 定時調用帶命名空間的類的靜態方法
Timer::add(10, array('\Task\Mail', 'send'), array($to, $content), false);
};
// 運行worker
Worker::runAll();
```
### 10、定時器中銷毀當前定時器(use閉包方式傳遞$timer\_id)
```php
use \Workerman\Worker;
use \Workerman\Lib\Timer;
require_once __DIR__ . '/Workerman/Autoloader.php';
$task = new Worker();
$task->onWorkerStart = function($task)
{
// 計數
$count = 1;
// 要想$timer_id能正確傳遞到回調函數內部,$timer_id前面必須加地址符 &
$timer_id = Timer::add(1, function()use(&$timer_id, &$count)
{
echo "Timer run $count\n";
// 運行10次后銷毀當前定時器
if($count++ >= 10)
{
echo "Timer::del($timer_id)\n";
Timer::del($timer_id);
}
});
};
// 運行worker
Worker::runAll();
```
### 11、定時器中銷毀當前定時器(參數方式傳遞$timer\_id)
```php
use \Workerman\Worker;
use \Workerman\Lib\Timer;
require_once __DIR__ . '/Workerman/Autoloader.php';
class Mail
{
public function send($to, $content, $timer_id)
{
// 臨時給當前對象添加一個count屬性,記錄定時器運行次數
$this->count = empty($this->count) ? 1 : $this->count;
// 運行10次后銷毀當前定時器
echo "send mail {$this->count}...\n";
if($this->count++ >= 10)
{
echo "Timer::del($timer_id)\n";
Timer::del($timer_id);
}
}
}
$task = new Worker();
$task->onWorkerStart = function($task)
{
$mail = new Mail();
// 要想$timer_id能正確傳遞到回調函數內部,$timer_id前面必須加地址符 &
$timer_id = Timer::add(1, array($mail, 'send'), array('to', 'content', &$timer_id));
};
// 運行worker
Worker::runAll();
```
- 序言
- 原理
- 開發必讀
- 入門指引
- 特性
- 簡單的開發示例
- 安裝
- 環境要求
- 下載安裝
- 啟動停止
- 開發流程
- 開發前必讀
- 目錄結構
- 開發規范
- 基本流程
- 通訊協議
- 通訊協議作用
- 定制通訊協議
- 一些例子
- Worker類
- 構造函數
- 屬性
- id
- count
- name
- protocol
- transport
- reusePort
- connections
- stdoutFile
- pidFile
- logFile
- user
- reloadable
- daemonize
- globalEvent
- 回調屬性
- onWorkerStart
- onWorkerReload
- onConnect
- onMessage
- onClose
- onBufferFull
- onBufferDrain
- onError
- 接口
- runAll
- stopAll
- listen
- TcpConnection類
- 屬性
- id
- protocol
- worker
- maxSendBufferSize
- defaultMaxSendBufferSize
- maxPackageSize
- 回調屬性
- onMessage
- onClose
- onBufferFull
- onBufferDrain
- onError
- 接口
- send
- getRemoteIp
- getRemotePort
- close
- destroy
- pauseRecv
- resumeRecv
- pipe
- AsyncTcpConnection類
- 構造函數
- connect
- reconnect
- transport
- Timer定時器類
- add
- del
- 定時器注意事項
- WebServer
- 調試
- 基本調試
- 查看運行狀態
- 網絡抓包
- 跟蹤系統調用
- 常用組件
- GlobalData數據共享組件
- GlobalDataServer
- GlobalDataClient
- Channel分布式通訊組件
- ChannelServer
- channelClient
- 例子-集群推送
- 例子-分組發送
- FileMonitor文件監控組件
- MySQL組件
- workerman/mysql
- swoole/mysql(異步)
- redis組件
- swoole/redis
- 異步http組件
- swoole/http-client
- 異步消息隊列組件
- react/zmq
- react/stomp
- 異步dns組件
- swoole/dns
- 常見問題
- 心跳
- 客戶端鏈接失敗原因
- 是否支持多線程
- 與其它框架整合
- 運行多個workerman
- 支持哪些協議
- 如何設置進程數
- 查看客戶端連接數
- 對象和資源的持久化
- 例子無法工作
- 啟動失敗
- 停止失敗
- 支持多少并發
- 更改代碼不生效
- 向指定客戶端發送數據
- 如何主動推送消息
- 在其它項目中推送
- 如何實現異步任務
- status里send_fail的原因
- Windows下開發Linux下部署
- 是否支持socket.io
- 終端關閉導致workerman關閉
- 與nginx apache的關系
- 禁用函數檢查
- 平滑重啟原理
- 為Flash開843端口
- 如何廣播數據
- 如何建立udp服務
- 監聽ipv6
- 關閉未認證的鏈接
- 傳輸加密-ssl/tsl
- 創建wss服務
- 創建https服務
- workerman作為客戶端
- 作為ws/wss客戶端
- PHP的幾種回調寫法
- 附錄
- Linux內核調優
- 壓力測試
- 安裝擴展
- websocket協議
- ws協議
- text協議
- frame協議
- 不支持的函數/特性
- 版權信息