CallQueuedListener

class CallQueuedListener implements ShouldQueue (View source)

Traits

InteractsWithQueue
Queueable

Properties

Job $job The underlying queue job instance. from InteractsWithQueue
string|null $connection The name of the connection the job should be sent to. from Queueable
string|null $queue The name of the queue the job should be sent to. from Queueable
string|null $chainConnection The name of the connection the chain should be sent to. from Queueable
string|null $chainQueue The name of the queue the chain should be sent to. from Queueable
array|null $chainCatchCallbacks The callbacks to be executed on chain failure. from Queueable
DateTimeInterface|DateInterval|int|null $delay The number of seconds before the job should be made available. from Queueable
array $middleware The middleware the job should be dispatched through. from Queueable
array $chained The jobs that should run if this job is successful. from Queueable
string $class The listener class name.
string $method The listener method.
array $data The data to be passed to the listener.
int $tries The number of times the job may be attempted.
int $backoff The number of seconds to wait before retrying a job that encountered an uncaught exception.
int $retryUntil The timestamp indicating when the job should timeout.
int $timeout The number of seconds the job can run before timing out.

Methods

int attempts()

Get the number of times the job has been attempted.

 from InteractsWithQueue
void delete()

Delete the job from the queue.

 from InteractsWithQueue
void fail(Throwable|null $exception = null)

Fail the job from the queue.

 from InteractsWithQueue
void release(int $delay = 0)

Release the job back into the queue.

 from InteractsWithQueue
$this setJob(Job $job)

Set the base queue job instance.

 from InteractsWithQueue
$this onConnection(string|null $connection)

Set the desired connection for the job.

 from Queueable
$this onQueue(string|null $queue)

Set the desired queue for the job.

 from Queueable
$this allOnConnection(string|null $connection)

Set the desired connection for the chain.

 from Queueable
$this allOnQueue(string|null $queue)

Set the desired queue for the chain.

 from Queueable
$this delay(DateTimeInterface|DateInterval|int|null $delay)

Set the desired delay for the job.

 from Queueable
$this through(array|object $middleware)

Specify the middleware the job should be dispatched through.

 from Queueable
$this chain(array $chain)

Set the jobs that should run if this job is successful.

 from Queueable
string serializeJob(mixed $job)

Serialize a job for queuing.

 from Queueable
void dispatchNextJobInChain()

Dispatch the next job on the chain.

 from Queueable
void invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

 from Queueable
void __construct(string $class, string $method, array $data)

Create a new job instance.
void handle(Container $container)

Handle the queued job.
object setJobInstanceIfNecessary(Job $job, object $instance)

Set the job instance of the given class if necessary.
void failed(Throwable $e)

Call the failed method on the job instance.
void prepareData()

Unserialize the data if needed.
string displayName()

Get the display name for the queued job.
void __clone()

Prepare the instance for cloning.

Details

int attempts()

Get the number of times the job has been attempted.

Return Value

int

void delete()

Delete the job from the queue.

Return Value

void

void fail(Throwable|null $exception = null)

Fail the job from the queue.

Parameters

Throwable|null $exception

Return Value

void

void release(int $delay = 0)

Release the job back into the queue.

Parameters

int $delay

Return Value

void

$this setJob(Job $job)

Set the base queue job instance.

Parameters

Job $job

Return Value

$this

$this onConnection(string|null $connection)

Set the desired connection for the job.

Parameters

string|null $connection

Return Value

$this

$this onQueue(string|null $queue)

Set the desired queue for the job.

Parameters

string|null $queue

Return Value

$this

$this allOnConnection(string|null $connection)

Set the desired connection for the chain.

Parameters

string|null $connection

Return Value

$this

$this allOnQueue(string|null $queue)

Set the desired queue for the chain.

Parameters

string|null $queue

Return Value

$this

$this delay(DateTimeInterface|DateInterval|int|null $delay)

Set the desired delay for the job.

Parameters

DateTimeInterface|DateInterval|int|null $delay

Return Value

$this

$this through(array|object $middleware)

Specify the middleware the job should be dispatched through.

Parameters

array|object $middleware

Return Value

$this

$this chain(array $chain)

Set the jobs that should run if this job is successful.

Parameters

array $chain

Return Value

$this

protected string serializeJob(mixed $job)

Serialize a job for queuing.

Parameters

mixed $job

Return Value

string

void dispatchNextJobInChain()

Dispatch the next job on the chain.

Return Value

void

void invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

Parameters

Throwable $e

Return Value

void

void __construct(string $class, string $method, array $data)

Create a new job instance.

Parameters

string $class
string $method
array $data

Return Value

void

void handle(Container $container)

Handle the queued job.

Parameters

Container $container

Return Value

void

protected object setJobInstanceIfNecessary(Job $job, object $instance)

Set the job instance of the given class if necessary.

Parameters

Job $job
object $instance

Return Value

object

void failed(Throwable $e)

Call the failed method on the job instance.

The event instance and the exception will be passed.

Parameters

Throwable $e

Return Value

void

protected void prepareData()

Unserialize the data if needed.

Return Value

void

string displayName()

Get the display name for the queued job.

Return Value

string

void __clone()

Prepare the instance for cloning.

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Events/CallQueuedListener.html