summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/brpoplpush.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/brpoplpush.md')
-rw-r--r--iredis/data/commands/brpoplpush.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/iredis/data/commands/brpoplpush.md b/iredis/data/commands/brpoplpush.md
new file mode 100644
index 0000000..1c3a9b3
--- /dev/null
+++ b/iredis/data/commands/brpoplpush.md
@@ -0,0 +1,21 @@
+`BRPOPLPUSH` is the blocking variant of `RPOPLPUSH`. When `source` contains
+elements, this command behaves exactly like `RPOPLPUSH`. When used inside a
+`MULTI`/`EXEC` block, this command behaves exactly like `RPOPLPUSH`. When
+`source` is empty, Redis will block the connection until another client pushes
+to it or until `timeout` is reached. A `timeout` of zero can be used to block
+indefinitely.
+
+See `RPOPLPUSH` for more information.
+
+@return
+
+@bulk-string-reply: the element being popped from `source` and pushed to
+`destination`. If `timeout` is reached, a @nil-reply is returned.
+
+## Pattern: Reliable queue
+
+Please see the pattern description in the `RPOPLPUSH` documentation.
+
+## Pattern: Circular list
+
+Please see the pattern description in the `RPOPLPUSH` documentation.