CodeIgniter Jobs — daycry/jobs

daycry/jobs is a job-scheduling and queue-processing library for CodeIgniter 4. You describe work with a fluent, immutable builder, dispatch it to one of five interchangeable queue backends, and process it with a resilient worker that provides real (interrupting) timeouts, retries with backoff, HMAC-signed envelopes, opt-in idempotency, single-instance locking and per-queue handler allowlists.

This is the Sphinx / Read the Docs entry point. The content pages are authored in Markdown and rendered through the MyST parser (configured in conf.py); the structured table of contents below mirrors the navigation used by the MkDocs build.

Note

v3.0 is a single, clean architecture. The legacy mutable Job builder, the V1 Scheduler, the performance loggers, the NotificationService/email integration, the QueueManager and the JobsLogModel were all removed. Upgrading from v1? See Migration to v3.

Getting Started

• Installation
  • Requirements
  • Install
  • Run the migrations
  • Optional: publish the config
  • Optional extensions
  • Configure the signing key
  • Minimal configuration
  • Verify the install
  • Next steps
• Quick Start
  • Prerequisites
  • Step 1 — Define a job
  • Step 2 — Dispatch to a queue
  • Step 3 — Run a worker
  • Step 4 — Schedule a recurring job
  • Step 5 — Sign envelopes
  • Where to go next

Core Concepts

• Architecture
  • Layers
  • Core value objects
  • Queue pipeline (worker)
  • Cron pipeline
  • The QueueBackend contract
  • At-least-once delivery
  • Execution & resilience
  • Security
  • Extending the architecture
• Jobs: Defining Work
  • The facade: Jobs
  • JobBuilder: the fluent accumulator
  • JobDefinition: the immutable value object
  • The wire envelope
  • Field reference and behaviour
  • See also
• Handlers: Running Work
  • The contract: JobHandlerInterface
  • AbstractJobHandler
  • JobContext
  • Built-in handlers
  • Writing your own handler
  • Typed handlers (TypedJobHandler)
  • Handler resolution and per-queue allowlist
  • See also
• Queues & Backends
  • Enqueueing work
  • The QueueBackend contract
  • The JobLease
  • The wire envelope
  • The worker pipeline
  • At-least-once delivery
  • Recovering crashed workers (reaper)
  • Backends
  • Choosing a backend
  • Security
  • See also

Guides

• Scheduling (Cron)
  • Registering jobs
  • Running the scheduler
  • Frequency helpers
  • Queued vs inline — the rule
  • Enabled / disabled
  • Environments
  • Dependencies and execution order
  • Single instance
  • Missed runs
  • See also
• Retries & Backoff
  • The model
  • Total runs = maxRetries + 1
  • RetryPolicyFixed
  • Strategies
  • How the delay is applied per backend
  • Dead Letter Queue
  • At-least-once delivery
  • Metrics
• Security Model
  • Envelope signing (anti-tamper / anti-RCE)
  • Per-queue handler allowlist
  • ShellHandler — deny-by-default
  • EventHandler — allowlist
  • UrlHandler — SSRF hardening
  • Threat model
  • Related exceptions
• Concurrency & Resilience
  • Single-instance locking
  • Circuit breaker
  • Rate limiting
  • Putting it together
• Advanced Topics
  • Custom handlers
  • Execution model and callbacks
  • Callbacks and middleware: the v3 model
  • Timeout
  • Idempotency in depth
  • Envelope signing
  • Per-queue handler allowlist
  • Single instance
  • Extensibility: custom QueueBackend
  • Metrics

Operations & CLI

• Operations
  • Running long-running workers
  • Graceful shutdown and signals
  • Scaling out
  • The periodic reaper
  • Circuit breaker
  • Rate limiting
  • Dead-letter queue
  • Observability and metrics
  • See also
• CLI Commands
  • jobs:queue:work
  • jobs:queue:reap
  • jobs:cronjob:run
  • jobs:queue:purge
  • jobs:publish
  • See also

Reference

• Configuration
  • Handlers
  • Handler Security
  • Envelope Signing
  • Idempotency
  • Rate Limiting
  • Dead Letter Queue
  • Timeouts
  • Worker Behaviour
  • Reaper / Visibility
  • Retry / Backoff
  • Queues & Backends
  • Backend-specific Settings
  • Metrics
  • Scheduled jobs: init()
  • Minimal example
• Attempts Semantics
  • Where it lives
  • Life cycle
  • Why this model
  • Reading the attempt in a handler
  • Relation to backoff
  • Relation to delivery guarantees
• Job Dependencies
  • Declaring a dependency
  • How the order is computed
  • Unknown dependencies
  • Cycle detection
  • Combining with other features
• Exception Handling
  • Where exceptions are handled
  • Single attempt — JobRuntime
  • Retry decision — QueueWorker
  • Built-in exceptions
  • Security-related rejections
  • Writing handlers
  • Running the worker under a supervisor

Migration

• Migration to v3

Indices and Tables

• Index

• Search Page