1. class
  2. Illuminate
  3. \
  4. Queue
  5. \
  6. Listener

Listener

class Listener

Properties

protected string $commandPath

The command working path.
protected string $environment

The environment the workers should run under.
protected int $sleep

The amount of seconds to wait before polling the queue.
protected int $maxTries

The amount of times to try a job before logging it failed.
protected string $workerCommand

The queue worker command line.
protected Closure|null $outputHandler

The output handler callback.

Methods

void
__construct(string $commandPath)

Create a new queue listener.

string
buildCommandTemplate()

Build the environment specific worker command.

string
phpBinary()

Get the PHP binary.

string
artisanBinary()

Get the Artisan binary.

void
listen(string $connection, string $queue, ListenerOptions $options)

Listen to the given queue connection.

Process
makeProcess(string $connection, string $queue, ListenerOptions $options)

Create a new Symfony process for the worker.

string
addEnvironment(string $command, ListenerOptions $options)

Add the environment option to the given command.

string
formatCommand(string $command, string $connection, string $queue, ListenerOptions $options)

Format the given command with the listener options.

void
runProcess(Process $process, int $memory)

Run the given process.

void
handleWorkerOutput(int $type, string $line)

Handle output from the worker process.

bool
memoryExceeded(int $memoryLimit)

Determine if the memory limit has been exceeded.

void
stop()

Stop listening and bail out of the script.

void
setOutputHandler(Closure $outputHandler)

Set the output handler callback.

Details

at line 60
void __construct(string $commandPath)

Create a new queue listener.

Parameters

string $commandPath

Return Value

void

at line 71
protected string buildCommandTemplate()

Build the environment specific worker command.

Return Value

string

at line 83
protected string phpBinary()

Get the PHP binary.

Return Value

string

at line 95
protected string artisanBinary()

Get the Artisan binary.

Return Value

string

at line 110
void listen(string $connection, string $queue, ListenerOptions $options)

Listen to the given queue connection.

Parameters

string $connection
string $queue
ListenerOptions $options

Return Value

void

at line 127
Process makeProcess(string $connection, string $queue, ListenerOptions $options)

Create a new Symfony process for the worker.

Parameters

string $connection
string $queue
ListenerOptions $options

Return Value

Process

at line 157
protected string addEnvironment(string $command, ListenerOptions $options)

Add the environment option to the given command.

Parameters

string $command
ListenerOptions $options

Return Value

string

at line 171
protected string formatCommand(string $command, string $connection, string $queue, ListenerOptions $options)

Format the given command with the listener options.

Parameters

string $command
string $connection
string $queue
ListenerOptions $options

Return Value

string

at line 189
void runProcess(Process $process, int $memory)

Run the given process.

Parameters

Process $process
int $memory

Return Value

void

at line 210
protected void handleWorkerOutput(int $type, string $line)

Handle output from the worker process.

Parameters

int $type
string $line

Return Value

void

at line 223
bool memoryExceeded(int $memoryLimit)

Determine if the memory limit has been exceeded.

Parameters

int $memoryLimit

Return Value

bool

at line 233
void stop()

Stop listening and bail out of the script.

Return Value

void

at line 244
void setOutputHandler(Closure $outputHandler)

Set the output handler callback.

Parameters

Closure $outputHandler

Return Value

void