Structure

Application.Queues

Contains global configuration for queues and provides methods for registering jobs and retrieving queues.

struct Queues

Topics

Structures

struct Provider
A provider for a Application.Queues driver.

Instance Properties

let application: Application
var configuration: QueuesConfiguration
The QueuesConfiguration object.
var driver: any QueuesDriver
The selected QueuesDriver.
var queue: any Queue
Get the default Queue.

Instance Methods

func add(_:)
Add a new notification hook.
func queue(QueueName, logger: Logger?, on: (any EventLoop)?) -> any Queue
Create or look up an instance of a named Queue.
func schedule(some ScheduledJob) -> ScheduleBuilder
Schedule a new job.
func startInProcessJobs(on: QueueName) throws
Starts an in-process worker to dequeue and run jobs.
func startScheduledJobs() throws
Starts an in-process worker to run scheduled jobs.
func use(Application.Queues.Provider)
Choose which provider to use.
func use(custom: any QueuesDriver)
Configure a driver.