interface QueueingDispatcher implements Dispatcher (View source)

Methods

mixed
dispatch(mixed $command)

Dispatch a command to its appropriate handler.

mixed
dispatchSync(mixed $command, mixed $handler = null)

Dispatch a command to its appropriate handler in the current process.

mixed
dispatchNow(mixed $command, mixed $handler = null)

Dispatch a command to its appropriate handler in the current process.

bool
hasCommandHandler(mixed $command)

Determine if the given command has a handler.

bool|mixed
getCommandHandler(mixed $command)

Retrieve the handler for a command.

$this
pipeThrough(array $pipes)

Set the pipes commands should be piped through before dispatching.

$this
map(array $map)

Map a command to a handler.

Batch|null
findBatch(string $batchId)

Attempt to find the batch with the given ID.

batch(Collection|array $jobs)

Create a new batch of queueable jobs.

mixed
dispatchToQueue(mixed $command)

Dispatch a command to its appropriate handler behind a queue.

Details

mixed dispatch(mixed $command)

Dispatch a command to its appropriate handler.

Parameters

mixed $command

Return Value

mixed

mixed dispatchSync(mixed $command, mixed $handler = null)

Dispatch a command to its appropriate handler in the current process.

Queueable jobs will be dispatched to the "sync" queue.

Parameters

mixed $command
mixed $handler

Return Value

mixed

mixed dispatchNow(mixed $command, mixed $handler = null)

Dispatch a command to its appropriate handler in the current process.

Parameters

mixed $command
mixed $handler

Return Value

mixed

bool hasCommandHandler(mixed $command)

Determine if the given command has a handler.

Parameters

mixed $command

Return Value

bool

bool|mixed getCommandHandler(mixed $command)

Retrieve the handler for a command.

Parameters

mixed $command

Return Value

bool|mixed

$this pipeThrough(array $pipes)

Set the pipes commands should be piped through before dispatching.

Parameters

array $pipes

Return Value

$this

$this map(array $map)

Map a command to a handler.

Parameters

array $map

Return Value

$this

Batch|null findBatch(string $batchId)

Attempt to find the batch with the given ID.

Parameters

string $batchId

Return Value

Batch|null

PendingBatch batch(Collection|array $jobs)

Create a new batch of queueable jobs.

Parameters

Collection|array $jobs

Return Value

PendingBatch

mixed dispatchToQueue(mixed $command)

Dispatch a command to its appropriate handler behind a queue.

Parameters

mixed $command

Return Value

mixed

Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.