W3cubDocs

/Laravel 4.2

SqsQueue

class SqsQueue extends Queue implements QueueInterface (View source)

Methods

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
int getTime()

Get the current UNIX timestamp.

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)

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.

string getQueue(string|null $queue)

Get the queue or return the default.

SqsClient getSqs()

Get the underlying SQS instance.

Details

marshal()

Marshal a push queue request and fire the job.

Exceptions

RuntimeException

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

int getTime()

Get the current UNIX timestamp.

Return Value

int

void setContainer(Container $container)

Set the IoC container instance.

Parameters

Container $container

Return Value

void

void setEncrypter(Encrypter $crypt)

Set the encrypter instance.

Parameters

Encrypter $crypt

Return Value

void

void __construct(SqsClient $sqs, string $default)

Create a new Amazon SQS queue instance.

Parameters

SqsClient $sqs
string $default

Return Value

void

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

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

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

Job|null pop(string $queue = null)

Pop the next job off of the queue.

Parameters

string $queue

Return Value

Job|null

string getQueue(string|null $queue)

Get the queue or return the default.

Parameters

string|null $queue

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/4.2/Illuminate/Queue/SqsQueue.html