PHP Класс PHPDaemon\Core\ComplexJob

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

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

Свойство Тип Описание
$jobs Hash of jobs [jobname -> callback, ...]
$jobsNum Number of jobs
$listeners Listeners [callable, ...]
$results Hash of results [jobname -> result, ...]
$resultsNum Number of results
$state Current state
$vars

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

Свойство Тип Описание
$backlog
$keep
$maxConcurrency
$more
$moreFirstFlag

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

Метод Описание
__construct ( callable $cb = null ) Constructor
__invoke ( mixed $name = null, callable $cb = null ) : void Adds new job or calls execute() method
addJob ( string $name, callable $cb ) : boolean Adds job
addListener ( callable $cb ) : void Adds listener
checkQueue ( ) : void Called automatically. Checks whether if the queue is full. If not, tries to pull more jobs from backlog and 'more'
cleanup ( ) : void Clean up
execute ( ) : void Runs the job
getResult ( string $jobname ) : mixed Get result
getResults ( ) : array Returns associative array of results
hasCompleted ( ) : boolean Has completed?
isQueueFull ( ) : boolean Returns whether or not the queue is full (maxConcurrency option exceed)
keep ( boolean $keep = true ) : void Keep
maxConcurrency ( integer $n ) : this Sets a limit of simultaneously executing tasks
more ( callable $cb = null ) : this Sets a callback which is going to be fired always when we have a room for more jobs
offsetExists ( string $j ) : boolean Handler of isset($job[$name])
offsetGet ( string $j ) : mixed Handler of $job[$name]
offsetSet ( string $j, mixed $v ) : void Handler of $job[$name] = $value
offsetUnset ( string $j ) : void Handler of unset($job[$name])
setResult ( string $jobname, mixed $result = null ) : boolean Set result

Защищенные методы

Метод Описание
checkIfAllReady ( ) : void Checks if all jobs are ready

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

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

Constructor
public __construct ( callable $cb = null )
$cb callable Listener

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

Adds new job or calls execute() method
public __invoke ( mixed $name = null, callable $cb = null ) : void
$name mixed
$cb callable
Результат void

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

Adds job
public addJob ( string $name, callable $cb ) : boolean
$name string Job name
$cb callable Callback
Результат boolean Success

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

Adds listener
public addListener ( callable $cb ) : void
$cb callable Callback
Результат void

checkIfAllReady() защищенный Метод

Checks if all jobs are ready
protected checkIfAllReady ( ) : void
Результат void

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

Called automatically. Checks whether if the queue is full. If not, tries to pull more jobs from backlog and 'more'
public checkQueue ( ) : void
Результат void

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

Clean up
public cleanup ( ) : void
Результат void

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

Runs the job
public execute ( ) : void
Результат void

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

Get result
public getResult ( string $jobname ) : mixed
$jobname string Job name
Результат mixed Result or null

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

Returns associative array of results
public getResults ( ) : array
Результат array

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

Has completed?
public hasCompleted ( ) : boolean
Результат boolean

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

Returns whether or not the queue is full (maxConcurrency option exceed)
public isQueueFull ( ) : boolean
Результат boolean

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

Keep
public keep ( boolean $keep = true ) : void
$keep boolean Keep?
Результат void

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

Sets a limit of simultaneously executing tasks
public maxConcurrency ( integer $n ) : this
$n integer Natural number or -1 (no limit)
Результат this

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

Sets a callback which is going to be fired always when we have a room for more jobs
public more ( callable $cb = null ) : this
$cb callable Callback
Результат this

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

Handler of isset($job[$name])
public offsetExists ( string $j ) : boolean
$j string Job name
Результат boolean

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

Handler of $job[$name]
public offsetGet ( string $j ) : mixed
$j string Job name
Результат mixed

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

Handler of $job[$name] = $value
public offsetSet ( string $j, mixed $v ) : void
$j string Job name
$v mixed Job result
Результат void

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

Handler of unset($job[$name])
public offsetUnset ( string $j ) : void
$j string Job name
Результат void

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

Set result
public setResult ( string $jobname, mixed $result = null ) : boolean
$jobname string Job name
$result mixed Result
Результат boolean

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

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

protected $backlog

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

Hash of jobs [jobname -> callback, ...]
public $jobs

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

Number of jobs
public $jobsNum

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

protected $keep

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

Listeners [callable, ...]
public $listeners

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

protected $maxConcurrency

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

protected $more

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

protected $moreFirstFlag

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

Hash of results [jobname -> result, ...]
public $results

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

Number of results
public $resultsNum

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

Current state
public $state

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

public $vars