• Home
• Illuminate
• Queue
• Worker

PHP Class Illuminate\Queue\Worker

Datei anzeigen Open project: illuminate/queue Class Usage Examples

Protected Properties

Property	Type	Description
$cache	Illuminate\Contracts\Cache\Repository	The cache repository implementation.
$events	Illuminate\Contracts\Events\Dispatcher	The event dispatcher instance.
$exceptions	Illuminate\Foundation\Exceptions\Handler	The exception handler instance.
$manager	Illuminate\Queue\QueueManager	The queue manager instance.

Public Methods

Method	Description
__construct ( Illuminate\Queue\QueueManager $manager, Illuminate\Contracts\Events\Dispatcher $events, Illuminate\Contracts\Debug\ExceptionHandler $exceptions ) : void	Create a new queue worker.
daemon ( string $connectionName, string $queue, WorkerOptions $options ) : void	Listen to the given queue in a loop.
getManager ( ) : Illuminate\Queue\QueueManager	Get the queue manager instance.
memoryExceeded ( integer $memoryLimit ) : boolean	Determine if the memory limit has been exceeded.
process ( string $connectionName, Illuminate\Contracts\Queue\Job $job, WorkerOptions $options ) : void	Process a given job from the queue.
runNextJob ( string $connectionName, string $queue, WorkerOptions $options ) : void	Process the next job on the queue.
setCache ( Illuminate\Contracts\Cache\Repository $cache ) : void	Set the cache repository implementation.
setManager ( Illuminate\Queue\QueueManager $manager ) : void	Set the queue manager instance.
sleep ( integer $seconds ) : void	Sleep the script for a given number of seconds.
stop ( ) : void	Stop listening and bail out of the script.

Protected Methods

Method	Description
daemonShouldRun ( WorkerOptions $options ) : boolean	Determine if the daemon should process on this iteration.
failJob ( string $connectionName, Illuminate\Contracts\Queue\Job $job, Exception $e ) : void	Mark the given job as failed and raise the relevant event.
getNextJob ( Illuminate\Contracts\Queue\Queue $connection, string $queue ) : Illuminate\Contracts\Queue\Job | null	Get the next job from the queue connection.
getTimestampOfLastQueueRestart ( ) : integer | null	Get the last queue restart timestamp, or null.
handleJobException ( string $connectionName, Illuminate\Contracts\Queue\Job $job, WorkerOptions $options, Exception $e ) : void	Handle an exception that occurred while the job was running.
markJobAsFailedIfAlreadyExceedsMaxAttempts ( string $connectionName, Illuminate\Contracts\Queue\Job $job, integer $maxTries ) : void	Mark the given job as failed if it has exceeded the maximum allowed attempts.
markJobAsFailedIfHasExceededMaxAttempts ( string $connectionName, Illuminate\Contracts\Queue\Job $job, integer $maxTries, Exception $e ) : void	Mark the given job as failed if it has exceeded the maximum allowed attempts.
queueShouldRestart ( integer | null $lastRestart ) : boolean	Determine if the queue worker should restart.
raiseAfterJobEvent ( string $connectionName, Illuminate\Contracts\Queue\Job $job ) : void	Raise the after queue job event.
raiseBeforeJobEvent ( string $connectionName, Illuminate\Contracts\Queue\Job $job ) : void	Raise the before queue job event.
raiseExceptionOccurredJobEvent ( string $connectionName, Illuminate\Contracts\Queue\Job $job, Exception $e ) : void	Raise the exception occurred queue job event.
raiseFailedJobEvent ( string $connectionName, Illuminate\Contracts\Queue\Job $job, Exception $e ) : void	Raise the failed queue job event.
registerTimeoutHandler ( Illuminate\Contracts\Queue\Job | null $job, WorkerOptions $options ) : void	Register the worker timeout handler (PHP 7.1+).
runJob ( Illuminate\Contracts\Queue\Job $job, string $connectionName, WorkerOptions $options ) : void	Process the given job.

Method Details

Property Details