Skip to content

xtr_messenger.command

Console commands for a messenger process, on xtr-console.

Needs xtr-console installed beside this package. Importing this package declares messenger:consume with @as_command, like any other command module.

The :class:~xtr_messenger.bundle.MessengerBundle loads this module for its kernel when the console bundle is active, so the container builds the command from the WorkerFactory the messenger bundle provides.

Run without a container, the console cannot fill the command's WorkerFactory and reports the missing parameter rather than build it bare.

ConsumeMessagesCommand

ConsumeMessagesCommand(workers: WorkerFactory)

Consumes the transports named on the command line, until stopped.

An xtr-dependency-injection container builds it with the WorkerFactory the messenger bundle provides. Run without a container, the console cannot fill workers and reports the missing parameter rather than build it bare.

Build workers with workers, which a container supplies.

DebugCommand

DebugCommand(config: MessageBusConfig, handlers: HandlersLocator)

Lists the messages that can be dispatched, their handlers, routes and failure transports.

A container builds it with the configuration and handlers the messenger bundle holds.

Describe config's routing and the handlers handlers holds.

FailedMessagesRemoveCommand

FailedMessagesRemoveCommand(failed: FailedMessageRepository)

Bases: AbstractFailedMessagesCommand

Removes messages from a failure transport — by id, by filter, or every one.

FailedMessagesRetryCommand

FailedMessagesRetryCommand(failed: FailedMessageRepository, workers: WorkerFactory)

Bases: AbstractFailedMessagesCommand

Retries the messages kept in a failure transport, one at a time.

A retried message is handled here, by a worker of its own on the failure transport: handled, it is acknowledged and gone; failing again, the failure transport does with it what it does with any failed message.

Read failed, handling each retried message through a worker workers builds.

FailedMessagesShowCommand

FailedMessagesShowCommand(failed: FailedMessageRepository)

Bases: AbstractFailedMessagesCommand

Lists the messages kept in a failure transport, or shows one of them.

SetupTransportsCommand

SetupTransportsCommand(transports: TransportLocator)

Prepares the infrastructure each transport needs — its table, its queues.

A container builds it with the transports the messenger bundle provides.

Set up the transports transports hands over.

ShowMessagesCommand

ShowMessagesCommand(transports: TransportLocator)

Lists the messages waiting in a transport, or shows one of them.

A container builds it with the transports the messenger bundle provides.

Look into the transports transports hands over.

StatsCommand

StatsCommand(transports: TransportLocator)

Counts the messages waiting in each transport.

A container builds it with the transports the messenger bundle provides.

Count the messages of the transports transports hands over.