interface Job

Methods

void
fire()

Fire the job.

mixed
release(int $delay = 0)

Release the job back into the queue.

void
delete()

Delete the job from the queue.

bool
isDeleted()

Determine if the job has been deleted.

bool
isDeletedOrReleased()

Determine if the job has been deleted or released.

int
attempts()

Get the number of times the job has been attempted.

void
failed(Throwable $e)

Process an exception that caused the job to fail.

int|null
maxTries()

The number of times to attempt a job.

int|null
timeout()

The number of seconds the job can run.

string
getName()

Get the name of the queued job class.

string
resolveName()

Get the resolved name of the queued job class.

string
getConnectionName()

Get the name of the connection the job belongs to.

string
getQueue()

Get the name of the queue the job belongs to.

string
getRawBody()

Get the raw body string for the job.

Details

at line 12
void fire()

Fire the job.

Return Value

void

at line 20
mixed release(int $delay = 0)

Release the job back into the queue.

Parameters

int $delay

Return Value

mixed

at line 27
void delete()

Delete the job from the queue.

Return Value

void

at line 34
bool isDeleted()

Determine if the job has been deleted.

Return Value

bool

at line 41
bool isDeletedOrReleased()

Determine if the job has been deleted or released.

Return Value

bool

at line 48
int attempts()

Get the number of times the job has been attempted.

Return Value

int

at line 56
void failed(Throwable $e)

Process an exception that caused the job to fail.

Parameters

Throwable $e

Return Value

void

at line 63
int|null maxTries()

The number of times to attempt a job.

Return Value

int|null

at line 70
int|null timeout()

The number of seconds the job can run.

Return Value

int|null

at line 77
string getName()

Get the name of the queued job class.

Return Value

string

at line 86
string resolveName()

Get the resolved name of the queued job class.

Resolves the name of "wrapped" jobs such as class-based handlers.

Return Value

string

at line 93
string getConnectionName()

Get the name of the connection the job belongs to.

Return Value

string

at line 100
string getQueue()

Get the name of the queue the job belongs to.

Return Value

string

at line 107
string getRawBody()

Get the raw body string for the job.

Return Value

string