SqsQueue

class SqsQueue extends Queue implements Queue, ClearableQueue (View source)

Traits

InteractsWithTime

Properties

protected Container $container

The IoC container instance.

 from Queue
protected string $connectionName

The connection name for the queue.

 from Queue
protected $dispatchAfterCommit

Indicates that jobs should be dispatched after all database transactions have committed.

 from Queue
static protected callable[] $createPayloadCallbacks

The create payload callbacks.

 from Queue
protected SqsClient $sqs

The Amazon SQS instance.
protected string $default

The name of the default queue.
protected string $prefix

The queue URL prefix.

Methods

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

 from InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

 from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

 from InteractsWithTime
int currentTime()

Get the current system time as a UNIX timestamp.

 from InteractsWithTime
mixed pushOn(string $queue, string $job, mixed $data = '')

Push a new job onto the queue.

 from Queue
mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')

Push a new job onto a specific queue after (n) seconds.

 from Queue
void bulk(array $jobs, mixed $data = '', string|null $queue = null)

Push an array of jobs onto the queue.
string createPayload(Closure|string|object $job, string $queue, mixed $data = '')

Create a payload string from the given job and data.

 from Queue
array createPayloadArray(string|object $job, string $queue, mixed $data = '')

Create a payload array from the given job and data.

 from Queue
array createObjectPayload(object $job, string $queue)

Create a payload for an object-based queue handler.

 from Queue
string getDisplayName(object $job)

Get the display name for the given job.

 from Queue
mixed getJobBackoff(mixed $job)

Get the backoff for an object-based queue handler.

 from Queue
mixed getJobExpiration(mixed $job)

Get the expiration timestamp for an object-based queue handler.

 from Queue
bool jobShouldBeEncrypted(object $job)

Determine if the job should be encrypted.

 from Queue
array createStringPayload(string $job, string $queue, mixed $data)

Create a typical, string based queue payload array.

 from Queue
static void createPayloadUsing(callable|null $callback)

Register a callback to be executed when creating job payloads.

 from Queue
array withCreatePayloadHooks(string $queue, array $payload)

Create the given payload using any registered payload hooks.

 from Queue
mixed enqueueUsing(Closure|string|object $job, string $payload, string $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)

Enqueue a job using the given callback.

 from Queue
bool shouldDispatchAfterCommit(Closure|string|object $job)

Determine if the job should be dispatched after all database transactions have committed.

 from Queue
void raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job)

Raise the job queued event.

 from Queue
string getConnectionName()

Get the connection name for the queue.

 from Queue
$this setConnectionName(string $name)

Set the connection name for the queue.

 from Queue
Container getContainer()

Get the container instance being used by the connection.

 from Queue
void setContainer(Container $container)

Set the IoC container instance.

 from Queue
void __construct(SqsClient $sqs, string $default, string $prefix = '', string $suffix = '', bool $dispatchAfterCommit = false)

Create a new Amazon SQS queue instance.
int size(string|null $queue = null)

Get the size of the queue.
mixed push(string|object $job, mixed $data = '', string|null $queue = null)

Push a new job onto the queue.
mixed pushRaw(string $payload, string|null $queue = null, array $options = [])

Push a raw payload onto the queue.
mixed later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null)

Push a new job onto the queue after (n) seconds.
Job|null pop(string|null $queue = null)

Pop the next job off of the queue.
int clear(string $queue)

Delete all of the jobs from the queue.
string getQueue(string|null $queue)

Get the queue or return the default.
string suffixQueue(string $queue, string $suffix = '')

Add the given suffix to the given queue name.
SqsClient getSqs()

Get the underlying SQS instance.

Details

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

mixed pushOn(string $queue, string $job, mixed $data = '')

Push a new job onto the queue.

Parameters

string $queue
string $job
mixed $data

Return Value

mixed

mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')

Push a new job onto a specific queue after (n) seconds.

Parameters

string $queue
DateTimeInterface|DateInterval|int $delay
string $job
mixed $data

Return Value

mixed

void bulk(array $jobs, mixed $data = '', string|null $queue = null)

Push an array of jobs onto the queue.

Parameters

array $jobs
mixed $data
string|null $queue

Return Value

void

protected string createPayload(Closure|string|object $job, string $queue, mixed $data = '')

Create a payload string from the given job and data.

Parameters

Closure|string|object $job
string $queue
mixed $data

Return Value

string

Exceptions

InvalidPayloadException

protected array createPayloadArray(string|object $job, string $queue, mixed $data = '')

Create a payload array from the given job and data.

Parameters

string|object $job
string $queue
mixed $data

Return Value

array

protected array createObjectPayload(object $job, string $queue)

Create a payload for an object-based queue handler.

Parameters

object $job
string $queue

Return Value

array

protected string getDisplayName(object $job)

Get the display name for the given job.

Parameters

object $job

Return Value

string

mixed getJobBackoff(mixed $job)

Get the backoff for an object-based queue handler.

Parameters

mixed $job

Return Value

mixed

mixed getJobExpiration(mixed $job)

Get the expiration timestamp for an object-based queue handler.

Parameters

mixed $job

Return Value

mixed

protected bool jobShouldBeEncrypted(object $job)

Determine if the job should be encrypted.

Parameters

object $job

Return Value

bool

protected array createStringPayload(string $job, string $queue, mixed $data)

Create a typical, string based queue payload array.

Parameters

string $job
string $queue
mixed $data

Return Value

array

static void createPayloadUsing(callable|null $callback)

Register a callback to be executed when creating job payloads.

Parameters

callable|null $callback

Return Value

void

protected array withCreatePayloadHooks(string $queue, array $payload)

Create the given payload using any registered payload hooks.

Parameters

string $queue
array $payload

Return Value

array

protected mixed enqueueUsing(Closure|string|object $job, string $payload, string $queue, DateTimeInterface|DateInterval|int|null $delay, callable $callback)

Enqueue a job using the given callback.

Parameters

Closure|string|object $job
string $payload
string $queue
DateTimeInterface|DateInterval|int|null $delay
callable $callback

Return Value

mixed

protected bool shouldDispatchAfterCommit(Closure|string|object $job)

Determine if the job should be dispatched after all database transactions have committed.

Parameters

Closure|string|object $job

Return Value

bool

protected void raiseJobQueuedEvent(string|int|null $jobId, Closure|string|object $job)

Raise the job queued event.

Parameters

string|int|null $jobId
Closure|string|object $job

Return Value

void

string getConnectionName()

Get the connection name for the queue.

Return Value

string

$this setConnectionName(string $name)

Set the connection name for the queue.

Parameters

string $name

Return Value

$this

Container getContainer()

Get the container instance being used by the connection.

Return Value

Container

void setContainer(Container $container)

Set the IoC container instance.

Parameters

Container $container

Return Value

void

void __construct(SqsClient $sqs, string $default, string $prefix = '', string $suffix = '', bool $dispatchAfterCommit = false)

Create a new Amazon SQS queue instance.

Parameters

SqsClient $sqs
string $default
string $prefix
string $suffix
bool $dispatchAfterCommit

Return Value

void

int size(string|null $queue = null)

Get the size of the queue.

Parameters

string|null $queue

Return Value

int

mixed push(string|object $job, mixed $data = '', string|null $queue = null)

Push a new job onto the queue.

Parameters

string|object $job
mixed $data
string|null $queue

Return Value

mixed

mixed pushRaw(string $payload, string|null $queue = null, array $options = [])

Push a raw payload onto the queue.

Parameters

string $payload
string|null $queue
array $options

Return Value

mixed

mixed later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null)

Push a new job onto the queue after (n) seconds.

Parameters

DateTimeInterface|DateInterval|int $delay
string|object $job
mixed $data
string|null $queue

Return Value

mixed

Job|null pop(string|null $queue = null)

Pop the next job off of the queue.

Parameters

string|null $queue

Return Value

Job|null

int clear(string $queue)

Delete all of the jobs from the queue.

Parameters

string $queue

Return Value

int

string getQueue(string|null $queue)

Get the queue or return the default.

Parameters

string|null $queue

Return Value

string

protected string suffixQueue(string $queue, string $suffix = '')

Add the given suffix to the given queue name.

Parameters

string $queue
string $suffix

Return Value

string

SqsClient getSqs()

Get the underlying SQS instance.

Return Value

SqsClient

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Queue/SqsQueue.html