PHP Class XPSPL\SIG_Routine

A SIG_Routine object indicates to the processor a routine that must be run. Each routine is ran at the beginning of the loop. It allows for giving the processor the following information. - Signals to emit - How to idle until the next loop SIG_Routines are designed for signals that will need to idle the processor to wait for emitting in the future.

Since: 2.0.0

Inheritance: extends SIG

ファイルを表示 Open project: prggmr/xpspl Class Usage Examples

Protected Properties

Property	Type	Description
$_idle	object	\XPSPL\Idle Object to idle the processor.
$_unique

Public Methods

Method	Description
get_idle ( ) : object	Returns the idle object for this routine.
idle ( Processor $processor )	Runs the routines idle function.
routine ( Routine $routine ) : void	Runs the routine calculation.
set_idle ( Idle $idle ) : object	Sets the idle object for this routine.

Method Details

get_idle() final public method

Returns the idle object for this routine.

final public get_idle ( ) : object
return	object	\XPSPL\Idle

idle() final public method

This method was added in v4.0.0 as a means for the processor to communicate to the routine to begin idling. This only provides a transport layer for going from the processor into the signal.

final public idle ( Processor $processor )
$processor	Processor

routine() abstract public method

The method is provided a single routine object for providing the processor information.

abstract public routine ( Routine $routine ) : void
$routine	Routine	Processor routine.
return	void

set_idle() final public method

Sets the idle object for this routine.

final public set_idle ( Idle $idle ) : object
$idle	Idle
return	object	\XPSPL\Idle

Property Details

$_idle protected_oe property

\XPSPL\Idle Object to idle the processor.

protected object $_idle
return	object

$_unique protected_oe property

protected $_unique