Swoole\Timer::clear

(PECL swoole >= 1.9.0)

Swoole\Timer::clear — Delete a timer by ID

説明

public static function Swoole\Timer::clear(int $timer_id): bool

Deletes the timer with the given ID. Only timers created by the current process can be removed; timers belonging to other processes are not visible here.

パラメータ

timer_id: The timer ID returned by Swoole\Timer::tick() or Swoole\Timer::after().

戻り値

成功した場合に true を、失敗した場合に false を返します。 false is returned when no timer with this ID exists in the current process, or when the ID refers to an internal timer.

例

例1 Swoole\Timer::clear() example

<?php
$timer_id = Swoole\Timer::after(1000, function () {
    echo "never printed\n";
});
var_dump(Swoole\Timer::clear($timer_id));
?>

上の例の出力は以下となります。

bool(true)

関連キーワード:

timer Swoole Timer clear Delete after timers current process returned clearAll swoole static Deletes given created removed belonging processes visible here tick 成功 exists refers