QueueConfig class final
QUEUE_* configuration (config/queue.php parity).
- Implemented types
Constructors
- QueueConfig({String defaultConnection = 'sync', String defaultQueue = 'default', String table = 'jobs', String failedTable = 'failed_jobs', Duration retryAfter = const Duration(seconds: 90), bool afterCommit = true, String uniqueLockStore = 'process', String? signalStore})
-
Queue settings; usually from
.env(QueueConfig.fromEnv).const - QueueConfig.fromEnv(Env env)
-
The settings in
QUEUE_*.factory
Properties
- afterCommit → bool
-
Dispatches inside a transaction wait for the commit by default.
final
- defaultConnection → String
-
sync|database|memory.final - defaultQueue → String
-
The queue used when a job names none (
default).final - failedTable → String
-
The failed jobs table (
failed_jobs).final - hashCode → int
-
The hash code for this object.
no setterinherited
- key → String
-
Top-level key of the section, e.g.
appordatabase.no setteroverride - retryAfter → Duration
-
How long a reserved job may run before another worker takes it
(
QUEUE_RETRY_AFTER).final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- signalStore → String?
-
Cache store of
queue:restartandqueue:pausesignals (QUEUE_SIGNAL_STORE): by default thefilestore with the database queue (one machine;databasereaches every machine), uniqueLockStore otherwise.final - table → String
-
The jobs table (
jobs).final - uniqueLockStore → String
-
Cache store holding unique-job locks (
QUEUE_UNIQUE_LOCK_STORE;databasewith the database queue,rediswith the redis queue,processotherwise).final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, Object?> -
Plain-map projection used for dot-notation access.
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
check(
Env env, ConfigRepository config) → Iterable< ConfigIssue> -
Warns when the database queue keeps unique-job locks where separate
queue:workprocesses cannot release them.