Back to Redis

CLIENT GETREDIR

content/commands/client-getredir.md

latest1.9 KB
Original Source

This command returns the client ID we are redirecting our [tracking]({{< relref "/develop/clients/client-side-caching#tracking" >}}) notifications to. We set a client to redirect to when using [CLIENT TRACKING]({{< relref "/commands/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.

Redis Software and Redis Cloud compatibility

| Redis Software | Redis Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> | |:----------------------|:-----------------|:------| | <span title="Not supported">❌ Standard</span> <span title="Not supported"><nobr>❌ Active-Active</nobr></span> | <span title="Not supported">❌ Standard</span> <span title="Not supported"><nobr>❌ Active-Active</nobr></span> | |

Return information

{{< multitabs id="client-getredir-return-info" tab1="RESP2" tab2="RESP3" >}}

One of the following:

  • Integer reply: 0 when not redirecting notifications to any client.
  • Integer reply: -1 if client tracking is not enabled.
  • Integer reply: the ID of the client to which notification are being redirected.

-tab-sep-

One of the following:

  • Integer reply: 0 when not redirecting notifications to any client.
  • Integer reply: -1 if client tracking is not enabled.
  • Integer reply: the ID of the client to which notification are being redirected.

{{< /multitabs >}}