Skip to content

Commit

Permalink
add doc for client commands (#2819)
Browse files Browse the repository at this point in the history 
* add doc for client commands

* add doc for client commands
  • Loading branch information
@zeekling
zeekling committed Jan 18, 2022
1 parent e93e526 commit 9b702b8
Show file tree
Hide file tree
Showing 2 changed files with 196 additions and 0 deletions.
98 changes: 98 additions & 0 deletions src/main/java/redis/clients/jedis/commands/ClientBinaryCommands.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,34 +5,132 @@
import redis.clients.jedis.args.UnblockType;
import redis.clients.jedis.params.ClientKillParams;

/**
* The interface contain all the commands about client.
* The params is byte[]
*/
public interface ClientBinaryCommands {

/**
* Close a given client connection.
*
* @param ipPort The ip:port should match a line returned by the CLIENT LIST command (addr field).
* @return close success return OK
*/
String clientKill(byte[] ipPort);

/**
* Close a given client connection.
*
* @param ip The ip should match a line returned by the CLIENT LIST command (addr field).
* @param port The port should match a line returned by the CLIENT LIST command (addr field).
* @return Close success return OK
*/
String clientKill(String ip, int port);

/**
* Close a given client connection.
*
* @param params connect info will be closed
* @return Close success return OK
*/
long clientKill(ClientKillParams params);

/**
* Returns the name of the current connection as set by CLIENT SETNAME
*
* @return Current connect name
*/
byte[] clientGetnameBinary();

/**
* Returns information and statistics about the client connections server
* in a mostly human readable format.
*
* @return All clients info connected to redis-server
*/
byte[] clientListBinary();

/**
* Returns information and statistics about the client connections server
* in a mostly human readable format filter by client type.
*
* @return all clients info connected to redis-server
*/
byte[] clientListBinary(ClientType type);

/**
* Returns information and statistics about the client connections server
* in a mostly human readable format filter by client ids.
*
* @param clientIds Unique 64-bit client IDs
* @return All clients info connected to redis-server
*/
byte[] clientListBinary(long... clientIds);

/**
* Returns information and statistics about the current client connection
* in a mostly human readable format.
*
* @return Information and statistics about the current client connection
*/
byte[] clientInfoBinary();

/**
* Assigns a name to the current connection.
*
* @param name Current connection name
* @return OK if the connection name was successfully set.
*/
String clientSetname(byte[] name);

/**
* Returns the ID of the current connection.
*
* @return The id of the client.
*/
long clientId();

/**
* Unblock from a different connection, a client blocked in a
* blocking operation, such as for instance BRPOP or XREAD or WAIT.
*
* @param clientId The id of the client
* @return Specifically:
* 1 if the client was unblocked successfully.
* 0 if the client wasn't unblocked.
*/
long clientUnblock(long clientId);

/**
* Unblock from a different connection, a client blocked in a
* blocking operation, such as for instance BRPOP or XREAD or WAIT.
*
* @param clientId The id of the client
* @param unblockType TIMEOUT|ERROR
* @return Specifically:
* 1 if the client was unblocked successfully.
* 0 if the client wasn't unblocked.
*/
long clientUnblock(long clientId, UnblockType unblockType);

/**
* A connections control command able to suspend all the
* Redis clients for the specified amount of time (in milliseconds)
*
* @param timeout WRITE|ALL
* @return The command returns OK or an error if the timeout is invalid.
*/
String clientPause(long timeout);

/**
* A connections control command able to suspend all the
* Redis clients for the specified amount of time (in milliseconds)
*
* @param timeout Command timeout
* @param mode WRITE|ALL
* @return The command returns OK or an error if the timeout is invalid.
*/
String clientPause(long timeout, ClientPauseMode mode);

}
98 changes: 98 additions & 0 deletions src/main/java/redis/clients/jedis/commands/ClientCommands.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,34 +5,132 @@
import redis.clients.jedis.args.UnblockType;
import redis.clients.jedis.params.ClientKillParams;

/**
* The interface contain all the commands about client.
* The params is String encoded in uft-8
*/
public interface ClientCommands {

/**
* Close a given client connection.
*
* @param ipPort The ip:port should match a line returned by the CLIENT LIST command (addr field).
* @return Close success return OK
*/
String clientKill(String ipPort);

/**
* Close a given client connection.
*
* @param ip The ip should match a line returned by the CLIENT LIST command (addr field).
* @param port The port should match a line returned by the CLIENT LIST command (addr field).
* @return Close success return OK
*/
String clientKill(String ip, int port);

/**
* Close a given client connection.
*
* @param params Connection info will be closed
* @return Close success return OK
*/
long clientKill(ClientKillParams params);

/**
* Returns the name of the current connection as set by CLIENT SETNAME
*
* @return Current connect name
*/
String clientGetname();

/**
* Returns information and statistics about the client connections server
* in a mostly human readable format.
*
* @return All clients info connected to redis-server
*/
String clientList();

/**
* Returns information and statistics about the client connections server
* in a mostly human readable format filter by client type.
*
* @return All clients info connected to redis-server
*/
String clientList(ClientType type);

/**
* Returns information and statistics about the client connections server
* in a mostly human readable format filter by client ids.
*
* @param clientIds Unique 64-bit client IDs
* @return All clients info connected to redis-server
*/
String clientList(long... clientIds);

/**
* Returns information and statistics about the current client connection
* in a mostly human readable format.
*
* @return Information and statistics about the current client connection
*/
String clientInfo();

/**
* Assigns a name to the current connection.
*
* @param name current connection name
* @return OK if the connection name was successfully set.
*/
String clientSetname(String name);

/**
* Returns the ID of the current connection.
*
* @return The id of the client.
*/
long clientId();

/**
* Unblock from a different connection, a client blocked in a
* blocking operation, such as for instance BRPOP or XREAD or WAIT.
*
* @param clientId The id of the client
* @return Specifically:
* 1 if the client was unblocked successfully.
* 0 if the client wasn't unblocked.
*/
long clientUnblock(long clientId);

/**
* Unblock from a different connection, a client blocked in a
* blocking operation, such as for instance BRPOP or XREAD or WAIT.
*
* @param clientId The id of the client
* @param unblockType TIMEOUT|ERROR
* @return Specifically:
* 1 if the client was unblocked successfully.
* 0 if the client wasn't unblocked.
*/
long clientUnblock(long clientId, UnblockType unblockType);

/**
* A connections control command able to suspend all the
* Redis clients for the specified amount of time (in milliseconds)
*
* @param timeout WRITE|ALL
* @return The command returns OK or an error if the timeout is invalid.
*/
String clientPause(long timeout);

/**
* A connections control command able to suspend all the
* Redis clients for the specified amount of time (in milliseconds)
*
* @param timeout Command timeout
* @param mode WRITE|ALL
* @return The command returns OK or an error if the timeout is invalid.
*/
String clientPause(long timeout, ClientPauseMode mode);

}

0 comments on commit 9b702b8

Please sign in to comment.