-
Notifications
You must be signed in to change notification settings - Fork 961
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for CLIENT TRACKINGINFO (#2862)
* Initial commit * Added the CLIENT TRACKINGINFO command * Implement the final version of the command, add parser utility * Add some more unit tests. Polishing. * Implemented dynamic parsing of the result returned from CLIENT TRACKINGINFO * Fixed conflixt issues * Addressed Ali's comment on calling the .getDynamicMap only once * Circle back to using domain objects * Missed several crucial files * Remove part of the license that is not needed
- Loading branch information
Showing
23 changed files
with
964 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,165 @@ | ||
/* | ||
* Copyright 2024, Redis Ltd. and Contributors | ||
* All rights reserved. | ||
* | ||
* Licensed under the MIT License. | ||
*/ | ||
|
||
package io.lettuce.core; | ||
|
||
import java.util.ArrayList; | ||
import java.util.Collections; | ||
import java.util.HashSet; | ||
import java.util.Objects; | ||
import java.util.Set; | ||
import java.util.List; | ||
|
||
/** | ||
* Contains the output of a <a href="https://redis.io/docs/latest/commands/client-trackinginfo/">CLIENT TRACKINGINFO</a> | ||
* command. | ||
* | ||
* @author Tihomir Mateev | ||
* @since 6.5 | ||
*/ | ||
public class TrackingInfo { | ||
|
||
private final Set<TrackingFlag> flags = new HashSet<>(); | ||
|
||
private final long redirect; | ||
|
||
private final List<String> prefixes = new ArrayList<>(); | ||
|
||
/** | ||
* Constructor | ||
* | ||
* @param flags a {@link Set} of {@link TrackingFlag}s that the command returned | ||
* @param redirect the client ID used for notification redirection, -1 when none | ||
* @param prefixes a {@link List} of key prefixes for which notifications are sent to the client | ||
* | ||
* @see TrackingFlag | ||
*/ | ||
public TrackingInfo(Set<TrackingFlag> flags, long redirect, List<String> prefixes) { | ||
this.flags.addAll(flags); | ||
this.redirect = redirect; | ||
this.prefixes.addAll(prefixes); | ||
} | ||
|
||
/** | ||
* @return set of all the {@link TrackingFlag}s currently enabled on the client connection | ||
*/ | ||
public Set<TrackingFlag> getFlags() { | ||
return Collections.unmodifiableSet(flags); | ||
} | ||
|
||
/** | ||
* @return the client ID used for notification redirection, -1 when none | ||
*/ | ||
public long getRedirect() { | ||
return redirect; | ||
} | ||
|
||
/** | ||
* @return a {@link List} of key prefixes for which notifications are sent to the client | ||
*/ | ||
public List<String> getPrefixes() { | ||
return Collections.unmodifiableList(prefixes); | ||
} | ||
|
||
@Override | ||
public String toString() { | ||
return "TrackingInfo{" + "flags=" + flags + ", redirect=" + redirect + ", prefixes=" + prefixes + '}'; | ||
} | ||
|
||
@Override | ||
public boolean equals(Object o) { | ||
if (this == o) | ||
return true; | ||
if (o == null || getClass() != o.getClass()) | ||
return false; | ||
TrackingInfo that = (TrackingInfo) o; | ||
return redirect == that.redirect && Objects.equals(flags, that.flags) && Objects.equals(prefixes, that.prefixes); | ||
} | ||
|
||
@Override | ||
public int hashCode() { | ||
return Objects.hash(flags, redirect, prefixes); | ||
} | ||
|
||
/** | ||
* CLIENT TRACKINGINFO flags | ||
* | ||
* @see <a href="https://redis.io/docs/latest/commands/client-trackinginfo/">CLIENT TRACKINGINFO</a> | ||
*/ | ||
public enum TrackingFlag { | ||
|
||
/** | ||
* The connection isn't using server assisted client side caching. | ||
*/ | ||
OFF, | ||
/** | ||
* Server assisted client side caching is enabled for the connection. | ||
*/ | ||
ON, | ||
/** | ||
* The client uses broadcasting mode. | ||
*/ | ||
BCAST, | ||
/** | ||
* The client does not cache keys by default. | ||
*/ | ||
OPTIN, | ||
/** | ||
* The client caches keys by default. | ||
*/ | ||
OPTOUT, | ||
/** | ||
* The next command will cache keys (exists only together with optin). | ||
*/ | ||
CACHING_YES, | ||
/** | ||
* The next command won't cache keys (exists only together with optout). | ||
*/ | ||
CACHING_NO, | ||
/** | ||
* The client isn't notified about keys modified by itself. | ||
*/ | ||
NOLOOP, | ||
/** | ||
* The client ID used for redirection isn't valid anymore. | ||
*/ | ||
BROKEN_REDIRECT; | ||
|
||
/** | ||
* Convert a given {@link String} flag to the corresponding {@link TrackingFlag} | ||
* | ||
* @param flag a {@link String} representation of the flag | ||
* @return the resulting {@link TrackingFlag} or {@link IllegalArgumentException} if unrecognized | ||
*/ | ||
public static TrackingFlag from(String flag) { | ||
switch (flag.toLowerCase()) { | ||
case "off": | ||
return OFF; | ||
case "on": | ||
return ON; | ||
case "bcast": | ||
return BCAST; | ||
case "optin": | ||
return OPTIN; | ||
case "optout": | ||
return OPTOUT; | ||
case "caching-yes": | ||
return CACHING_YES; | ||
case "caching-no": | ||
return CACHING_NO; | ||
case "noloop": | ||
return NOLOOP; | ||
case "broken_redirect": | ||
return BROKEN_REDIRECT; | ||
default: | ||
throw new RuntimeException("Unsupported flag: " + flag); | ||
} | ||
} | ||
|
||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.