Home/ Manual/ swoole / timer/ Swoole\Timer::clear

Swoole\Timer::clear

PHP function Edit on GitHub ✎

(PECL swoole >= 1.9.0)

Delete a timer by ID

Description

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

Success false is returned when no timer with this ID exists in the current process, or when the ID refers to an internal timer.

Examples

Swoole\Timer::clear() example

php

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

The above example will output:

output

bool(true)

Source: reference/swoole/swoole/timer/clear.xml · from the official PHP manual (php/doc-en)