Sqs
extends AbstractAdapter
in package
SQS adapter class
Tags
Table of Contents
Properties
- $client : SqsClient|null
- SQS client
- $groupId : string
- Message group ID
- $priority : string
- Queue priority
- $queueUrl : string|null
- Queue URL
- $receiptHandles : array<string|int, mixed>
- In-flight receipt handles, keyed by job ID, populated by reserve() and consumed by delete()/release()/bury()
Methods
- __construct() : mixed
- Constructor
- bury() : Sqs
- Stop redelivering a job. SQS cannot durably record a dead-letter reason from this client alone — configure a native SQS redrive policy on a separate dead-letter queue for real dead-letter handling.
- clear() : Sqs
- Clear pending and reserved jobs
- clearDead() : Sqs
- client() : SqsClient|null
- Get SQS client (alias)
- count() : int
- Count of pending + reserved jobs
- countDead() : int
- create() : Sqs
- Create SQS adapter
- delete() : Sqs
- Permanently remove a job
- deleteDeadJob() : Sqs
- getClient() : SqsClient|null
- Get SQS client
- getDeadJob() : mixed
- getDeadJobs() : array<string|int, mixed>
- getEnd() : int
- Get the count of messages on the queue, both visible (pending) and not visible (reserved/in-flight), per the adapter contract
- getGroupId() : string
- Get queue group ID
- getPriority() : string
- getQueueUrl() : string
- Get queue URL
- hasDeadJobs() : bool
- hasJobs() : bool
- Check if adapter has jobs
- isFifo() : bool
- isFilo() : bool
- isLifo() : bool
- isLilo() : bool
- push() : Sqs
- Push job on to queue
- release() : Sqs
- Put a job back to pending (delete + re-send; SQS has no in-place requeue)
- reserve() : AbstractJob|null
- Atomically claim the next eligible job, via SQS's native visibility timeout
- retryDeadJob() : AdapterInterface
- Move a dead-letter job back to pending
- setPriority() : AbstractAdapter
Properties
$client
SQS client
protected
SqsClient|null
$client
= null
$groupId
Message group ID
protected
string
$groupId
= 'pop-queue'
$priority
Queue priority
protected
string
$priority
= 'FIFO'
$queueUrl
Queue URL
protected
string|null
$queueUrl
= null
$receiptHandles
In-flight receipt handles, keyed by job ID, populated by reserve() and consumed by delete()/release()/bury()
protected
array<string|int, mixed>
$receiptHandles
= []
Methods
__construct()
Constructor
public
__construct(SqsClient $client, string $queueUrl[, string $groupId = 'pop-queue' ]) : mixed
Parameters
- $client : SqsClient
- $queueUrl : string
- $groupId : string = 'pop-queue'
bury()
Stop redelivering a job. SQS cannot durably record a dead-letter reason from this client alone — configure a native SQS redrive policy on a separate dead-letter queue for real dead-letter handling.
public
bury(AbstractJob $job[, string|null $reason = null ]) : Sqs
Parameters
- $job : AbstractJob
- $reason : string|null = null
Return values
Sqsclear()
Clear pending and reserved jobs
public
clear() : Sqs
Return values
SqsclearDead()
public
clearDead() : Sqs
Return values
Sqsclient()
Get SQS client (alias)
public
client() : SqsClient|null
Return values
SqsClient|nullcount()
Count of pending + reserved jobs
public
count() : int
Return values
intcountDead()
public
countDead() : int
Return values
intcreate()
Create SQS adapter
public
static create(SqsClient $client, string $queueUrl[, string $groupId = 'pop-queue' ]) : Sqs
Parameters
- $client : SqsClient
- $queueUrl : string
- $groupId : string = 'pop-queue'
Return values
Sqsdelete()
Permanently remove a job
public
delete(AbstractJob $job) : Sqs
Parameters
- $job : AbstractJob
Return values
SqsdeleteDeadJob()
public
deleteDeadJob(string $jobId) : Sqs
Parameters
- $jobId : string
Tags
Return values
SqsgetClient()
Get SQS client
public
getClient() : SqsClient|null
Return values
SqsClient|nullgetDeadJob()
public
getDeadJob(string $jobId[, bool $unserialize = true ]) : mixed
Parameters
- $jobId : string
- $unserialize : bool = true
getDeadJobs()
public
getDeadJobs([bool $unserialize = true ]) : array<string|int, mixed>
Parameters
- $unserialize : bool = true
Return values
array<string|int, mixed>getEnd()
Get the count of messages on the queue, both visible (pending) and not visible (reserved/in-flight), per the adapter contract
public
getEnd() : int
Return values
intgetGroupId()
Get queue group ID
public
getGroupId() : string
Return values
stringgetPriority()
public
getPriority() : string
Return values
stringgetQueueUrl()
Get queue URL
public
getQueueUrl() : string
Return values
stringhasDeadJobs()
public
hasDeadJobs() : bool
Return values
boolhasJobs()
Check if adapter has jobs
public
hasJobs() : bool
Return values
boolisFifo()
public
isFifo() : bool
Return values
boolisFilo()
public
isFilo() : bool
Return values
boolisLifo()
public
isLifo() : bool
Return values
boolisLilo()
public
isLilo() : bool
Return values
boolpush()
Push job on to queue
public
push(AbstractJob $job) : Sqs
Parameters
- $job : AbstractJob
Return values
Sqsrelease()
Put a job back to pending (delete + re-send; SQS has no in-place requeue)
public
release(AbstractJob $job[, int|null $delay = null ]) : Sqs
Parameters
- $job : AbstractJob
- $delay : int|null = null
Return values
Sqsreserve()
Atomically claim the next eligible job, via SQS's native visibility timeout
public
reserve() : AbstractJob|null
Return values
AbstractJob|nullretryDeadJob()
Move a dead-letter job back to pending
public
retryDeadJob(string $jobId) : AdapterInterface
Parameters
- $jobId : string
Tags
Return values
AdapterInterfacesetPriority()
public
setPriority([string $priority = 'FIFO' ]) : AbstractAdapter
Parameters
- $priority : string = 'FIFO'