QueueDriver class abstract
Abstract interface for queue storage backends.
Implement this to plug in Redis, PostgreSQL, SQS, or any other message broker as a queue backend.
- Implementers
Constructors
- QueueDriver()
- Internal constructor for QueueDriver.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
clear(
[String queue = 'default']) → Future< void> -
Clears all jobs from the
queue. Primarily for testing. -
clearDeadLetters(
) → Future< void> - Clears the dead letter queue.
-
complete(
Job job) → Future< void> -
Marks a
jobas completed and removes it from the active set. -
deadLetterJobs(
) → Future< List< Map< >String, dynamic> > - Returns all permanently failed jobs (dead letter queue).
-
fail(
Job job) → Future< void> -
Permanently removes a failed
joband stores it in the dead letter queue. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pop(
[String queue = 'default']) → Future< Job?> -
Pops the next available job from the
queueatomically. -
push(
Job job, [String queue = 'default']) → Future< void> -
Pushes a
jobonto the specifiedqueue. -
release(
Job job) → Future< void> -
Returns a
jobto the queue for retry, respecting itsavailableAt. -
retryDeadLetter(
String jobId) → Future< bool> -
Retries a dead-letter job by its
jobId, moving it back to the queue. -
size(
[String queue = 'default']) → Future< int> -
Returns the number of pending jobs in the
queue. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited