ConnectionCommands (Buession Redis Client 2.1.0 API)

所有超级接口:

RedisCommands

所有已知子接口:

ConnectionOperations, ConnectionOperations

所有已知实现类:

AbstractConnectionOperations, AbstractRedisTemplate, BaseRedisTemplate, JedisClusterConnectionOperations, JedisConnectionOperations, JedisSentinelConnectionOperations, RedisTemplate
```
public interface ConnectionCommands
extends RedisCommands
```
连接相关命令
详情说明 http://www.redis.cn/commands.html#connection

作者:

Yong.Teng

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`com.buession.lang.Status`	`auth(byte[] password)` 通过密码进行认证详情说明 http://redisdoc.com/client_and_server/auth.html
`com.buession.lang.Status`	`auth(byte[] user, byte[] password)` 通过密码进行认证详情说明 http://redisdoc.com/client_and_server/auth.html
`com.buession.lang.Status`	`auth(String password)` 通过密码进行认证详情说明 http://redisdoc.com/client_and_server/auth.html
`com.buession.lang.Status`	`auth(String user, String password)` 通过密码进行认证详情说明 http://redisdoc.com/client_and_server/auth.html
`com.buession.lang.Status`	`clientCaching(boolean isYes)` This command controls the tracking of the keys in the next command executed by the connection, when tracking is enabled in OPTIN or OPTOUT mode 详情说明 https://redis.io/commands/client-caching/
`String`	`clientGetName()` 获取连接时设置的名字详情说明 http://redisdoc.com/client_and_server/client_getname.html
`Integer`	`clientGetRedir()` This command returns the client ID we are redirecting our tracking notifications to 详情说明 https://redis.io/commands/client-getredir/
`Long`	`clientId()` 返回当前连接的 ID 详情说明 http://www.redis.cn/commands/client-id.html
`Client`	`clientInfo()` The command returns information and statistics about the current client connection in a mostly human readable format 详情说明 https://redis.io/commands/client-info/
`com.buession.lang.Status`	`clientKill(String host, int port)` 关闭地址为 host:port 的客户端详情说明 http://redisdoc.com/client_and_server/client_kill.html
`List<Client>`	`clientList()` 获取所有连接到服务器的客户端信息和统计数据详情说明 http://redisdoc.com/client_and_server/client_list.html
`List<Client>`	`clientList(ClientType clientType)` 获取所有连接到服务器的客户端信息和统计数据详情说明 http://redisdoc.com/client_and_server/client_list.html
`com.buession.lang.Status`	`clientPause(int timeout)` 将所有客户端的访问暂停给定的毫秒数详情说明 http://www.redis.cn/commands/client-pause.html
`com.buession.lang.Status`	`clientReply(ClientReply option)` 当需要完全禁用redis服务器对当前客户端的回复时可使用该命令详情说明 http://www.redis.cn/commands/client-reply.html
`com.buession.lang.Status`	`clientSetName(byte[] name)` 为当前连接分配一个名字详情说明 http://redisdoc.com/client_and_server/client_setname.html
`com.buession.lang.Status`	`clientSetName(String name)` 为当前连接分配一个名字详情说明 http://redisdoc.com/client_and_server/client_setname.html
`com.buession.lang.Status`	`clientUnblock(int clientId)` 该命令可以通过其他连接解除客户端的阻塞详情说明 http://www.redis.cn/commands/client-unblock.html
`com.buession.lang.Status`	`clientUnblock(int clientId, ClientUnblockType type)` 该命令可以通过其他连接解除客户端的阻塞详情说明 http://www.redis.cn/commands/client-unblock.html
`byte[]`	`echo(byte[] str)` 打印一个特定的字符串详情说明 http://www.redis.cn/commands/echo.html
`String`	`echo(String str)` 打印一个特定的字符串详情说明 http://www.redis.cn/commands/echo.html
`com.buession.lang.Status`	`ping()` 使用客户端向 Redis 服务器发送一个 PING ，如果服务器运作正常的话，会返回一个 PONG；通常用于测试与服务器的连接是否仍然生效，或者用于测量延迟值详情说明 http://www.redis.cn/commands/ping.html
`com.buession.lang.Status`	`quit()` 请求服务器关闭与当前客户端的连接详情说明 http://www.redis.cn/commands/quit.html
`com.buession.lang.Status`	`reset()` This command performs a full reset of the connection’s server-side context, mimicking the effect of disconnecting and reconnecting again.
`com.buession.lang.Status`	`select(int db)` 切换到指定的数据库详情说明 http://redisdoc.com/database/select.html

- 方法详细资料
  - auth
```
com.buession.lang.Status auth(String user,
                              String password)
```
    通过密码进行认证
    详情说明 http://redisdoc.com/client_and_server/auth.html
    
    参数:
    
    user - 用户账号
    
    password - 密码
    
    返回:
    
    密码匹配时返回 Status.SUCCESS；否则，返回 Status.FAILURE
  - auth
```
com.buession.lang.Status auth(byte[] user,
                              byte[] password)
```
    通过密码进行认证
    详情说明 http://redisdoc.com/client_and_server/auth.html
    
    参数:
    
    user - 用户账号
    
    password - 密码
    
    返回:
    
    密码匹配时返回 Status.SUCCESS；否则，返回 Status.FAILURE
  - auth
```
com.buession.lang.Status auth(String password)
```
    通过密码进行认证
    详情说明 http://redisdoc.com/client_and_server/auth.html
    
    参数:
    
    password - 密码
    
    返回:
    
    密码匹配时返回 Status.SUCCESS；否则，返回 Status.FAILURE
  - auth
```
com.buession.lang.Status auth(byte[] password)
```
    通过密码进行认证
    详情说明 http://redisdoc.com/client_and_server/auth.html
    
    参数:
    
    password - 密码
    
    返回:
    
    密码匹配时返回 Status.SUCCESS；否则，返回 Status.FAILURE
  - echo
```
String echo(String str)
```
    打印一个特定的字符串
    详情说明 http://www.redis.cn/commands/echo.html
    
    参数:
    
    str - 待打印的字符串
    
    返回:
    
    字符串本身
  - echo
```
byte[] echo(byte[] str)
```
    打印一个特定的字符串
    详情说明 http://www.redis.cn/commands/echo.html
    
    参数:
    
    str - 待打印的字符串
    
    返回:
    
    字符串本身
  - ping
```
com.buession.lang.Status ping()
```
    使用客户端向 Redis 服务器发送一个 PING ，如果服务器运作正常的话，会返回一个 PONG；通常用于测试与服务器的连接是否仍然生效，或者用于测量延迟值
    详情说明 http://www.redis.cn/commands/ping.html
    
    返回:
    
    PING 结果
  - reset
```
com.buession.lang.Status reset()
```
    This command performs a full reset of the connection’s server-side context, mimicking the effect of disconnecting and reconnecting again.
    详情说明 https://redis.io/commands/reset/
    
    返回:
    
    总是返回 Status.SUCCESS
  - quit
```
com.buession.lang.Status quit()
```
    请求服务器关闭与当前客户端的连接
    详情说明 http://www.redis.cn/commands/quit.html
    
    返回:
    
    总是返回 Status.SUCCESS
  - select
```
com.buession.lang.Status select(int db)
```
    切换到指定的数据库
    详情说明 http://redisdoc.com/database/select.html
    
    参数:
    
    db - 数据库索引号
    
    返回:
    
    切换成功返回 Status.SUCCESS；否则，返回 Status.FAILURE
  - clientCaching
```
com.buession.lang.Status clientCaching(boolean isYes)
```
    This command controls the tracking of the keys in the next command executed by the connection, when tracking is enabled in OPTIN or OPTOUT mode
    详情说明 https://redis.io/commands/client-caching/
    
    参数:
    
    isYes - Yes / No
    
    返回:
    
    Status.SUCCESS or Status.FAILURE if the argument is not yes or no
  - clientId
```
Long clientId()
```
    返回当前连接的 ID
    详情说明 http://www.redis.cn/commands/client-id.html
    
    返回:
    
    当前连接的 ID
  - clientSetName
```
com.buession.lang.Status clientSetName(String name)
```
    为当前连接分配一个名字
    详情说明 http://redisdoc.com/client_and_server/client_setname.html
    
    参数:
    
    name - 名字
    
    返回:
    
    设置成功时返回 Status.SUCCESS；否则，返回 Status.FAILURE
  - clientSetName
```
com.buession.lang.Status clientSetName(byte[] name)
```
    为当前连接分配一个名字
    详情说明 http://redisdoc.com/client_and_server/client_setname.html
    
    参数:
    
    name - 名字
    
    返回:
    
    设置成功时返回 Status.SUCCESS；否则，返回 Status.FAILURE
  - clientGetName
```
String clientGetName()
```
    获取连接时设置的名字
    详情说明 http://redisdoc.com/client_and_server/client_getname.html
    
    返回:
    
    连接时设置的名字
  - clientGetRedir
```
Integer clientGetRedir()
```
    This command returns the client ID we are redirecting our tracking notifications to
    详情说明 https://redis.io/commands/client-getredir/
    
    返回:
    
    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
  - clientList
```
List<Client> clientList()
```
    获取所有连接到服务器的客户端信息和统计数据
    详情说明 http://redisdoc.com/client_and_server/client_list.html
    
    返回:
    
    所有连接到服务器的客户端信息和统计数据
  - clientList
```
List<Client> clientList(ClientType clientType)
```
    获取所有连接到服务器的客户端信息和统计数据
    详情说明 http://redisdoc.com/client_and_server/client_list.html
    
    参数:
    
    clientType - 客户端类型
    
    返回:
    
    所有连接到服务器的客户端信息和统计数据
  - clientInfo
```
Client clientInfo()
```
    The command returns information and statistics about the current client connection in a mostly human readable format
    详情说明 https://redis.io/commands/client-info/
    
    返回:
    
    连接到服务器的客户端信息
  - clientPause
```
com.buession.lang.Status clientPause(int timeout)
```
    将所有客户端的访问暂停给定的毫秒数
    详情说明 http://www.redis.cn/commands/client-pause.html
    
    参数:
    
    timeout - 暂停时间（单位：毫秒）
    
    返回:
    
    操作结果
  - clientReply
```
com.buession.lang.Status clientReply(ClientReply option)
```
    当需要完全禁用redis服务器对当前客户端的回复时可使用该命令
    详情说明 http://www.redis.cn/commands/client-reply.html
    
    参数:
    
    option - 选项
    
    返回:
    
    当执行命令设置为 OFF 或 SKIP，设置命令收不到任何回复，当设置为 ON 时，返回OK
  - clientKill
```
com.buession.lang.Status clientKill(String host,
                                    int port)
```
    关闭地址为 host:port 的客户端
    详情说明 http://redisdoc.com/client_and_server/client_kill.html
    
    参数:
    
    host - 客户端地址
    
    port - 客户端端口
    
    返回:
    
    当指定的客户端存在，且被成功关闭时，返回 Status.SUCCESS；否则，返回 Status.FAILURE
  - clientUnblock
```
com.buession.lang.Status clientUnblock(int clientId)
```
    该命令可以通过其他连接解除客户端的阻塞
    详情说明 http://www.redis.cn/commands/client-unblock.html
    
    参数:
    
    clientId - 客户端 ID
    
    返回:
    
    当执行命令设置为 OFF 或 SKIP，设置命令收不到任何回复，当设置为 ON 时，返回OK
  - clientUnblock
```
com.buession.lang.Status clientUnblock(int clientId,
                                       ClientUnblockType type)
```
    该命令可以通过其他连接解除客户端的阻塞
    详情说明 http://www.redis.cn/commands/client-unblock.html
    
    参数:
    
    clientId - 客户端 ID
    
    type - type
    
    返回:
    
    当执行命令设置为 OFF 或 SKIP，设置命令收不到任何回复，当设置为 ON 时，返回OK

接口 ConnectionCommands

方法概要

方法详细资料

auth

auth

auth

auth

echo

echo

ping

reset

quit

select

clientCaching

clientId

clientSetName

clientSetName

clientGetName

clientGetRedir

clientList

clientList

clientInfo

clientPause

clientReply

clientKill

clientUnblock

clientUnblock