1. class
  2. Illuminate
  3. Queue
  4. SqsQueue

SqsQueue

class SqsQueue extends Queue implements Queue (View source)

Methods

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

Push a new job onto the queue.

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

Push a new job onto the queue after a delay.

from Queue
marshal()

Marshal a push queue request and fire the job.

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

Push an array of jobs onto the queue.

from Queue
void
setContainer( Container $container)

Set the IoC container instance.

from Queue
void
setEncrypter( Encrypter $crypt)

Set the encrypter instance.

from Queue
void
__construct( SqsClient $sqs, string $default, string $prefix = '')

Create a new Amazon SQS queue instance.

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

Push a new job onto the queue.

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

Push a raw payload onto the queue.

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

Push a new job onto the queue after a delay.

Job|null
pop( string $queue = null)

Pop the next job off of the queue.

$this
createJobsUsing( callable $callback)

Define the job creator callback for the connection.

string
getQueue( string|null $queue)

Get the queue or return the default.

SqsClient
getSqs()

Get the underlying SQS instance.

Details

in Queue at line line 31
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

in Queue at line line 45
mixed laterOn( string $queue, DateTime|int $delay, string $job, mixed $data = '')

Push a new job onto the queue after a delay.

Parameters

string $queue
DateTime|int $delay
string $job
mixed $data

Return Value

mixed

in Queue at line line 57
marshal()

Marshal a push queue request and fire the job.

Exceptions

RuntimeException

in Queue at line line 70
mixed bulk( array $jobs, mixed $data = '', string $queue = null)

Push an array of jobs onto the queue.

Parameters

array $jobs
mixed $data
string $queue

Return Value

mixed

in Queue at line line 211
void setContainer( Container $container)

Set the IoC container instance.

Parameters

Container $container

Return Value

void

in Queue at line line 222
void setEncrypter( Encrypter $crypt)

Set the encrypter instance.

Parameters

Encrypter $crypt

Return Value

void

at line line 47
void __construct( SqsClient $sqs, string $default, string $prefix = '')

Create a new Amazon SQS queue instance.

Parameters

SqsClient $sqs
string $default
string $prefix

Return Value

void

at line line 62
mixed push( string $job, mixed $data = '', string $queue = null)

Push a new job onto the queue.

Parameters

string $job
mixed $data
string $queue

Return Value

mixed

at line line 75
mixed pushRaw( string $payload, string $queue = null, array $options = array())

Push a raw payload onto the queue.

Parameters

string $payload
string $queue
array $options

Return Value

mixed

at line line 91
mixed later( DateTime|int $delay, string $job, mixed $data = '', string $queue = null)

Push a new job onto the queue after a delay.

Parameters

DateTime|int $delay
string $job
mixed $data
string $queue

Return Value

mixed

at line line 110
Job|null pop( string $queue = null)

Pop the next job off of the queue.

Parameters

string $queue

Return Value

Job|null

at line line 133
$this createJobsUsing( callable $callback)

Define the job creator callback for the connection.

Parameters

callable $callback

Return Value

$this

at line line 146
string getQueue( string|null $queue)

Get the queue or return the default.

Parameters

string|null $queue

Return Value

string

at line line 162
SqsClient getSqs()

Get the underlying SQS instance.

Return Value

SqsClient