summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/client-getredir.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/client-getredir.md')
-rw-r--r--iredis/data/commands/client-getredir.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/iredis/data/commands/client-getredir.md b/iredis/data/commands/client-getredir.md
new file mode 100644
index 0000000..ddaa1b7
--- /dev/null
+++ b/iredis/data/commands/client-getredir.md
@@ -0,0 +1,13 @@
+This command returns the client ID we are redirecting our
+[tracking](/topics/client-side-caching) notifications to. We set a client to
+redirect to when using `CLIENT TRACKING` to enable tracking. However in order to
+avoid forcing client libraries implementations to remember the ID notifications
+are redirected to, this command exists in order to improve introspection and
+allow clients to check later if redirection is active and towards which client
+ID.
+
+@return
+
+@integer-reply: the ID of the client we are redirecting the notifications to.
+The command returns `-1` if client tracking is not enabled, or `0` if client
+tracking is enabled but we are not redirecting the notifications to any client.