Skip to content

[Messenger] Update the list of stamp #14374

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
Oct 9, 2020
Merged

[Messenger] Update the list of stamp #14374

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
21 changes: 13 additions & 8 deletions components/messenger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,21 +148,26 @@ through the transport layer, use the ``SerializerStamp`` stamp::
]))
);

At the moment, the Symfony Messenger has the following built-in envelope stamps:
Here are some important envelope stamps that are shipped with the Symfony Messenger:

#. :class:`Symfony\\Component\\Messenger\\Stamp\\SerializerStamp`,
to configure the serialization groups used by the transport.
#. :class:`Symfony\\Component\\Messenger\\Stamp\\ValidationStamp`,
to configure the validation groups used when the validation middleware is enabled.
#. :class:`Symfony\\Component\\Messenger\\Stamp\\DelayStamp`,
to delay handling of an asynchronous message.
#. :class:`Symfony\\Component\\Messenger\\Stamp\\DispatchAfterCurrentBusStamp`,
to make the message be handled after the current bus has executed. Read more
at :doc:`/messenger/dispatch_after_current_bus`.
#. :class:`Symfony\\Component\\Messenger\\Stamp\\HandledStamp`,
a stamp that marks the message as handled by a specific handler.
Allows accessing the handler returned value and the handler name.
#. :class:`Symfony\\Component\\Messenger\\Stamp\\ReceivedStamp`,
an internal stamp that marks the message as received from a transport.
#. :class:`Symfony\\Component\\Messenger\\Stamp\\SentStamp`,
a stamp that marks the message as sent by a specific sender.
Allows accessing the sender FQCN and the alias if available from the
:class:`Symfony\\Component\\Messenger\\Transport\\Sender\\SendersLocator`.
#. :class:`Symfony\\Component\\Messenger\\Stamp\\HandledStamp`,
a stamp that marks the message as handled by a specific handler.
Allows accessing the handler returned value and the handler name.
#. :class:`Symfony\\Component\\Messenger\\Stamp\\SerializerStamp`,
to configure the serialization groups used by the transport.
#. :class:`Symfony\\Component\\Messenger\\Stamp\\ValidationStamp`,
to configure the validation groups used when the validation middleware is enabled.

Instead of dealing directly with the messages in the middleware you receive the envelope.
Hence you can inspect the envelope content and its stamps, or add any::
Expand Down