Skip to content

Vapor API Docs

Queues

Core

Vapor AsyncKit RoutingKit ConsoleKit ConsoleLogger beta WebSocketKit MultipartKit

Authentication

JWT JWTKit Authentication

Templating

Leaf LeafKit

Database

Fluent FluentKit FluentSQL FluentPostgresDriver FluentMongoDriver FluentMySQLDriver FluentSQLiteDriver SQLKit PostgresKit MySQLKit SQLiteKit PostgresNIO MySQLNIO SQLiteNIO Redis

Queues

Queues QueuesRedisDriver

Push Notifications

APNS

Testing

XCTVapor VaporTesting XCTFluent XCTQueues

Classes
QueuesCommand
- Structures
- QueuesCommand.Signature
  - Initializers
  - init()
- Initializers
- init(application: Application, scheduled: Bool)
- Instance Properties
- var help: String
- let signature: QueuesCommand.Signature
- Instance Methods
- func asyncShutdown() async
- func run(using: CommandContext, signature: QueuesCommand.Signature) async throws
- func shutdown()
- func startJobs(on: QueueName) throws
- func startScheduledJobs() throws
ScheduleBuilder
Protocols
AnyJob
- Type Properties
- static var name: String
  - AnyJob Implementations
    - static var name: String
AsyncJob
AsyncJobEventDelegate
AsyncQueue
AsyncScheduledJob
Job
JobEventDelegate
Queue
QueuesDriver
ScheduledJob
Structures
JobData
- Initializers
- init(from: any Decoder) throws
- init(payload: [UInt8], maxRetryCount: Int, jobName: String, delayUntil: Date?, queuedAt: Date, attempts: Int)
- Instance Properties
- let attempts: Int?
- let delayUntil: Date?
- let jobName: String
- let maxRetryCount: Int
- let payload: [UInt8]
- let queuedAt: Date
JobEventData
- Initializers
- init(id: String, queueName: String, jobData: JobData)
- Instance Properties
- var delayUntil: Date?
- var id: String
- var jobName: String
- var maxRetryCount: Int
- var payload: [UInt8]
- var queueName: String
- var queuedAt: Date
JobIdentifier
- Initializers
- init()
- init(string: String)
- Instance Properties
- let string: String
QueueContext
- Initializers
- init(queueName: QueueName, configuration: QueuesConfiguration, application: Application, logger: Logger, on: any EventLoop)
- Instance Properties
- let application: Application
- let configuration: QueuesConfiguration
- let eventLoop: any EventLoop
- var logger: Logger
- var queue: any Queue
- let queueName: QueueName
- Instance Methods
- func queues(QueueName) -> any Queue
QueueName
- Initializers
- init(string: String)
- init(string: String, workerCount: Int?)
- Instance Properties
- let string: String
- let workerCount: Int?
- Instance Methods
- func makeKey(with: String) -> String
- Type Properties
- static let `default`: QueueName
QueueWorker
- Instance Methods
- func run()
QueuesConfiguration
Enumerations
QueuesEventLoopPreference
- Enumeration Cases
- case delegate(on: any EventLoop)
- case indifferent
- Instance Methods
- func delegate(for: any EventLoopGroup) -> any EventLoop
Extended Modules
Vapor

API Docs
Framework Docs

- API Docs
  
  Reference documentation for Vapor
- Framework Docs
  
  Learn how to use Vapor
Home
Store
Showcase
Team
Blog
GitHub
Theme
- Light
- Dark
- System

Instance Property

payload

The job data to be encoded.

var payload: [UInt8]

Vapor

Reference documentation for Vapor and its ecosystem.

Community

Team
Join our Discord
Store
Showcase
Supporters

Resources

Blog
Framework Docs
API Docs
Press Kit
Help

Twitter
Mastodon
Bsky
GitHub