expQueue | class | Factory and static factory methods, Utility (static helper) | extension/expqueue/classes/expqueue.php:26 | The job queue: what producers call (enqueue, groups, cancel, pause/resume, retry, results) and the state changes the workers and the admin make. |
expQueueAdmin | class | Utility (static helper) | extension/expqueue/classes/expqueueadmin.php:14 | Helpers of the admin module expqueue: the page result with its path, the rows the templates show (every label and duration prepared here, so the temp… |
expQueueAuditBranch | class implements expAuditTaxonomyBranch | INI plugin point (extension point) | extension/expqueue/classes/expqueueauditbranch.php:15 | The audit taxonomy branch of expqueue (registered in settings/audit.ini.append.php): system.queue., one event per operator action on the queue and pe… |
expQueueCancelledException | class extends expQueueException | Exception hierarchy | extension/expqueue/classes/expqueuecancelledexception.php:9 | Thrown by expQueueContext::throwIfCancelled() when the job was cancelled while it ran; the job ends cancelled. |
expQueueCommand | class | Command (console, scripts, cronjobs), Factory and static factory methods | extension/expqueue/classes/expqueuecommand.php:17 | The commands ./console ext:expqueue: (extension/expqueue/bin/php/.php); each file only calls expQueueCommand::main( '' ). |
expQueueConfig | class | Singleton / instance() | extension/expqueue/classes/expqueueconfig.php:15 | The settings of expqueue (expqueue.ini), with the defaults that apply when a setting is missing. |
expQueueContext | class | – | extension/expqueue/classes/expqueuecontext.php:32 | What a handler gets with its job: the lease (heartbeat), cooperative cancellation, progress, the result checkpoint and the rate-limit hand-off of its… |
expQueueEvent | class extends eZPersistentObject | Active Record (eZPersistentObject), Factory and static factory methods | extension/expqueue/classes/expqueueevent.php:15 | The history of a job (table expqueue_event), append-only, removed with the job. |
expQueueException | class extends RuntimeException | Exception hierarchy | extension/expqueue/classes/expqueueexception.php:9 | An error of the queue itself: an unknown class or type, a quota reached, a job that cannot change state. |
expQueueFailHandler | class extends expQueueHandlerBase | INI plugin point (extension point), Strategy / handler | extension/expqueue/classes/handlers/expqueuefailhandler.php:16 | expqueue.fail: fails on purpose, to try retries, backoff, the dead letter and the rate-limit adaptation. |
expQueueGroup | class extends eZPersistentObject | Active Record (eZPersistentObject) | extension/expqueue/classes/expqueuegroup.php:15 | A set of jobs that belong together (table expqueue_group): "translate subtree X into ten languages", a package import, a chain run. |
expQueueHandler | interface | INI plugin point (extension point), Interface (contract), Strategy / handler | extension/expqueue/classes/expqueuehandler.php:27 | A job handler: the code that runs the jobs of one type. |
expQueueHandlerBase | abstract class implements expQueueHandler | Strategy / handler, Template Method / abstract base class | extension/expqueue/classes/expqueuehandlerbase.php:12 | A base for handlers with the optional parts: validate() is called when a job is queued (a wrong payload is refused there and then, not at 3 a.m. |
expqueueInfo | class | Value object / struct | extension/expqueue/ezinfo.php:7 | – |
expQueueJob | class extends eZPersistentObject | Active Record (eZPersistentObject) | extension/expqueue/classes/expqueuejob.php:25 | One job (table expqueue_job). |
expQueueLock | class | Utility (static helper) | extension/expqueue/classes/expqueuelock.php:25 | The dispatcher lock and the queue's directory. |
expQueueNoopHandler | class extends expQueueHandlerBase | INI plugin point (extension point), Strategy / handler | extension/expqueue/classes/handlers/expqueuenoophandler.php:12 | expqueue.noop: does nothing and is done. |
expQueuePermanentException | class extends expQueueException | Exception hierarchy | extension/expqueue/classes/expqueuepermanentexception.php:12 | Thrown by a handler for an error that another attempt cannot fix (invalid input, a refusal, a missing object): the job goes to the dead letter at onc… |
expQueueResource | class | Utility (static helper) | extension/expqueue/classes/expqueueresource.php:22 | The concurrency limiter of a resource (table expqueue_resource): a key such as "anthropic:standard" or "imaging" that jobs name with the option resou… |
expQueueResult | class | Factory and static factory methods | extension/expqueue/classes/expqueueresult.php:18 | What a handler's run() returns when an array (done) is not enough. |
expQueueRetryableException | class extends expQueueException | Exception hierarchy | extension/expqueue/classes/expqueueretryableexception.php:13 | Thrown by a handler for an error that may go away: a timeout, a 429 or 5xx answer, a resource that is busy. |
expQueueScheduler | class | – | extension/expqueue/classes/expqueuescheduler.php:38 | Chooses the next job for a worker and leases it to that worker; keeps the queue moving (maintenance). |
expQueueSchema | class | Utility (static helper) | extension/expqueue/classes/expqueueschema.php:28 | The tables of expqueue, defined once here in the kernel's generic schema format. |
expQueueService | class | Facade / service, Utility (static helper) | extension/expqueue/classes/expqueueservice.php:22 | The systemd service of the queue's workers: ./console ext:expqueue:service install|start|stop|status|uninstall. |
expQueueSleepHandler | class extends expQueueHandlerBase | INI plugin point (extension point), Strategy / handler | extension/expqueue/classes/handlers/expqueuesleephandler.php:16 | expqueue.sleep: waits, in steps, reporting progress and honouring a cancel between the steps. |
expQueueStats | class | Utility (static helper) | extension/expqueue/classes/expqueuestats.php:15 | The figures of the queue for the dashboard (expqueue/dashboard) and ./console ext:expqueue:status: counts per state, per class and per resource, the… |
expQueueWorker | class | – | extension/expqueue/classes/expqueueworker.php:24 | Runs jobs one after another until a limit is reached: the loop of ./console ext:expqueue:work, of the cron part expqueue and of the systemd service. |