Skip to content

[Messenger] Documented the delete_after_reject option #14270

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.

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 24, 2020
Merged
Changes from all commits
Commits
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
44 changes: 25 additions & 19 deletions messenger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1149,25 +1149,27 @@ a running Redis server (^5.0).
A number of options can be configured via the DSN or via the ``options`` key
under the transport in ``messenger.yaml``:

================== ===================================== =========================
Option Description Default
================== ===================================== =========================
stream The Redis stream name messages
group The Redis consumer group name symfony
consumer Consumer name used in Redis consumer
auto_setup Create the Redis group automatically? true
auth The Redis password
delete_after_ack If ``true``, messages are deleted false
automatically after processing them
serializer How to serialize the final payload ``Redis::SERIALIZER_PHP``
in Redis (the
``Redis::OPT_SERIALIZER`` option)
stream_max_entries The maximum number of entries which ``0`` (which means "no trimming")
the stream will be trimmed to. Set
it to a large enough number to
avoid losing pending messages
tls Enable TLS support for the connection false
================== ===================================== =========================
=================== ===================================== =========================
Option Description Default
=================== ===================================== =========================
stream The Redis stream name messages
group The Redis consumer group name symfony
consumer Consumer name used in Redis consumer
auto_setup Create the Redis group automatically? true
auth The Redis password
delete_after_ack If ``true``, messages are deleted false
automatically after processing them
delete_after_reject If ``true``, messages are deleted true
automatically if they are rejected
serializer How to serialize the final payload ``Redis::SERIALIZER_PHP``
in Redis (the
``Redis::OPT_SERIALIZER`` option)
stream_max_entries The maximum number of entries which ``0`` (which means "no trimming")
the stream will be trimmed to. Set
it to a large enough number to
avoid losing pending messages
tls Enable TLS support for the connection false
=================== ===================================== =========================

.. tip::

Expand All @@ -1180,6 +1182,10 @@ tls Enable TLS support for the connection false

The ``delete_after_ack`` option was introduced in Symfony 5.1.

.. versionadded:: 5.2

The ``delete_after_reject`` option was introduced in Symfony 5.2.

In Memory Transport
~~~~~~~~~~~~~~~~~~~

Expand Down