DoormanRunner
class DoormanRunner extends BaseRunner implements TaskRunnerEngine (View source)
Runs all jobs through the doorman engine
Traits
Provides extensions to this object to integrate it with standard config API methods.
Config options
| max_ticks | int | How many ticks are executed per one runQueue method call set 0 for unlimited ticks |
|
| tick_interval | int | How many seconds between ticks |
|
| child_runner | string | Name of the dev task used to run the child process |
Properties
| protected | string[] | $defaultRules |
Methods
Write in a format expected by the output medium (CLI/HTML).
Logs the status of the queued job descriptor.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
Override this method if you need a dynamic value for the configuration, for example CMS setting
Override this method if you need a dynamic value for the configuration, for example CMS setting
Override this method if you need a dynamic value for the configuration, for example CMS setting
Details
QueuedJobService
getService()
Returns an instance of the QueuedJobService.
protected
writeLogLine(string $line, null|string $prefix = null)
Write in a format expected by the output medium (CLI/HTML).
protected
logDescriptorStatus(bool|null|QueuedJobDescriptor $descriptor, string $queue)
Logs the status of the queued job descriptor.
listJobs()
Logs the number of current jobs per queue
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
$this
setDefaultRules(array $rules)
Assign default rules for this task
array
getDefaultRules()
No description
runQueue(string $queue)
Run tasks on the given queue
protected int
getMaxTicks()
Override this method if you need a dynamic value for the configuration, for example CMS setting
protected int
getTickInterval()
Override this method if you need a dynamic value for the configuration, for example CMS setting
protected string
getChildRunner()
Override this method if you need a dynamic value for the configuration, for example CMS setting