class Illuminate / Queue / WorkerOptions
You're browsing the documentation for an upcoming version of Laravel. The documentation and features of this release are subject to change.

WorkerOptions

Properties

public

$name string

The name of the worker.

Default: null
public

$backoff int|int[]

The number of seconds to wait before retrying a job that encountered an uncaught exception.

Default: null
public

$memory int

The maximum amount of RAM the worker may consume.

Default: null
public

$timeout int

The maximum number of seconds a child worker may run.

Default: null
public

$sleep int

The number of seconds to wait in between polling the queue.

Default: null
public

$rest int

The number of seconds to rest between jobs.

Default: null
public

$maxTries int

The maximum number of times a job may be attempted.

Default: null
public

$force bool

Indicates if the worker should run in maintenance mode.

Default: null
public

$stopWhenEmpty bool

Indicates if the worker should stop when the queue is empty.

Default: null
public

$maxJobs int

The maximum number of jobs to run.

Default: null
public

$maxTime int

The maximum number of seconds a worker may live.

Default: null

Methods

public

__construct ( $name , $backoff , $memory , $timeout , $sleep , $maxTries , $force , $stopWhenEmpty , $maxJobs , $maxTime , $rest ) : void

Create a new worker options instance.

Parameters

  • $name string
  • $backoff int|int[]
  • $memory int
  • $timeout int
  • $sleep int
  • $maxTries int
  • $force bool
  • $stopWhenEmpty bool
  • $maxJobs int
  • $maxTime int
  • $rest int