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.
Afficher le fichier
Open project: prggmr/xpspl
Class Usage Examples
Protected Properties
Méthodes publiques
| Méthode |
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 méthode
Returns the idle object for this routine.
idle()
final public méthode
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 méthode
The method is provided a single routine object for providing the
processor information.
|
abstract public routine ( Routine $routine ) : void |
|
$routine |
Routine |
Processor routine. |
| Résultat |
void |
|
set_idle()
final public méthode
Sets the idle object for this routine.
Property Details
$_idle protected_oe property
\XPSPL\Idle Object to idle the processor.
|
protected object $_idle |
| Résultat |
object |
|
$_unique protected_oe property