Protocol
Queue
A type that can store and retrieve jobs from a persistence layer
protocol Queue : Sendable
Topics
Instance Properties
var configuration: QueuesConfigurationThe configuration for the queuevar context: QueueContextThe job contextvar eventLoop: any EventLoopThe EventLoop for a job queuevar key: StringThe key name of the queuevar logger: LoggerA loggervar queueName: QueueNameThe queue’s namevar worker: QueueWorker
Instance Methods
func clear(JobIdentifier) -> EventLoopFuture<Void>Removes a job from the queuefunc dispatch(_:_:maxRetryCount:delayUntil:id:)Dispatch a job into the queue for processingfunc get(JobIdentifier) -> EventLoopFuture<JobData>Gets the next job to be runfunc pop() -> EventLoopFuture<JobIdentifier?>Pops the next job in the queuefunc push(JobIdentifier) -> EventLoopFuture<Void>Pushes the next job into a queuefunc set(JobIdentifier, to: JobData) -> EventLoopFuture<Void>Sets a job that should be run in the future
Relationships
Inherits From
Swift.SendableSwift.SendableMetatype