Swoole Timer

Timer是Swoole提供的毫秒精度的定时器，底层基于epoll_wait和setitimer实现 ，数据结构使用最小堆，可支持添加大量定时器。Timer底层使用最小堆数据结构实现定时器，定时器的添加和删除，全部为内存操作无IO消耗，因此性能非常高。

Timer定时器与PHP自身的pcntl_alarm有什么不同之处呢？pcntl_alarm是基于时钟信号和tick函数实现的，存在一定的缺陷：

• 最大仅支持到秒，Timer定时器可支持到毫秒级。
  Timer定时器底层不支持时间参数为0的定时器，与Node.js等编程语言不同。在Swoole中可以使用Swoole\Event:defer实现类似功能。

//PHP
Swoole\Event::defer(function(){
  echo "hello".PHP_EOL;
});
//JavaScript
setTimeout(function(){
  console.log("hello");
}, 0);

• 不支持同时设定多个定时器程序
• 依赖declare(ticks=1)，性能很差。

使用

• 同步进程：使用setitimer和信号实现，如Manager管理进程和TaskWorker任务进程。
• 异步进程：使用epoll_wait/kevent/poll/select超时时间实现

设置间隔时钟定时器tick

Timer::tick与Event::defer定时器不同的是tick定时器会持续触发，直到调用Timer::clear清除。

原型

• 面向对象风格

int Swoole\Timer::tick(int $msec, callable $callback, ...$params);

$msec = 1000;
Swoole\Timer::tick($msec, function(){
  echo "timeout".PHP_EOL;
});

Swoole\Timer::tick($msec, function(){
  echo "after {$msec}ms".PHP_EOL;
  Swoole\Timer::tick($msec,  function(){
    echo "after {$msec}".PHP_EOL;;
  })
});

• 函数风格别名

swoole_timer_tick(int $msec, callable $callback, ...$params);

参数

• int $msec 指定时间单位毫秒，如1000毫秒表示1秒。
  Swoole4.2.10-版本时间最大不得超过86400000。
• callable $callback 时间到期后要执行的回调函数，必须是可以调用的。

回调函数

定时器触发的回调函数可以接收若干个参数

function callback(int $timer_id, ...$params);

• $timer_id定时器的ID，可使用Timer::clear清除定时器。
• $params是由Timer::tick传入的第三个可选参数$param

注意

• 可以使用匿名函数的use语法传递参数到回调函数中
• 定时器仅在当前进程空间内有效
• 定时器是纯异步实现的，不能与阻塞IO的函数一起使用，否则定时器的执行时间将会发生错乱。
• 定时器在执行过程中可能存在一定的误差

定时器校正

定时器回调函数的执行时间不影响下一次定时器执行的时间，例如在0.002s设置了10ms的tick定时器，第一次会在0.012s执行回调函数，如果回调函数执行了5ms，下一次定时器仍然会在0.022s时触发，而不是0.027s。

如果定时器回调函数的执行时间过长，甚至覆盖了下一次定时器执行的时间。底层会进行时间校正，丢弃已过期的行为，在下一时间回调。例如0.012s时的回调函数执行了15ms，本该在0.022s产生一次定时回调，实际上本次定时器在0.027s才返回。底层会在0.032s时再次触发定时器回调。

协程模式

在协程环境下Timer::tick回调中会自动创建一个协程，可以直接使用协程相关API，无需调用go创建协程，另外可设置enable_coroutine关闭自动创建协程。

---

指定时间后执行after

一次性定时器，在指定的时间后执行函数，执行完成后会销毁。与PHP标准库的sleep函数不同，after时非阻塞的，sleep调用后会导致当前进程进入阻塞，进而将无法处理新的请求。

after执行成功会返回定时器ID，若取消定时器可调用Swoole\Timer::clear。

原型

• 面向对象风格

int Swoole\Timer::after(int $after_time_ms, callable $callback, ...$params)

Swoole\Timer::after($msec, function() use($message){
  ecco $message.PHP_EOL;
});

• 函数风格别名

swoole_timer_after(int $after_time_ms, callable $callback, ...$params)

参数

• 参数1：int $after_time_ms 表示指定时间单位毫秒，Swoole4.2.10以下版本最大不得超过86400000
• 参数2：'callable $callback表示时间到期后所需执行的函数，必须是可调的。可使用匿名函数的use语法传递参数到回调函数中。

协程模式

在协程环境下Swoole\Timer::after回调中会自动创建一个协程，可以直接使用协程相关API，无需调用go创建协程，可设置enable_coroutine关闭自动创建协程。

---

删除定时器clear

使用定时器ID来删除定时器

原型

• 面向对象风格

bool Swoole\Timer::clear(int $timer_id)

$msec = 1000;
$message = "hello world";
$timer_id = Swoole\Timer::after($msec, function() use($message){
  echo $message.PHP_EOL;
});
$flag = Swoole\Timer::clear($timer_id);

• 函数风格别名

bool swoole_timer_clear(int $timer_id)

参数

• int $timer_id 表示定时器ID，调用Timer::tick、Timer::after后返回一个整数的ID。
• Swoole\Timer::clear不能用于清除其它进程的定时器，只作用于当前进程。