W3cubDocs

/Laravel 4.2

Worker

class Worker (View source)

Methods

void __construct(QueueManager $manager, FailedJobProviderInterface $failer = null, Dispatcher $events = null)

Create a new queue worker.

array daemon(string $connectionName, string $queue = null, int $delay, int $memory = 128, int $sleep = 3, int $maxTries)

Listen to the given queue in a loop.

array pop(string $connectionName, string $queue = null, int $delay, int $sleep = 3, int $maxTries)

Listen to the given queue.

void process(string $connection, Job $job, int $maxTries, int $delay)

Process a given job from the queue.

bool memoryExceeded(int $memoryLimit)

Determine if the memory limit has been exceeded.

void stop()

Stop listening and bail out of the script.

void sleep(int $seconds)

Sleep the script for a given number of seconds.

void setDaemonExceptionHandler(Handler $handler)

Set the exception handler to use in Daemon mode.

void setCache(Repository $cache)

Set the cache repository implementation.

QueueManager getManager()

Get the queue manager instance.

void setManager(QueueManager $manager)

Set the queue manager instance.

Details

void __construct(QueueManager $manager, FailedJobProviderInterface $failer = null, Dispatcher $events = null)

Create a new queue worker.

Parameters

QueueManager $manager
FailedJobProviderInterface $failer
Dispatcher $events

Return Value

void

array daemon(string $connectionName, string $queue = null, int $delay, int $memory = 128, int $sleep = 3, int $maxTries)

Listen to the given queue in a loop.

Parameters

string $connectionName
string $queue
int $delay
int $memory
int $sleep
int $maxTries

Return Value

array

array pop(string $connectionName, string $queue = null, int $delay, int $sleep = 3, int $maxTries)

Listen to the given queue.

Parameters

string $connectionName
string $queue
int $delay
int $sleep
int $maxTries

Return Value

array

void process(string $connection, Job $job, int $maxTries, int $delay)

Process a given job from the queue.

Parameters

string $connection
Job $job
int $maxTries
int $delay

Return Value

void

Exceptions

Exception

bool memoryExceeded(int $memoryLimit)

Determine if the memory limit has been exceeded.

Parameters

int $memoryLimit

Return Value

bool

void stop()

Stop listening and bail out of the script.

Return Value

void

void sleep(int $seconds)

Sleep the script for a given number of seconds.

Parameters

int $seconds

Return Value

void

void setDaemonExceptionHandler(Handler $handler)

Set the exception handler to use in Daemon mode.

Parameters

Handler $handler

Return Value

void

void setCache(Repository $cache)

Set the cache repository implementation.

Parameters

Repository $cache

Return Value

void

QueueManager getManager()

Get the queue manager instance.

Return Value

QueueManager

void setManager(QueueManager $manager)

Set the queue manager instance.

Parameters

QueueManager $manager

Return Value

void

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