# 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协议
- 不支持的函数/特性
- 版权信息