Skip to content

Commit 4094910

Browse files
authored
Explain 'retry' of lock stores over explicit 'no'
The documented 'no' is quite explicit with regards to whether a store does not allow userland to use the lock's blocking behavior. Using 'retry' as more subtle wording, and reiterating the rationale behind retry below the table, explains that it's the lock class itself that handles blocking support.
1 parent bddefb0 commit 4094910

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

components/lock.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -390,17 +390,20 @@ The component includes the following built-in store types:
390390
Store Scope Blocking Expiring Sharing Serialization
391391
========================================================== ====== ======== ======== ======= =============
392392
:ref:`FlockStore <lock-store-flock>` local yes no yes no
393-
:ref:`MemcachedStore <lock-store-memcached>` remote no yes no yes
394-
:ref:`MongoDbStore <lock-store-mongodb>` remote no yes no yes
395-
:ref:`PdoStore <lock-store-pdo>` remote no yes no yes
396-
:ref:`DoctrineDbalStore <lock-store-dbal>` remote no yes no yes
393+
:ref:`MemcachedStore <lock-store-memcached>` remote retry yes no yes
394+
:ref:`MongoDbStore <lock-store-mongodb>` remote retry yes no yes
395+
:ref:`PdoStore <lock-store-pdo>` remote retry yes no yes
396+
:ref:`DoctrineDbalStore <lock-store-dbal>` remote retry yes no yes
397397
:ref:`PostgreSqlStore <lock-store-pgsql>` remote yes no yes no
398398
:ref:`DoctrineDbalPostgreSqlStore <lock-store-dbal-pgsql>` remote yes no yes no
399-
:ref:`RedisStore <lock-store-redis>` remote no yes yes yes
399+
:ref:`RedisStore <lock-store-redis>` remote retry yes yes yes
400400
:ref:`SemaphoreStore <lock-store-semaphore>` local yes no no no
401-
:ref:`ZookeeperStore <lock-store-zookeeper>` remote no no no no
401+
:ref:`ZookeeperStore <lock-store-zookeeper>` remote retry no no no
402402
========================================================== ====== ======== ======== ======= =============
403403

404+
When the store does not support blocking locks, the Lock class will retry to acquire
405+
the lock in a non-blocking way until the lock is acquired.
406+
404407
.. tip::
405408

406409
Symfony includes two other special stores that are mostly useful for testing:

0 commit comments

Comments
 (0)