From 8ce8f9ba8491d4afd91f8fa0da0cd1196fe826c6 Mon Sep 17 00:00:00 2001 From: Oskar Stark Date: Mon, 27 Jan 2025 08:16:36 +0100 Subject: [PATCH] [Messenger] Describe `--keepalive` option (AmazonSQS & Beanstalkd) --- messenger.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/messenger.rst b/messenger.rst index 0965cbc9170..217061d302c 100644 --- a/messenger.rst +++ b/messenger.rst @@ -543,6 +543,19 @@ command with the ``--all`` option: The ``--all`` option was introduced in Symfony 7.1. +The ``--keepalive`` option can be used to prevent messages from being prematurely +redelivered during long-running processing. It marks the message as "in progress" +and prevents it from being redelivered until the worker finishes processing it. + +.. note:: + + This option is only available for supported transports, which are + the Beanstalkd and AmazonSQS transports. + +.. versionadded:: 7.2 + + The ``--keepalive`` option was introduced in Symfony 7.2. + .. tip:: In a development environment and if you're using the Symfony CLI tool, @@ -1709,6 +1722,10 @@ The transport has a number of options: The message time to run before it is put back in the ready queue - in seconds. +.. versionadded:: 7.2 + + Keepalive support, using the ``--keepalive`` option, was added in Symfony 7.2. + .. _messenger-redis-transport: Redis Transport @@ -2031,6 +2048,10 @@ The transport has a number of options: FIFO queues don't support setting a delay per message, a value of ``delay: 0`` is required in the retry strategy settings. +.. versionadded:: 7.2 + + Keepalive support, using the `--keepalive` option, was added in Symfony 7.2. + Serializing Messages ~~~~~~~~~~~~~~~~~~~~