com.mysql.cj.protocol.a

Class SimplePacketReader

java.lang.Object

com.mysql.cj.protocol.a.SimplePacketReader

All Implemented Interfaces:

MessageReader<NativePacketHeader,NativePacketPayload>

public class SimplePacketReader
extends java.lang.Object
implements MessageReader<NativePacketHeader,NativePacketPayload>

Simple implementation of MessageReader which handles the receiving of logical MySQL packets from the provided socket input stream. Multi-packets are handled outside of this reader.

Field Summary

Fields

Modifier and Type	Field and Description
protected RuntimeProperty<java.lang.Integer>	maxAllowedPacket
protected SocketConnection	socketConnection

Constructor Summary

Constructors

Constructor and Description
SimplePacketReader(SocketConnection socketConnection, RuntimeProperty<java.lang.Integer> maxAllowedPacket)

Method Summary

Modifier and Type	Method and Description
byte	getMessageSequence() Get last message sequence number, as it was stored by MessageReader.readHeader().
NativePacketHeader	probeHeader() Read the next message header from server, possibly blocking indefinitely until the message is received, and cache it so that the next MessageReader.readHeader() return the same header.
NativePacketPayload	probeMessage(java.util.Optional<NativePacketPayload> reuse, NativePacketHeader header) Read message from server into to the given Message instance or into the new one if not present and cache it so that the next MessageReader.readMessage(Optional, MessageHeader) return the same message.
NativePacketHeader	readHeader() Read the next message header from server, possibly blocking indefinitely until the message is received.
NativePacketPayload	readMessage(java.util.Optional<NativePacketPayload> reuse, NativePacketHeader header) Read message from server into to the given Message instance or into the new one if not present.
void	resetMessageSequence() Set stored message sequence number to 0.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.mysql.cj.protocol.MessageReader

pushMessageListener, readMessage, start, stopAfterNextMessage, undecorate, undecorateAll

Field Detail

socketConnection

protected SocketConnection socketConnection

maxAllowedPacket

protected RuntimeProperty<java.lang.Integer> maxAllowedPacket

Constructor Detail

SimplePacketReader

public SimplePacketReader(SocketConnection socketConnection,
                          RuntimeProperty<java.lang.Integer> maxAllowedPacket)

Method Detail

readHeader

public NativePacketHeader readHeader()
                              throws java.io.IOException

Description copied from interface: MessageReader

Read the next message header from server, possibly blocking indefinitely until the message is received.

Specified by:

readHeader in interface MessageReader<NativePacketHeader,NativePacketPayload>

Returns:

MessageHeader of the next message

Throws:

java.io.IOException - if an error occurs

probeHeader

public NativePacketHeader probeHeader()
                               throws java.io.IOException

Description copied from interface: MessageReader

Read the next message header from server, possibly blocking indefinitely until the message is received, and cache it so that the next MessageReader.readHeader() return the same header.

Specified by:

probeHeader in interface MessageReader<NativePacketHeader,NativePacketPayload>

Returns:

MessageHeader of the next message

Throws:

java.io.IOException - if an error occurs

readMessage

public NativePacketPayload readMessage(java.util.Optional<NativePacketPayload> reuse,
                                       NativePacketHeader header)
                                throws java.io.IOException

Description copied from interface: MessageReader

Read message from server into to the given Message instance or into the new one if not present. For asynchronous channel it synchronously reads the next message in the stream, blocking until the message is read fully. Could throw CJCommunicationsException wrapping an IOException during read or parse

Specified by:

readMessage in interface MessageReader<NativePacketHeader,NativePacketPayload>

Parameters:

reuse - Message object to reuse. May be ignored by implementation.

header - MessageHeader instance

Returns:

Message instance

Throws:

java.io.IOException - if an error occurs

probeMessage

public NativePacketPayload probeMessage(java.util.Optional<NativePacketPayload> reuse,
                                        NativePacketHeader header)
                                 throws java.io.IOException

Description copied from interface: MessageReader

Read message from server into to the given Message instance or into the new one if not present and cache it so that the next MessageReader.readMessage(Optional, MessageHeader) return the same message. For asynchronous channel it synchronously reads the next message in the stream, blocking until the message is read fully. Could throw CJCommunicationsException wrapping an IOException during read or parse

Specified by:

probeMessage in interface MessageReader<NativePacketHeader,NativePacketPayload>

Parameters:

reuse - Message object to reuse. May be ignored by implementation.

header - MessageHeader instance

Returns:

Message instance

Throws:

java.io.IOException - if an error occurs

getMessageSequence

public byte getMessageSequence()

Description copied from interface: MessageReader

Get last message sequence number, as it was stored by MessageReader.readHeader().

Specified by:

getMessageSequence in interface MessageReader<NativePacketHeader,NativePacketPayload>

Returns:

number

resetMessageSequence

public void resetMessageSequence()

Description copied from interface: MessageReader

Set stored message sequence number to 0.

Specified by:

resetMessageSequence in interface MessageReader<NativePacketHeader,NativePacketPayload>