class EventQueueTask extends QueueTask (View source)

Traits

Properties

protected string $queue

Define the queue

from  QueueTask
protected int $delay

Define the delay

from  QueueTask
protected int $retry

Define the time of retry

from  QueueTask
protected int $priority

Define the priority

from  QueueTask
protected bool $delete

Determine if the task can be deleted

from  QueueTask
protected string|null $id

Define the task id

from  QueueTask
protected int $attempts

Define the task attempts

from  QueueTask

Methods

array
__serialize()

Prepare the instance values for serialization.

mixed
getPropertyValue(ReflectionProperty $property)

Get the property value for the given property.

void
__unserialize(array $values)

Restore the model after serialization.

void
__construct(EventShouldQueue $event, mixed $payload = null)

EventQueueTask constructor

int
getPriority()

Get the worker priority

string
getId()

Get the worker id

int
getAttempts()

Get the worker attempts

void
setAttempts(int $attempts)

Set the worker attempts

int
getRetry()

Get the worker retry

void
setRetry(int $retry)

Set the worker retry

string
getQueue()

Get the worker queue

void
setQueue(string $queue)

Set the worker queue

int
getDelay()

Get the worker delay

void
setDelay(int $delay)

Set the worker delay

void
deleteTask()

Delete the task from queue.

bool
taskShouldBeDelete()

Delete the task from queue.

void
onException(Throwable $e)

Get the task error

void
process()

Process event

Details

array __serialize()

Prepare the instance values for serialization.

Return Value

array

protected mixed getPropertyValue(ReflectionProperty $property)

Get the property value for the given property.

Parameters

ReflectionProperty $property

Return Value

mixed

void __unserialize(array $values)

Restore the model after serialization.

Parameters

array $values

Return Value

void

void __construct(EventShouldQueue $event, mixed $payload = null)

EventQueueTask constructor

Parameters

EventShouldQueue $event
mixed $payload

Return Value

void

final int getPriority()

Get the worker priority

Return Value

int

string getId()

Get the worker id

Return Value

string

int getAttempts()

Get the worker attempts

Return Value

int

void setAttempts(int $attempts)

Set the worker attempts

Parameters

int $attempts

Return Value

void

final int getRetry()

Get the worker retry

Return Value

int

final void setRetry(int $retry)

Set the worker retry

Parameters

int $retry

Return Value

void

final string getQueue()

Get the worker queue

Return Value

string

final void setQueue(string $queue)

Set the worker queue

Parameters

string $queue

Return Value

void

final int getDelay()

Get the worker delay

Return Value

int

final void setDelay(int $delay)

Set the worker delay

Parameters

int $delay

Return Value

void

void deleteTask()

Delete the task from queue.

Return Value

void

bool taskShouldBeDelete()

Delete the task from queue.

Return Value

bool

void onException(Throwable $e)

Get the task error

Parameters

Throwable $e

Return Value

void

void process()

Process event

Return Value

void