Symbiote\QueuedJobs\Tasks\Engines\DoormanRunner
Runs all jobs through the doorman engine
Synopsis
class DoormanRunner
extends BaseRunner
implements
TaskRunnerEngine
{
- // members
- private static integer $max_ticks = 0;
- private static integer $tick_interval = 1;
- private static string $child_runner = 'ProcessJobQueueChildTask';
- protected array $defaultRules = ;
- // methods
- public $this setDefaultRules()
- public array getDefaultRules()
- public void runQueue()
- protected int getMaxTicks()
- protected int getTickInterval()
- protected string getChildRunner()
- protected QueuedJobDescriptor|null getNextJobDescriptorWithoutMutex()
- // Inherited methods from BaseRunner
- public QueuedJobService getService()
- protected void writeLogLine()
- protected void logDescriptorStatus()
- public void listJobs()
Hierarchy
Extends
Uses
- SilverStripe\Core\Config\Configurable
Implements
Members
private
- $child_runner
—
string
Name of the dev task used to run the child process - $max_ticks
—
int
How many ticks are executed per one @see runQueue method call set 0 for unlimited ticks - $tick_interval
—
int
How many seconds between ticks
protected
- $defaultRules — array
Methods
protected
- getChildRunner() — Override this method if you need a dynamic value for the configuration, for example CMS setting
- getMaxTicks() — Override this method if you need a dynamic value for the configuration, for example CMS setting
- getNextJobDescriptorWithoutMutex()
- getTickInterval() — Override this method if you need a dynamic value for the configuration, for example CMS setting
public
- getDefaultRules()
- runQueue() — Run tasks on the given queue
- setDefaultRules() — Assign default rules for this task
Inherited from Symbiote\QueuedJobs\Tasks\Engines\BaseRunner
protected
- logDescriptorStatus() — Logs the status of the queued job descriptor.
- writeLogLine() — Write in a format expected by the output medium (CLI/HTML).
public
- getService() — Returns an instance of the QueuedJobService.
- listJobs() — Logs the number of current jobs per queue