PHP Class PHPDaemon\Core\ComplexJob

Author: Vasily Zorin ([email protected])
Inheritance: implements ArrayAccess, use trait PHPDaemon\Traits\ClassWatchdog, use trait PHPDaemon\Traits\StaticObjectWatchdog
Afficher le fichier Open project: kakserpom/phpdaemon Class Usage Examples

Méthodes publiques

Свойство Type Description
$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 Properties

Свойство Type Description
$backlog
$keep
$maxConcurrency
$more
$moreFirstFlag

Méthodes publiques

Méthode Description
__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

Méthodes protégées

Méthode Description
checkIfAllReady ( ) : void Checks if all jobs are ready

Method Details

__construct() public méthode

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

__invoke() public méthode

Adds new job or calls execute() method
public __invoke ( mixed $name = null, callable $cb = null ) : void
$name mixed
$cb callable
Résultat void

addJob() public méthode

Adds job
public addJob ( string $name, callable $cb ) : boolean
$name string Job name
$cb callable Callback
Résultat boolean Success

addListener() public méthode

Adds listener
public addListener ( callable $cb ) : void
$cb callable Callback
Résultat void

checkIfAllReady() protected méthode

Checks if all jobs are ready
protected checkIfAllReady ( ) : void
Résultat void

checkQueue() public méthode

Called automatically. Checks whether if the queue is full. If not, tries to pull more jobs from backlog and 'more'
public checkQueue ( ) : void
Résultat void

cleanup() public méthode

Clean up
public cleanup ( ) : void
Résultat void

execute() public méthode

Runs the job
public execute ( ) : void
Résultat void

getResult() public méthode

Get result
public getResult ( string $jobname ) : mixed
$jobname string Job name
Résultat mixed Result or null

getResults() public méthode

Returns associative array of results
public getResults ( ) : array
Résultat array

hasCompleted() public méthode

Has completed?
public hasCompleted ( ) : boolean
Résultat boolean

isQueueFull() public méthode

Returns whether or not the queue is full (maxConcurrency option exceed)
public isQueueFull ( ) : boolean
Résultat boolean

keep() public méthode

Keep
public keep ( boolean $keep = true ) : void
$keep boolean Keep?
Résultat void

maxConcurrency() public méthode

Sets a limit of simultaneously executing tasks
public maxConcurrency ( integer $n ) : this
$n integer Natural number or -1 (no limit)
Résultat this

more() public méthode

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
Résultat this

offsetExists() public méthode

Handler of isset($job[$name])
public offsetExists ( string $j ) : boolean
$j string Job name
Résultat boolean

offsetGet() public méthode

Handler of $job[$name]
public offsetGet ( string $j ) : mixed
$j string Job name
Résultat mixed

offsetSet() public méthode

Handler of $job[$name] = $value
public offsetSet ( string $j, mixed $v ) : void
$j string Job name
$v mixed Job result
Résultat void

offsetUnset() public méthode

Handler of unset($job[$name])
public offsetUnset ( string $j ) : void
$j string Job name
Résultat void

setResult() public méthode

Set result
public setResult ( string $jobname, mixed $result = null ) : boolean
$jobname string Job name
$result mixed Result
Résultat boolean

Property Details

$backlog protected_oe property

protected $backlog

$jobs public_oe property

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

$jobsNum public_oe property

Number of jobs
public $jobsNum

$keep protected_oe property

protected $keep

$listeners public_oe property

Listeners [callable, ...]
public $listeners

$maxConcurrency protected_oe property

protected $maxConcurrency

$more protected_oe property

protected $more

$moreFirstFlag protected_oe property

protected $moreFirstFlag

$results public_oe property

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

$resultsNum public_oe property

Number of results
public $resultsNum

$state public_oe property

Current state
public $state

$vars public_oe property

public $vars