From 303419c615c39757d07b849aadde377bcff28f2c Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Tue, 22 Sep 2020 16:36:54 +0200 Subject: [PATCH] [Messenger] Documented the delete_after_reject option --- messenger.rst | 44 +++++++++++++++++++++++++------------------- 1 file changed, 25 insertions(+), 19 deletions(-) diff --git a/messenger.rst b/messenger.rst index 90d8c1c80a6..14cce1c4931 100644 --- a/messenger.rst +++ b/messenger.rst @@ -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:: @@ -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 ~~~~~~~~~~~~~~~~~~~