Swoole\Timer::clear

(PECL swoole >= 1.9.0)

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

Description

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.

Parameters

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

Return Values

Returns true on success or false on failure. false is returned when no timer with this ID exists in the current process, or when the ID refers to an internal timer.

Examples

Example #1 Swoole\Timer::clear() example

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

The above example will output:

bool(true)