RedisJob

class RedisJob extends Job implements Job (View source)

Properties

protected mixed	$instance	The job handler instance.	from Job
protected Container	$container	The IoC container instance.	from Job
protected string	$queue	The name of the queue the job belongs to.	from Job
protected bool	$deleted	Indicates if the job has been deleted.	from Job
protected bool	$released	Indicates if the job has been released.	from Job
protected RedisQueue	$redis	The Redis queue instance.
protected string	$job	The Redis raw job payload.
protected array	$decoded	The JSON decoded version of "$job".
protected string	$reserved	The Redis job payload inside the reserved queue.

Methods

int

attempts()

Get the number of times the job has been attempted.

string

getRawBody()

Get the raw body string for the job.

void

fire()

Fire the job.

from Job

mixed

resolve(string $class)

Resolve the given job handler.

from Job

void

delete()

Delete the job from the queue.

bool

isDeleted()

Determine if the job has been deleted.

from Job

void

release(int $delay)

Release the job back into the queue.

bool

isReleased()

Determine if the job was released back into the queue.

from Job

bool

isDeletedOrReleased()

Determine if the job has been deleted or released.

from Job

void

failed(Exception $e)

Call the failed method on the job instance.

from Job

array

parseJob(string $job)

Parse the job declaration into class and method.

from Job

int

getSeconds(DateTime|int $delay)

Calculate the number of seconds with the given delay.

from Job

int

getTime()

Get the current system time.

from Job

string

getName()

Get the name of the queued job class.

from Job

string

resolveName()

Get the resolved name of the queued job class.

from Job

array

payload()

Get the decoded body of the job.

from Job

string

getQueue()

Get the name of the queue the job belongs to.

from Job

Container

getContainer()

Get the service container instance.

from Job

__construct(Container $container, RedisQueue $redis, string $job, string $reserved, string $queue)

Create a new job instance.

string

getJobId()

Get the job identifier.

Database

getRedisQueue()

Get the underlying queue driver instance.

string

getReservedJob()

Get the underlying reserved Redis job.

Details

int attempts()

Get the number of times the job has been attempted.

Return Value

int

string getRawBody()

Get the raw body string for the job.

Return Value

string

void fire()

Fire the job.

Return Value

void

protected mixed resolve(string $class)

Resolve the given job handler.

Parameters

string

$class

Return Value

mixed

void delete()

Delete the job from the queue.

Return Value

void

bool isDeleted()

Determine if the job has been deleted.

Return Value

bool

void release(int $delay)

Release the job back into the queue.

Parameters

int

$delay

Return Value

void

bool isReleased()

Determine if the job was released back into the queue.

Return Value

bool

bool isDeletedOrReleased()

Determine if the job has been deleted or released.

Return Value

bool

void failed(Exception $e)

Call the failed method on the job instance.

Parameters

Exception

Return Value

void

protected array parseJob(string $job)

Parse the job declaration into class and method.

Parameters

string

$job

Return Value

array

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 system time.

Return Value

int

string getName()

Get the name of the queued job class.

Return Value

string

string resolveName()

Get the resolved name of the queued job class.

Return Value

string

array payload()

Get the decoded body of the job.

Return Value

array

string getQueue()

Get the name of the queue the job belongs to.

Return Value

string

Container getContainer()

Get the service container instance.

Return Value

Container

__construct(Container $container, RedisQueue $redis, string $job, string $reserved, string $queue)

Create a new job instance.

Parameters

Container	$container
RedisQueue	$redis
string	$job
string	$reserved
string	$queue

string getJobId()

Get the job identifier.

Return Value

string

Database getRedisQueue()

Get the underlying queue driver instance.

Return Value

Database

string getReservedJob()

Get the underlying reserved Redis job.

Return Value

string

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