final class DatabaseQueueTransport implements RenewableQueueTransportInterface (View source)

internal  Applications should dispatch and process messages through QueueBusInterface.
 

Persists authenticated queue envelopes and fences each database delivery with an expiring owner token.

Constants

private MAX_ERROR_BYTES

private MAX_CLAIM_ATTEMPTS

Methods

__construct(DatabaseDriverInterface $db, MessageSerializer $serializer, ConnectionInterface $connection, DatabaseQueueDialect $dialect, DatabaseQueueSchemaValidator $schemaValidator, string $table = 'system_queue_job', string $failedTable = 'system_queue_failed_job', int $leaseSeconds = 300, int $maxAttempts = 3)

Creates a transport whose claim, failure, and renewal decisions use authoritative database time.

void
enqueue(QueuedMessage $message, int $delaySeconds = 0)

Persists a registered message with availability derived exclusively from database time.

void
dequeue(string $queue)

Claims one ready or expired job through a bounded optimistic compare-and-set loop.

void
ack(QueuedMessage $message)

Deletes a completed job only while this delivery still owns a live database lease.

void
void
fail(QueuedMessage $message, string $error)

Atomically quarantines a failed delivery only while its reservation remains live and owned.

void
int
renew(QueuedMessage $message)

Extends a live owned lease without reviving an expired or replaced reservation.

int

Details

__construct

__construct(DatabaseDriverInterface $db, MessageSerializer $serializer, ConnectionInterface $connection, DatabaseQueueDialect $dialect, DatabaseQueueSchemaValidator $schemaValidator, string $table = 'system_queue_job', string $failedTable = 'system_queue_failed_job', int $leaseSeconds = 300, int $maxAttempts = 3)

Creates a transport whose claim, failure, and renewal decisions use authoritative database time.

Parameters

DatabaseDriverInterface $db
MessageSerializer $serializer
ConnectionInterface $connection
DatabaseQueueDialect $dialect
DatabaseQueueSchemaValidator $schemaValidator
string $table
string $failedTable
int $leaseSeconds
int $maxAttempts

enqueue

void enqueue(QueuedMessage $message, int $delaySeconds = 0)

Persists a registered message with availability derived exclusively from database time.

Parameters

QueuedMessage $message
int $delaySeconds

Return Value

void

dequeue

QueuedMessage|null dequeue(string $queue)

Claims one ready or expired job through a bounded optimistic compare-and-set loop.

Parameters

string $queue

Return Value

QueuedMessage|null

ack

void ack(QueuedMessage $message)

Deletes a completed job only while this delivery still owns a live database lease.

Parameters

QueuedMessage $message

Return Value

void

fail

void fail(QueuedMessage $message, string $error)

Atomically quarantines a failed delivery only while its reservation remains live and owned.

Parameters

QueuedMessage $message
string $error

Return Value

void

renew

int renew(QueuedMessage $message)

Extends a live owned lease without reviving an expired or replaced reservation.

Parameters

QueuedMessage $message

Return Value

int