SyncQueue

class SyncQueue extends Queue implements Queue (View source)

Properties

protected Container $container The IoC container instance. from Queue
protected Encrypter $encrypter The encrypter implementation. from Queue

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
mixed bulk(array $jobs, mixed $data = '', string $queue = null)

Push an array of jobs onto the queue.

 from Queue
string createPayload(string $job, mixed $data = '', string $queue = null)

Create a payload string from the given job and data.

 from Queue
array createPlainPayload(string $job, mixed $data)

Create a typical, "plain" queue payload array.

 from Queue
string setMeta(string $payload, string $key, string $value)

Set additional meta on a payload string.

 from Queue
int getSeconds(DateTime|int $delay)

Calculate the number of seconds with the given delay.

 from Queue
int getTime()

Get the current UNIX timestamp.

 from Queue
void setContainer(Container $container)

Set the IoC container instance.

 from Queue
int size(string $queue = null)

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

Push a new job onto the queue.
void handleSyncException(Job $queueJob, Exception $e)

Handle an exception that occurred while processing a job.
mixed pushRaw(string $payload, string $queue = null, array $options = [])

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.
SyncJob resolveJob(string $payload, string $queue)

Resolve a Sync job instance.
void raiseBeforeJobEvent(Job $job)

Raise the before queue job event.
void raiseAfterJobEvent(Job $job)

Raise the after queue job event.
void raiseExceptionOccurredJobEvent(Job $job, Exception $e)

Raise the exception occurred queue job event.
array handleFailedJob(Job $job, Exception $e)

Handle the failed job.
void raiseFailedJobEvent(Job $job, Exception $e)

Raise the failed queue job event.

Details

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, 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

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

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

Create a payload string from the given job and data.

Parameters

string $job
mixed $data
string $queue

Return Value

string

Exceptions

InvalidArgumentException

protected array createPlainPayload(string $job, mixed $data)

Create a typical, "plain" queue payload array.

Parameters

string $job
mixed $data

Return Value

array

protected string setMeta(string $payload, string $key, string $value)

Set additional meta on a payload string.

Parameters

string $payload
string $key
string $value

Return Value

string

Exceptions

InvalidArgumentException

protected int getSeconds(DateTime|int $delay)

Calculate the number of seconds with the given delay.

Parameters

DateTime|int $delay

Return Value

int

protected 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

int size(string $queue = null)

Get the size of the queue.

Parameters

string $queue

Return Value

int

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

Exceptions

Throwable

protected void handleSyncException(Job $queueJob, Exception $e)

Handle an exception that occurred while processing a job.

Parameters

Job $queueJob
Exception $e

Return Value

void

Exceptions

Exception

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

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

protected SyncJob resolveJob(string $payload, string $queue)

Resolve a Sync job instance.

Parameters

string $payload
string $queue

Return Value

SyncJob

protected void raiseBeforeJobEvent(Job $job)

Raise the before queue job event.

Parameters

Job $job

Return Value

void

protected void raiseAfterJobEvent(Job $job)

Raise the after queue job event.

Parameters

Job $job

Return Value

void

protected void raiseExceptionOccurredJobEvent(Job $job, Exception $e)

Raise the exception occurred queue job event.

Parameters

Job $job
Exception $e

Return Value

void

protected array handleFailedJob(Job $job, Exception $e)

Handle the failed job.

Parameters

Job $job
Exception $e

Return Value

array

protected void raiseFailedJobEvent(Job $job, Exception $e)

Raise the failed queue job event.

Parameters

Job $job
Exception $e

Return Value

void

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