add

  1. 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、定时函数为匿名函数（闭包）

  1. use \Workerman\Worker;
  2. use \Workerman\Lib\Timer;
  3. require_once __DIR__ . '/Workerman/Autoloader.php';
  5. $task = new Worker();
  6. // 开启多少个进程运行定时任务，注意业务是否在多进程有并发问题
  7. $task->count = 1;
  8. $task->onWorkerStart = function($task)
  9. {
  10.     // 每2.5秒执行一次
  11.     $time_interval = 2.5;
  12.     Timer::add($time_interval, function()
  13.     {
  14.         echo "task run\n";
  15.     });
  16. };
  18. // 运行worker
  19. Worker::runAll();

2、只在指定进程中设置定时器

一个worker实例有4个进程，只在id编号为0的进程上设置定时器。

  1. use Workerman\Worker;
  2. use Workerman\Lib\Timer;
  3. require_once __DIR__ . '/Workerman/Autoloader.php';
  5. $worker = new Worker();
  6. $worker->count = 4;
  7. $worker->onWorkerStart = function($worker)
  8. {
  9.     // 只在id编号为0的进程上设置定时器，其它1、2、3号进程不设置定时器
  10.     if($worker->id === 0)
  11.     {
  12.         Timer::add(1, function(){
  13.             echo "4个worker进程，只在0号进程设置定时器\n";
  14.         });
  15.     }
  16. };
  17. // 运行worker
  18. Worker::runAll();

3、定时函数为匿名函数，利用闭包传递参数

  1. use \Workerman\Worker;
  2. use \Workerman\Lib\Timer;
  3. require_once __DIR__ . '/Workerman/Autoloader.php';
  5. $ws_worker = new Worker('websocket://0.0.0.0:8080');
  6. $ws_worker->count = 8;
  7. // 连接建立时给对应连接设置定时器
  8. $ws_worker->onConnect = function($connection)
  9. {
  10.     // 每10秒执行一次
  11.     $time_interval = 10;
  12.     $connect_time = time();
  13.     // 给connection对象临时添加一个timer_id属性保存定时器id
  14.     $connection->timer_id = Timer::add($time_interval, function()use($connection, $connect_time)
  15.     {
  16.          $connection->send($connect_time);
  17.     });
  18. };
  19. // 连接关闭时，删除对应连接的定时器
  20. $ws_worker->onClose = function($connection)
  21. {
  22.     // 删除定时器
  23.     Timer::del($connection->timer_id);
  24. };
  26. // 运行worker
  27. Worker::runAll();

4、定时器函数为匿名函数，利用定时器接口传递参数

  1. use \Workerman\Worker;
  2. use \Workerman\Lib\Timer;
  3. require_once __DIR__ . '/Workerman/Autoloader.php';
  5. $ws_worker = new Worker('websocket://0.0.0.0:8080');
  6. $ws_worker->count = 8;
  7. // 连接建立时给对应连接设置定时器
  8. $ws_worker->onConnect = function($connection)
  9. {
  10.     // 每10秒执行一次
  11.     $time_interval = 10;
  12.     $connect_time = time();
  13.     // 给connection对象临时添加一个timer_id属性保存定时器id
  14.     $connection->timer_id = Timer::add($time_interval, function()
  15.     {
  16.          $connection->send($connect_time);
  17.     }, array($connection, $connect_time));
  18. };
  19. // 连接关闭时，删除对应连接的定时器
  20. $ws_worker->onClose = function($connection)
  21. {
  22.     // 删除定时器
  23.     Timer::del($connection->timer_id);
  24. };
  26. // 运行worker
  27. Worker::runAll();

5、定时函数为普通函数

  1. use \Workerman\Worker;
  2. use \Workerman\Lib\Timer;
  3. require_once __DIR__ . '/Workerman/Autoloader.php';
  5. // 普通的函数
  6. function send_mail($to, $content)
  7. {
  8.     echo "send mail ...\n";
  9. }
  11. $task = new Worker();
  12. $task->onWorkerStart = function($task)
  13. {
  14.     $to = 'workerman@workerman.net';
  15.     $content = 'hello workerman';
  16.     // 10秒后执行发送邮件任务，最后一个参数传递false，表示只运行一次
  17.     Timer::add(10, 'send_mail', array($to, $content), false);
  18. };
  20. // 运行worker
  21. Worker::runAll();

6、定时函数为类的方法

  1. use \Workerman\Worker;
  2. use \Workerman\Lib\Timer;
  3. require_once __DIR__ . '/Workerman/Autoloader.php';
  5. class Mail
  6. {
  7.     // 注意，回调函数属性必须是public
  8.     public function send($to, $content)
  9.     {
  10.         echo "send mail ...\n";
  11.     }
  12. }
  14. $task = new Worker();
  15. $task->onWorkerStart = function($task)
  16. {
  17.     // 10秒后发送一次邮件
  18.     $mail = new Mail();
  19.     $to = 'workerman@workerman.net';
  20.     $content = 'hello workerman';
  21.     Timer::add(10, array($mail, 'send'), array($to, $content), false);
  22. };
  24. // 运行worker
  25. Worker::runAll();

7、定时函数为类方法（类内部使用定时器）

  1. use \Workerman\Worker;
  2. use \Workerman\Lib\Timer;
  3. require_once __DIR__ . '/Workerman/Autoloader.php';
  5. class Mail
  6. {
  7.     // 注意，回调函数属性必须是public
  8.     public function send($to, $content)
  9.     {
  10.         echo "send mail ...\n";
  11.     }
  13.     public function sendLater($to, $content)
  14.     {
  15.         // 回调的方法属于当前的类，则回调数组第一个元素为$this
  16.         Timer::add(10, array($this, 'send'), array($to, $content), false);
  17.     }
  18. }
  20. $task = new Worker();
  21. $task->onWorkerStart = function($task)
  22. {
  23.     // 10秒后发送一次邮件
  24.     $mail = new Mail();
  25.     $to = 'workerman@workerman.net';
  26.     $content = 'hello workerman';
  27.     $mail->sendLater($to, $content);
  28. };
  30. // 运行worker
  31. Worker::runAll();

8、定时函数为类的静态方法

  1. use \Workerman\Worker;
  2. use \Workerman\Lib\Timer;
  3. require_once __DIR__ . '/Workerman/Autoloader.php';
  5. class Mail
  6. {
  7.     // 注意这个是静态方法，回调函数属性也必须是public
  8.     public static function send($to, $content)
  9.     {
  10.         echo "send mail ...\n";
  11.     }
  12. }
  14. $task = new Worker();
  15. $task->onWorkerStart = function($task)
  16. {
  17.     // 10秒后发送一次邮件
  18.     $to = 'workerman@workerman.net';
  19.     $content = 'hello workerman';
  20.     // 定时调用类的静态方法
  21.     Timer::add(10, array('Mail', 'send'), array($to, $content), false);
  22. };
  24. // 运行worker
  25. Worker::runAll();

9、定时函数为类的静态方法(带命名空间)

  1. namespace Task;
  2. use \Workerman\Worker;
  3. use \Workerman\Lib\Timer;
  4. require_once __DIR__ . '/Workerman/Autoloader.php';
  6. class Mail
  7. {
  8.     // 注意这个是静态方法，回调函数属性也必须是public
  9.     public static function send($to, $content)
  10.     {
  11.         echo "send mail ...\n";
  12.     }
  13. }
  15. $task = new Worker();
  16. $task->onWorkerStart = function($task)
  17. {
  18.     // 10秒后发送一次邮件
  19.     $to = 'workerman@workerman.net';
  20.     $content = 'hello workerman';
  21.     // 定时调用带命名空间的类的静态方法
  22.     Timer::add(10, array('\Task\Mail', 'send'), array($to, $content), false);
  23. };
  25. // 运行worker
  26. Worker::runAll();

10、定时器中销毁当前定时器（use闭包方式传递$timer_id）

  1. use \Workerman\Worker;
  2. use \Workerman\Lib\Timer;
  3. require_once __DIR__ . '/Workerman/Autoloader.php';
  5. $task = new Worker();
  6. $task->onWorkerStart = function($task)
  7. {
  8.     // 计数
  9.     $count = 1;
  10.     // 要想$timer_id能正确传递到回调函数内部，$timer_id前面必须加地址符 &
  11.     $timer_id = Timer::add(1, function()use(&$timer_id, &$count)
  12.     {
  13.         echo "Timer run $count\n";
  14.         // 运行10次后销毁当前定时器
  15.         if($count++ >= 10)
  16.         {
  17.             echo "Timer::del($timer_id)\n";
  18.             Timer::del($timer_id);
  19.         }
  20.     });
  21. };
  23. // 运行worker
  24. Worker::runAll();

11、定时器中销毁当前定时器（参数方式传递$timer_id）

  1. use \Workerman\Worker;
  2. use \Workerman\Lib\Timer;
  3. require_once __DIR__ . '/Workerman/Autoloader.php';
  5. class Mail
  6. {
  7.     public function send($to, $content, $timer_id)
  8.     {
  9.         // 临时给当前对象添加一个count属性，记录定时器运行次数
  10.         $this->count = empty($this->count) ? 1 : $this->count;
  11.         // 运行10次后销毁当前定时器
  12.         echo "send mail {$this->count}...\n";
  13.         if($this->count++ >= 10)
  14.         {
  15.             echo "Timer::del($timer_id)\n";
  16.             Timer::del($timer_id);
  17.         }
  18.     }
  19. }
  21. $task = new Worker();
  22. $task->onWorkerStart = function($task)
  23. {
  24.     $mail = new Mail();
  25.     // 要想$timer_id能正确传递到回调函数内部，$timer_id前面必须加地址符 &
  26.     $timer_id = Timer::add(1, array($mail, 'send'), array('to', 'content', &$timer_id));
  27. };
  29. // 运行worker
  30. Worker::runAll();