BeanstalkdJob

class BeanstalkdJob extends Job implements Job (View source)

Traits

InteractsWithTime

Properties

protected mixed $instance The job handler instance. from Job
protected Container $container The IoC container instance. 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 bool $failed Indicates if the job has failed. from Job
protected string $connectionName The name of the connection the job belongs to. from Job
protected string $queue The name of the queue the job belongs to. from Job
protected Pheanstalk $pheanstalk The Pheanstalk instance.
protected Job $job The Pheanstalk job instance.

Methods

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

 from InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

 from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

 from InteractsWithTime
int currentTime()

Get the current system time as a UNIX timestamp.

 from InteractsWithTime
string getJobId()

Get the job identifier.
string getRawBody()

Get the raw body string for the job.
void fire()

Fire the job.

 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 = 0)

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
bool hasFailed()

Determine if the job has been marked as a failure.

 from Job
void markAsFailed()

Mark the job as "failed".

 from Job
void fail(Throwable|null $e = null)

Delete the job, call the "failed" method, and raise the failed job event.

 from Job
void failed(Throwable|null $e)

Process an exception that caused the job to fail.

 from Job
mixed resolve(string $class)

Resolve the given class.

 from Job
mixed getResolvedJob()

Get the resolved job handler instance.

 from Job
array payload()

Get the decoded body of the job.

 from Job
int|null maxTries()

Get the number of times to attempt a job.

 from Job
int|null delaySeconds()

Get the number of seconds to delay a failed job before retrying it.

 from Job
int|null timeout()

Get the number of seconds the job can run.

 from Job
int|null timeoutAt()

Get the timestamp indicating when the job should timeout.

 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
string getConnectionName()

Get the name of the connection the job belongs to.

 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
void __construct(Container $container, Pheanstalk $pheanstalk, Job $job, string $connectionName, string $queue)

Create a new job instance.
void bury()

Bury the job in the queue.
int attempts()

Get the number of times the job has been attempted.
Pheanstalk getPheanstalk()

Get the underlying Pheanstalk instance.
Job getPheanstalkJob()

Get the underlying Pheanstalk job.

Details

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

string getJobId()

Get the job identifier.

Return Value

string

string getRawBody()

Get the raw body string for the job.

Return Value

string

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 = 0)

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

bool hasFailed()

Determine if the job has been marked as a failure.

Return Value

bool

void markAsFailed()

Mark the job as "failed".

Return Value

void

void fail(Throwable|null $e = null)

Delete the job, call the "failed" method, and raise the failed job event.

Parameters

Throwable|null $e

Return Value

void

protected void failed(Throwable|null $e)

Process an exception that caused the job to fail.

Parameters

Throwable|null $e

Return Value

void

protected mixed resolve(string $class)

Resolve the given class.

Parameters

string $class

Return Value

mixed

mixed getResolvedJob()

Get the resolved job handler instance.

Return Value

mixed

array payload()

Get the decoded body of the job.

Return Value

array

int|null maxTries()

Get the number of times to attempt a job.

Return Value

int|null

int|null delaySeconds()

Get the number of seconds to delay a failed job before retrying it.

Return Value

int|null

int|null timeout()

Get the number of seconds the job can run.

Return Value

int|null

int|null timeoutAt()

Get the timestamp indicating when the job should timeout.

Return Value

int|null

string getName()

Get the name of the queued job class.

Return Value

string

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

string getConnectionName()

Get the name of the connection the job belongs to.

Return Value

string

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

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

Create a new job instance.

Parameters

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

Return Value

void

void bury()

Bury the job in the queue.

Return Value

void

int attempts()

Get the number of times the job has been attempted.

Return Value

int

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/6.x/Illuminate/Queue/Jobs/BeanstalkdJob.html