summaryrefslogtreecommitdiff
path: root/redis/cluster.py
diff options
context:
space:
mode:
Diffstat (limited to 'redis/cluster.py')
-rw-r--r--redis/cluster.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/redis/cluster.py b/redis/cluster.py
index a88792b..8e4c654 100644
--- a/redis/cluster.py
+++ b/redis/cluster.py
@@ -766,6 +766,7 @@ class RedisCluster(AbstractRedisCluster, RedisClusterCommands):
name,
timeout=None,
sleep=0.1,
+ blocking=True,
blocking_timeout=None,
lock_class=None,
thread_local=True,
@@ -781,6 +782,12 @@ class RedisCluster(AbstractRedisCluster, RedisClusterCommands):
when the lock is in blocking mode and another client is currently
holding the lock.
+ ``blocking`` indicates whether calling ``acquire`` should block until
+ the lock has been acquired or to fail immediately, causing ``acquire``
+ to return False and the lock not being acquired. Defaults to True.
+ Note this value can be overridden by passing a ``blocking``
+ argument to ``acquire``.
+
``blocking_timeout`` indicates the maximum amount of time in seconds to
spend trying to acquire the lock. A value of ``None`` indicates
continue trying forever. ``blocking_timeout`` can be specified as a
@@ -823,6 +830,7 @@ class RedisCluster(AbstractRedisCluster, RedisClusterCommands):
name,
timeout=timeout,
sleep=sleep,
+ blocking=blocking,
blocking_timeout=blocking_timeout,
thread_local=thread_local,
)