Listener
class Listener (View source)
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
void __construct(string $commandPath)
Create a new queue listener.
protected string buildCommandTemplate()
Build the environment specific worker command.
protected string phpBinary()
Get the PHP binary.
protected 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.
protected string addEnvironment(string $command, ListenerOptions $options)
Add the environment option to the given command.
protected 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.
protected 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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.7/Illuminate/Queue/Listener.html