BeanstalkdJob (Queue\Jobs)
BeanstalkdJob
class BeanstalkdJob extends Job implements Job (View source)
Traits
InteractsWithTime |
Methods
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) 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 | failed(Exception $e) Process an exception that caused the job to fail. | from Job |
array | payload() Get the decoded body of the job. | from Job |
int|null | maxTries() The number of times to attempt a job. | from Job |
int|null | timeout() The number of seconds the job can run. | 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. | |
string | getJobId() Get the job identifier. | |
string | getRawBody() Get the raw body string for the job. | |
Pheanstalk | getPheanstalk() Get the underlying Pheanstalk instance. | |
Job | getPheanstalkJob() Get the underlying Pheanstalk job. |
Details
void fire()
Fire the job.
void delete()
Delete the job from the queue.
bool isDeleted()
Determine if the job has been deleted.
void release(int $delay)
Release the job back into the queue.
bool isReleased()
Determine if the job was released back into the queue.
bool isDeletedOrReleased()
Determine if the job has been deleted or released.
bool hasFailed()
Determine if the job has been marked as a failure.
void markAsFailed()
Mark the job as "failed".
void failed(Exception $e)
Process an exception that caused the job to fail.
array payload()
Get the decoded body of the job.
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.
Resolves the name of "wrapped" jobs such as class-based handlers.
string getConnectionName()
Get the name of the connection the job belongs to.
string getQueue()
Get the name of the queue the job belongs to.
Container getContainer()
Get the service container instance.
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.
string getJobId()
Get the job identifier.
string getRawBody()
Get the raw body string for the job.
Pheanstalk getPheanstalk()
Get the underlying Pheanstalk instance.
Job getPheanstalkJob()
Get the underlying Pheanstalk job.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Queue/Jobs/BeanstalkdJob.html