PHP Класс PHPDaemon\Core\Timer

Автор: Vasily Zorin ([email protected])
Наследование: use trait PHPDaemon\Traits\ClassWatchdog, use trait PHPDaemon\Traits\StaticObjectWatchdog, use trait PHPDaemon\Traits\EventLoopContainer
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$cb Callback
$finished Is the timer finished?
$id Timer id
$lastTimeout Current timeout holder
$priority Priority

Защищенные свойства (Protected)

Свойство Тип Описание
$counter Counter
$ev Event resource
$list List of timers

Открытые методы

Метод Описание
__construct ( callable $cb, integer $timeout = null, integer | string $id = null, integer $priority = null ) Constructor
__destruct ( ) : void Destructor
add ( callable $cb, integer $timeout = null, integer | string $id = null, integer $priority = null ) : integer | string Adds timer
cancel ( ) : void Cancels timer
cancelTimeout ( integer | string $id ) : void Cancels timer by ID
eventCall ( ) : void Called when timer is triggered
finish ( ) : void Finishes timer
free ( ) : void Frees the timer
remove ( integer | string $id ) : void Removes timer by ID
setPriority ( integer $priority ) : void Set prioriry
setTimeout ( integer | string $id, integer $timeout = null ) : boolean Sets timeout
timeout ( integer $timeout = null ) : void Sets timeout

Описание методов

__construct() публичный Метод

Constructor
public __construct ( callable $cb, integer $timeout = null, integer | string $id = null, integer $priority = null )
$cb callable Callback
$timeout integer Timeout
$id integer | string Timer ID
$priority integer Priority

__destruct() публичный Метод

Destructor
public __destruct ( ) : void
Результат void

add() публичный статический Метод

Adds timer
public static add ( callable $cb, integer $timeout = null, integer | string $id = null, integer $priority = null ) : integer | string
$cb callable Callback
$timeout integer Timeout
$id integer | string Timer ID
$priority integer Priority
Результат integer | string Timer ID

cancel() публичный Метод

Cancels timer
public cancel ( ) : void
Результат void

cancelTimeout() публичный статический Метод

Cancels timer by ID
public static cancelTimeout ( integer | string $id ) : void
$id integer | string Timer ID
Результат void

eventCall() публичный Метод

Called when timer is triggered
public eventCall ( ) : void
Результат void

finish() публичный Метод

Finishes timer
public finish ( ) : void
Результат void

free() публичный Метод

Frees the timer
public free ( ) : void
Результат void

remove() публичный статический Метод

Removes timer by ID
public static remove ( integer | string $id ) : void
$id integer | string Timer ID
Результат void

setPriority() публичный Метод

Set prioriry
public setPriority ( integer $priority ) : void
$priority integer Priority
Результат void

setTimeout() публичный статический Метод

Sets timeout
public static setTimeout ( integer | string $id, integer $timeout = null ) : boolean
$id integer | string Timer ID
$timeout integer Timeout
Результат boolean

timeout() публичный Метод

Sets timeout
public timeout ( integer $timeout = null ) : void
$timeout integer Timeout
Результат void

Описание свойств

$cb публичное свойство

Callback
public $cb

$counter защищенное статическое свойство

Counter
protected static $counter

$ev защищенное свойство

Event resource
protected $ev

$finished публичное свойство

Is the timer finished?
public $finished

$id публичное свойство

Timer id
public $id

$lastTimeout публичное свойство

Current timeout holder
public $lastTimeout

$list защищенное статическое свойство

List of timers
protected static $list

$priority публичное свойство

Priority
public $priority