Skip to content

[Messenger] Mention RedispatchMessage and RedispatchMessageHandler #18852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 11, 2023
Merged

[Messenger] Mention RedispatchMessage and RedispatchMessageHandler #18852

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions messenger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2605,6 +2605,54 @@ Messenger gives you a single message bus service by default. But, you can config
as many as you want, creating "command", "query" or "event" buses and controlling
their middleware. See :doc:`/messenger/multiple_buses`.

Redispatching a Message
-----------------------

It may occur that you dispatch a message and for some reason, wants to
redispatch it through the same transport with the same envelope. To do so, you
can create a new
:class:`Symfony\\Component\\Messenger\\Message\\RedispatchMessage` and dispatch
it through your bus. Let's do this with the ``SmsNotification`` seen earlier::

// src/MessageHandler/SmsNotificationHandler.php
namespace App\MessageHandler;

use App\Message\SmsNotification;
use Symfony\Component\Messenger\Attribute\AsMessageHandler;
use Symfony\Component\Messenger\MessageBusInterface;
use Symfony\Component\Messenger\Message\RedispatchMessage;

#[AsMessageHandler]
class SmsNotificationHandler
{
public function __construct(private MessageBusInterface $bus)
{
}

public function __invoke(SmsNotification $message): void
{
// do something with the message
// then redispatch it based on your own logic

if ($needsRedispatch) {
$this->bus->dispatch(new RedispatchMessage($message));
}
}
}

The built-in
:class:`Symfony\\Component\\Messenger\\Handler\\RedispatchMessageHandler` will
take care of this message and redispatch it through the same bus it's been
dispatched at first. You can also use the second argument of the
``RedispatchMessage`` constructor to provide transports to use when
redispatching the message.

.. versionadded:: 6.3

The :class:`Symfony\\Component\\Messenger\\Message\\RedispatchMessage`
and :class:`Symfony\\Component\\Messenger\\Handler\\RedispatchMessageHandler`
classes were introduced in Symfony 6.3.

Learn more
----------

Expand Down