minor #9399 Documented the dynamic lock refresh (javiereguiluz)

javiereguiluz · javiereguiluz · commit a2946250adfb · 2018-03-07T09:25:06.000+01:00
This PR was merged into the master branch. Discussion ---------- Documented the dynamic lock refresh This fixes #9379. Commits ------- 6597d4e Documented the dynamic lock refresh
diff --git a/components/lock.rst b/components/lock.rst
@@ -143,6 +143,23 @@ to reset the TTL to its original value::
         $lock->release();
     }
 
+.. tip::
+
+    Another useful technique for long-running tasks is to pass a custom TTL as
+    an argument of the ``refresh()`` method to change the default lock TTL::
+
+        $lock = $factory->createLock('charts-generation', 30);
+        // ...
+        // refresh the lock for 30 seconds
+        $lock->refresh();
+        // ...
+        // refresh the lock for 600 seconds (next refresh() call will be 30 seconds again)
+        $lock->refresh(600);
+
+    .. versionadded:: 4.1
+        The feature to pass a custom TTL as an argument of the ``refresh()``
+        method was introduced in Symfony 4.1.
+
 Available Stores
 ----------------
 
