W3cubDocs

/Laravel 8

ListenerOptions

class ListenerOptions extends WorkerOptions (View source)

Properties

int $name The name of the worker. from WorkerOptions
int $backoff The number of seconds to wait before retrying a job that encountered an uncaught exception. from WorkerOptions
int $memory The maximum amount of RAM the worker may consume. from WorkerOptions
int $timeout The maximum number of seconds a child worker may run. from WorkerOptions
int $sleep The number of seconds to wait in between polling the queue. from WorkerOptions
int $maxTries The maximum amount of times a job may be attempted. from WorkerOptions
bool $force Indicates if the worker should run in maintenance mode. from WorkerOptions
bool $stopWhenEmpty Indicates if the worker should stop when queue is empty. from WorkerOptions
int $maxJobs The maximum number of jobs to run. from WorkerOptions
int $maxTime The maximum number of seconds a worker may live. from WorkerOptions
string $environment The environment the worker should run in.

Methods

void __construct(string $name = 'default', string|null $environment = null, int $backoff = 0, int $memory = 128, int $timeout = 60, int $sleep = 3, int $maxTries = 1, bool $force = false)

Create a new listener options instance.

Details

void __construct(string $name = 'default', string|null $environment = null, int $backoff = 0, int $memory = 128, int $timeout = 60, int $sleep = 3, int $maxTries = 1, bool $force = false)

Create a new listener options instance.

Parameters

string $name
string|null $environment
int $backoff
int $memory
int $timeout
int $sleep
int $maxTries
bool $force

Return Value

void

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