W3cubDocs

/Laravel 5.8

CallQueuedListener

class CallQueuedListener implements ShouldQueue (View source)

Traits

InteractsWithQueue

Properties

protected Job $job The underlying queue job instance. from InteractsWithQueue
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 $timeoutAt 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
void __construct(string $class, string $method, array $data)

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

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

Set the job instance of the given class if necessary.
void failed(Exception $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

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 mixed setJobInstanceIfNecessary(Job $job, mixed $instance)

Set the job instance of the given class if necessary.

Parameters

Job $job
mixed $instance

Return Value

mixed

void failed(Exception $e)

Call the failed method on the job instance.

The event instance and the exception will be passed.

Parameters

Exception $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/5.8/Illuminate/Events/CallQueuedListener.html