Skip to content

Commit 8a9cf7a

Browse files
committed
[Messneger] documented the delete_after_ack option
1 parent 29cdebb commit 8a9cf7a

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

messenger.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1046,6 +1046,8 @@ group The Redis consumer group name symfony
10461046
consumer Consumer name used in Redis consumer
10471047
auto_setup Create the Redis group automatically? true
10481048
auth The Redis password
1049+
delete_after_ack If ``true``, messages are deleted false
1050+
automatically after processing them
10491051
serializer How to serialize the final payload ``Redis::SERIALIZER_PHP``
10501052
in Redis (the
10511053
``Redis::OPT_SERIALIZER`` option)
@@ -1056,6 +1058,17 @@ stream_max_entries The maximum number of entries which ``0`` (which means "n
10561058
tls Enable TLS support for the connection false
10571059
================== ===================================== =========================
10581060

1061+
.. tip::
1062+
1063+
Set ``delete_after_ack`` to ``true`` (if you use a single group) or define
1064+
``stream_max_entries`` (if you can estimate how many max entries is acceptable
1065+
in your case) to avoid memory leaks. Otherwise, all messages will remain
1066+
forever in Redis.
1067+
1068+
.. versionadded:: 5.1
1069+
1070+
The ``delete_after_ack`` option was introduced in Symfony 5.1.
1071+
10591072
In Memory Transport
10601073
~~~~~~~~~~~~~~~~~~~
10611074

0 commit comments

Comments
 (0)