summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/pubsub-channels.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/pubsub-channels.md')
-rw-r--r--iredis/data/commands/pubsub-channels.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/iredis/data/commands/pubsub-channels.md b/iredis/data/commands/pubsub-channels.md
new file mode 100644
index 0000000..8b9a06e
--- /dev/null
+++ b/iredis/data/commands/pubsub-channels.md
@@ -0,0 +1,11 @@
+Lists the currently *active channels*.
+
+An active channel is a Pub/Sub channel with one or more subscribers (excluding clients subscribed to patterns).
+
+If no `pattern` is specified, all the channels are listed, otherwise if pattern is specified only channels matching the specified glob-style pattern are listed.
+
+Cluster note: in a Redis Cluster clients can subscribe to every node, and can also publish to every other node. The cluster will make sure that published messages are forwarded as needed. That said, `PUBSUB`'s replies in a cluster only report information from the node's Pub/Sub context, rather than the entire cluster.
+
+@return
+
+@array-reply: a list of active channels, optionally matching the specified pattern.