Class CloseMessage (0.6.0)

public class CloseMessage extends ControlMessage

Close the designated statement.

Inheritance

java.lang.Object > WireMessage > ControlMessage > CloseMessage

Inherited Members

ControlMessage.create(ConnectionHandler)

ControlMessage.getFormatCodes(DataInputStream)

ControlMessage.handleError(Exception)

ControlMessage.isExtendedProtocol()

ControlMessage.sendResultSet(IntermediateStatement,ConnectionHandler.QueryMode,long)

ControlMessage.sendSpannerResult(IntermediateStatement,ConnectionHandler.QueryMode,long)

WireMessage.getHeaderLength()

WireMessage.getIdentifier()

WireMessage.getMessageName()

WireMessage.getParameters(DataInputStream)

WireMessage.getPayloadString()

WireMessage.nextHandler()

WireMessage.read(int)

WireMessage.readAll()

WireMessage.readString()

WireMessage.send()

WireMessage.sendPayload()

WireMessage.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

IDENTIFIER

protected static final char IDENTIFIER

Field Value

Type	Description
char

Constructors

CloseMessage(ConnectionHandler connection)

public CloseMessage(ConnectionHandler connection)

Parameter

Name	Description
connection	`ConnectionHandler`

Methods

getHeaderLength()

protected int getHeaderLength()

How many bytes is taken by the payload header. Header is defined here as protocol definition + length. Most common value here is four bytes, so we keep that as default. Effectively, this is how much of the message you "don't" want to read from the message's total length with readAll.

Returns

Type	Description
int

Overrides

WireMessage.getHeaderLength()

getIdentifier()

protected String getIdentifier()

Used for logging.

Returns

Type	Description
String

Overrides

WireMessage.getIdentifier()

getMessageName()

protected String getMessageName()

Used for logging.

Returns

Type	Description
String

Overrides

WireMessage.getMessageName()

getName()

public String getName()

Returns

Type	Description
String

getPayloadString()

protected String getPayloadString()

Used for logging.

Returns

Type	Description
String

Overrides

WireMessage.getPayloadString()

getType()

public ControlMessage.PreparedType getType()

Returns

Type	Description
ControlMessage.PreparedType

sendPayload()

protected void sendPayload()

Close the statement server-side and clean up by deleting their metdata locally.

Overrides

WireMessage.sendPayload()

Exceptions

Type	Description
Exception