QueueManager
class QueueManager implements Factory, Monitor mixin Queue (View source)
Properties
| protected Application | $app | The application instance. |
|
| protected array | $connections | The array of resolved queue connections. |
|
| protected array | $connectors | The array of resolved queue connectors. |
Methods
Register an event listener for the before job event.
Register an event listener for the after job event.
Register an event listener for the exception occurred job event.
Register an event listener for the daemon queue loop.
Register an event listener for the failed job event.
Register an event listener for the daemon queue starting.
Register an event listener for the daemon queue stopping.
Determine if the driver is connected.
Resolve a queue connection instance.
Get the connector for a given driver.
Pause a queue by its connection and name.
Pause a queue by its connection and name for a given amount of time.
Resume a paused queue by its connection and name.
Determine if a queue is paused.
Indicate that queue workers should not poll for restart or pause signals.
Get the queue connection configuration.
Get the name of the default queue connection.
Set the name of the default queue connection.
Get the full name for the given connection.
Get the application instance used by the manager.
Dynamically pass calls to the default connection.
Details
__construct(Application $app)
Create a new queue manager instance.
void
before(mixed $callback)
Register an event listener for the before job event.
void
after(mixed $callback)
Register an event listener for the after job event.
void
exceptionOccurred(mixed $callback)
Register an event listener for the exception occurred job event.
void
looping(mixed $callback)
Register an event listener for the daemon queue loop.
void
failing(mixed $callback)
Register an event listener for the failed job event.
void
starting(mixed $callback)
Register an event listener for the daemon queue starting.
void
stopping(mixed $callback)
Register an event listener for the daemon queue stopping.
bool
connected(string|null $name = null)
Determine if the driver is connected.
Queue
connection(string|null $name = null)
Resolve a queue connection instance.
protected Queue
resolve(string $name)
Resolve a queue connection.
protected ConnectorInterface
getConnector(string $driver)
Get the connector for a given driver.
void
pause(string $connection, string $queue)
Pause a queue by its connection and name.
void
pauseFor(string $connection, string $queue, DateTimeInterface|DateInterval|int $ttl)
Pause a queue by its connection and name for a given amount of time.
void
resume(string $connection, string $queue)
Resume a paused queue by its connection and name.
bool
isPaused(string $connection, string $queue)
Determine if a queue is paused.
void
withoutInterruptionPolling()
Indicate that queue workers should not poll for restart or pause signals.
This prevents the workers from hitting the application cache to determine if they need to pause or restart.
void
extend(string $driver, Closure $resolver)
Add a queue connection resolver.
void
addConnector(string $driver, Closure $resolver)
Add a queue connection resolver.
protected array|null
getConfig(string $name)
Get the queue connection configuration.
string
getDefaultDriver()
Get the name of the default queue connection.
void
setDefaultDriver(string $name)
Set the name of the default queue connection.
string
getName(string|null $connection = null)
Get the full name for the given connection.
Application
getApplication()
Get the application instance used by the manager.
$this
setApplication(Application $app)
Set the application instance used by the manager.
mixed
__call(string $method, array $parameters)
Dynamically pass calls to the default connection.