W3cubDocs

/Laravel 5.2

BeanstalkdJob

class BeanstalkdJob extends Job implements Job (View source)

Methods

void

fire()

Fire the 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

int

attempts()

Get the number of times the job has been attempted.

string

getRawBody()

Get the raw body string for the job.

void

failed()

Call the failed method on the job instance.

from Job

string

getName()

Get the name of the queued job class.

from Job

string

getQueue()

Get the name of the queue the job belongs to.

from Job

void

__construct( Container $container, Pheanstalk $pheanstalk, Job $job, string $queue)

Create a new job instance.

void

bury()

Bury the job in the queue.

string

getJobId()

Get the job identifier.

Container

getContainer()

Get the IoC container instance.

Pheanstalk

getPheanstalk()

Get the underlying Pheanstalk instance.

Job

getPheanstalkJob()

Get the underlying Pheanstalk job.

Details

void fire()

Fire the job.

Return Value

void

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

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 failed()

Call the failed method on the job instance.

Return Value

void

string getName()

Get the name of the queued job class.

Return Value

string

string getQueue()

Get the name of the queue the job belongs to.

Return Value

string

void __construct( Container $container, Pheanstalk $pheanstalk, Job $job, string $queue)

Create a new job instance.

Parameters

Container	$container
Pheanstalk	$pheanstalk
Job	$job
string	$queue

Return Value

void

void bury()

Bury the job in the queue.

Return Value

void

string getJobId()

Get the job identifier.

Return Value

string

Container getContainer()

Get the IoC container instance.

Return Value

Container

Pheanstalk getPheanstalk()

Get the underlying Pheanstalk instance.

Return Value

Pheanstalk

Job getPheanstalkJob()

Get the underlying Pheanstalk job.

Return Value

Job

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