-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
support for CLIENT KILL MAXAGE (#2727)
Closes/Fixes #2726 added two overloads and use a [filter object](https://github.com/StackExchange/StackExchange.Redis/compare/main...atakavci:StackExchange.Redis:ali/maxage?expand=1#diff-6c39ce347d72497c65974f0d78ab9a986be3198e7b2555975ff06410a9831bd8) to avoid a breaking change. Co-authored-by: Nick Craver <[email protected]>
- Loading branch information
1 parent
0d38f6f
commit a64ca14
Showing
6 changed files
with
296 additions
and
41 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Net; | ||
|
|
||
| namespace StackExchange.Redis; | ||
|
|
||
| /// <summary> | ||
| /// Filter determining which Redis clients to kill. | ||
| /// </summary> | ||
| /// <seealso href="https://redis.io/docs/latest/commands/client-kill/"/> | ||
| public class ClientKillFilter | ||
| { | ||
| /// <summary> | ||
| /// Filter arguments builder for `CLIENT KILL`. | ||
| /// </summary> | ||
| public ClientKillFilter() { } | ||
|
|
||
| /// <summary> | ||
| /// The ID of the client to kill. | ||
| /// </summary> | ||
| public long? Id { get; private set; } | ||
|
|
||
| /// <summary> | ||
| /// The type of client. | ||
| /// </summary> | ||
| public ClientType? ClientType { get; private set; } | ||
|
|
||
| /// <summary> | ||
| /// The authenticated ACL username. | ||
| /// </summary> | ||
| public string? Username { get; private set; } | ||
|
|
||
| /// <summary> | ||
| /// The endpoint to kill. | ||
| /// </summary> | ||
| public EndPoint? Endpoint { get; private set; } | ||
|
|
||
| /// <summary> | ||
| /// The server endpoint to kill. | ||
| /// </summary> | ||
| public EndPoint? ServerEndpoint { get; private set; } | ||
|
|
||
| /// <summary> | ||
| /// Whether to skip the current connection. | ||
| /// </summary> | ||
| public bool? SkipMe { get; private set; } | ||
|
|
||
| /// <summary> | ||
| /// Age of connection in seconds. | ||
| /// </summary> | ||
| public long? MaxAgeInSeconds { get; private set; } | ||
|
|
||
| /// <summary> | ||
| /// Sets client id filter. | ||
| /// </summary> | ||
| /// <param name="id">Id of the client to kill.</param> | ||
| public ClientKillFilter WithId(long? id) | ||
| { | ||
| Id = id; | ||
| return this; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Sets client type filter. | ||
| /// </summary> | ||
| /// <param name="clientType">The type of the client.</param> | ||
| public ClientKillFilter WithClientType(ClientType? clientType) | ||
| { | ||
| ClientType = clientType; | ||
| return this; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Sets the username filter. | ||
| /// </summary> | ||
| /// <param name="username">Authenticated ACL username.</param> | ||
| public ClientKillFilter WithUsername(string? username) | ||
| { | ||
| Username = username; | ||
| return this; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Set the endpoint filter. | ||
| /// </summary> | ||
| /// <param name="endpoint">The endpoint to kill.</param> | ||
| public ClientKillFilter WithEndpoint(EndPoint? endpoint) | ||
| { | ||
| Endpoint = endpoint; | ||
| return this; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Set the server endpoint filter. | ||
| /// </summary> | ||
| /// <param name="serverEndpoint">The server endpoint to kill.</param> | ||
| public ClientKillFilter WithServerEndpoint(EndPoint? serverEndpoint) | ||
| { | ||
| ServerEndpoint = serverEndpoint; | ||
| return this; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Set the skipMe filter (whether to skip the current connection). | ||
| /// </summary> | ||
| /// <param name="skipMe">Whether to skip the current connection.</param> | ||
| public ClientKillFilter WithSkipMe(bool? skipMe) | ||
| { | ||
| SkipMe = skipMe; | ||
| return this; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Set the MaxAgeInSeconds filter. | ||
| /// </summary> | ||
| /// <param name="maxAgeInSeconds">Age of connection in seconds</param> | ||
| public ClientKillFilter WithMaxAgeInSeconds(long? maxAgeInSeconds) | ||
| { | ||
| MaxAgeInSeconds = maxAgeInSeconds; | ||
| return this; | ||
| } | ||
|
|
||
| internal List<RedisValue> ToList(bool withReplicaCommands) | ||
| { | ||
| var parts = new List<RedisValue>(15) | ||
| { | ||
| RedisLiterals.KILL | ||
| }; | ||
| if (Id != null) | ||
| { | ||
| parts.Add(RedisLiterals.ID); | ||
| parts.Add(Id.Value); | ||
| } | ||
| if (ClientType != null) | ||
| { | ||
| parts.Add(RedisLiterals.TYPE); | ||
| switch (ClientType.Value) | ||
| { | ||
| case Redis.ClientType.Normal: | ||
| parts.Add(RedisLiterals.normal); | ||
| break; | ||
| case Redis.ClientType.Replica: | ||
| parts.Add(withReplicaCommands ? RedisLiterals.replica : RedisLiterals.slave); | ||
| break; | ||
| case Redis.ClientType.PubSub: | ||
| parts.Add(RedisLiterals.pubsub); | ||
| break; | ||
| default: | ||
| throw new ArgumentOutOfRangeException(nameof(ClientType)); | ||
| } | ||
| } | ||
| if (Username != null) | ||
| { | ||
| parts.Add(RedisLiterals.USERNAME); | ||
| parts.Add(Username); | ||
| } | ||
| if (Endpoint != null) | ||
| { | ||
| parts.Add(RedisLiterals.ADDR); | ||
| parts.Add((RedisValue)Format.ToString(Endpoint)); | ||
| } | ||
| if (ServerEndpoint != null) | ||
| { | ||
| parts.Add(RedisLiterals.LADDR); | ||
| parts.Add((RedisValue)Format.ToString(ServerEndpoint)); | ||
| } | ||
| if (SkipMe != null) | ||
| { | ||
| parts.Add(RedisLiterals.SKIPME); | ||
| parts.Add(SkipMe.Value ? RedisLiterals.yes : RedisLiterals.no); | ||
| } | ||
| if (MaxAgeInSeconds != null) | ||
| { | ||
| parts.Add(RedisLiterals.MAXAGE); | ||
| parts.Add(MaxAgeInSeconds); | ||
| } | ||
| return parts; | ||
| } | ||
| } |
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.