Skip to content

[Messenger] Document StopWorkerException #15581

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
Aug 4, 2021
Merged

[Messenger] Document StopWorkerException #15581

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
11 changes: 11 additions & 0 deletions messenger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,17 @@ The first argument is the receiver's name (or service id if you routed to a
custom service). By default, the command will run forever: looking for new messages
on your transport and handling them. This command is called your "worker".

.. tip::

To properly stop a worker, throw an instance of
:class:`Symfony\\Component\\Messenger\\Exception\\StopWorkerException`.

.. versionadded:: 5.4

The :class:`Symfony\\Component\\Messenger\\Exception\\StopWorkerException`
class was introduced in Symfony 5.4.


Deploying to Production
~~~~~~~~~~~~~~~~~~~~~~~

Expand Down