PHP Class Worker, ClearSky

Inheritance: extends Base
Show file Open project: robske110/ClearSky Class Usage Examples

Public Methods

Method Description
collect ( callable $function ) : void Collects finished objects
collector ( Collectable $collectable )
getStacked ( ) : integer Returns the number of threaded tasks waiting to be executed by the referenced Worker
isShutdown ( ) : boolean Tell if the referenced Worker has been shutdown
shutdown ( ) : boolean Shuts down the Worker after executing all the threaded tasks previously stacked
stack ( Collectable &$work ) : integer Appends the referenced object to the stack of the referenced Worker
unstack ( ) : integer Removes the first item from the stack

Method Details

collect() public method

Collects finished objects
See link: http://www.php.net/manual/en/worker.collect.php
public collect ( callable $function ) : void
$function callable
return void

collector() public method

public collector ( Collectable $collectable )
$collectable Collectable

getStacked() public method

Returns the number of threaded tasks waiting to be executed by the referenced Worker
See link: http://www.php.net/manual/en/worker.getstacked.php
public getStacked ( ) : integer
return integer An integral value

isShutdown() public method

Tell if the referenced Worker has been shutdown
See link: http://www.php.net/manual/en/worker.isshutdown.php
public isShutdown ( ) : boolean
return boolean A boolean indication of state

shutdown() public method

Shuts down the Worker after executing all the threaded tasks previously stacked
See link: http://www.php.net/manual/en/worker.shutdown.php
public shutdown ( ) : boolean
return boolean A boolean indication of success

stack() public method

Appends the referenced object to the stack of the referenced Worker
See link: http://www.php.net/manual/en/worker.stack.php
public stack ( Collectable &$work ) : integer
$work Collectable Collectable object to be executed by the referenced Worker
return integer The new length of the stack

unstack() public method

Removes the first item from the stack
See link: http://www.php.net/manual/en/worker.unstack.php
public unstack ( ) : integer
return integer The new length of the stack