com.heimuheimu.mysql.jdbc.command

接口 Command

所有已知实现类:

AbstractCommand, PingCommand, SQLCommand

public interface Command

Mysql 命令，提供获取该命令的请求数据包、解析该命令的响应数据包等操作。

说明：Command 的实现类必须是线程安全的。

作者:

heimuheimu

方法概要

限定符和类型	方法和说明
void	close() 关闭该命令，如果该命令处于等待响应数据包状态，应立刻释放。
byte[]	getRequestByteArray() 获得该命令对应的请求数据包。
java.util.List<MysqlPacket>	getResponsePacketList(long timeout) 获得该命令对应的响应数据包列表，该方法不会返回 null。
MysqlServerStatusInfo	getServerStatusInfo() Mysql 命令执行完后，返回的 Mysql 服务端状态信息，该方法允许返回 null。
boolean	hasResponsePacket() MysqlChannel 在发送完命令对应的请求数据包后， 会通过该方法判断该命令是否需要继续接收响应数据包。
void	receiveResponsePacket(MysqlPacket responsePacket) 在 hasResponsePacket() 方法返回 true 后，MysqlChannel 将会把下一个接收到响应数据包传入该方法。

方法详细资料

getRequestByteArray

byte[] getRequestByteArray()

获得该命令对应的请求数据包。

返回:

该命令对应的请求数据包

hasResponsePacket

boolean hasResponsePacket()

MysqlChannel 在发送完命令对应的请求数据包后， 会通过该方法判断该命令是否需要继续接收响应数据包。

返回:

该命令是否需要继续接收响应数据包

另请参阅:

receiveResponsePacket(MysqlPacket)

receiveResponsePacket

void receiveResponsePacket(MysqlPacket responsePacket)
                    throws java.lang.IllegalStateException

在 hasResponsePacket() 方法返回 true 后，MysqlChannel 将会把下一个接收到响应数据包传入该方法。

参数:

responsePacket - 响应数据包

抛出:

java.lang.IllegalStateException - 当接收到非预期响应包时，将抛出此异常

另请参阅:

hasResponsePacket()

getResponsePacketList

java.util.List<MysqlPacket> getResponsePacketList(long timeout)
                                           throws java.lang.IllegalStateException,
                                                  java.sql.SQLTimeoutException

获得该命令对应的响应数据包列表，该方法不会返回 null。

参数:

timeout - 超时时间，单位：毫秒

返回:

该命令对应的响应数据包列表

抛出:

java.lang.IllegalStateException - 等待响应数据过程中，命令被关闭或中断，将抛出此异常

java.sql.SQLTimeoutException - 等待响应数据超时，将抛出此异常

close

void close()

关闭该命令，如果该命令处于等待响应数据包状态，应立刻释放。

getServerStatusInfo

MysqlServerStatusInfo getServerStatusInfo()

Mysql 命令执行完后，返回的 Mysql 服务端状态信息，该方法允许返回 null。

返回:

Mysql 服务端状态信息，允许返回 null