class BeanstalkdJob extends Job implements Job (View source)
InteractsWithTime |
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. |
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. | |
string|null | uuid() Get the UUID of the job. | from 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 | maxExceptions() Get the number of times to attempt a job after an exception. | from Job |
int|null | backoff() The number of seconds to wait before retrying a job that encountered an uncaught exception. | from Job |
int|null | timeout() Get the number of seconds the job can run. | from Job |
int|null | retryUntil() 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. |
Get the number of seconds until the given DateTime.
Get the "available at" UNIX timestamp.
If the given value is an interval, convert it to a DateTime instance.
Get the current system time as a UNIX timestamp.
Get the job identifier.
Get the raw body string for the job.
Get the UUID of the job.
Fire the job.
Delete the job from the queue.
Determine if the job has been deleted.
Release the job back into the queue.
Determine if the job was released back into the queue.
Determine if the job has been deleted or released.
Determine if the job has been marked as a failure.
Mark the job as "failed".
Delete the job, call the "failed" method, and raise the failed job event.
Process an exception that caused the job to fail.
Resolve the given class.
Get the resolved job handler instance.
Get the decoded body of the job.
Get the number of times to attempt a job.
Get the number of times to attempt a job after an exception.
The number of seconds to wait before retrying a job that encountered an uncaught exception.
Get the number of seconds the job can run.
Get the timestamp indicating when the job should timeout.
Get the name of the queued job class.
Get the resolved name of the queued job class.
Resolves the name of "wrapped" jobs such as class-based handlers.
Get the name of the connection the job belongs to.
Get the name of the queue the job belongs to.
Get the service container instance.
Create a new job instance.
Bury the job in the queue.
Get the number of times the job has been attempted.
Get the underlying Pheanstalk instance.
Get the underlying Pheanstalk job.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Queue/Jobs/BeanstalkdJob.html