com.mysql.cj.protocol.a

Class TracingPacketReader

java.lang.Object

com.mysql.cj.protocol.a.TracingPacketReader

All Implemented Interfaces:

MessageReader<NativePacketHeader,NativePacketPayload>

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

A decorating MessageReader which traces all received packets to the provided logger.

Field Summary

Fields

Modifier and Type	Field and Description
private Log	log
private static int	MAX_PACKET_DUMP_LENGTH Max number of bytes to dump when tracing the protocol
private MessageReader<NativePacketHeader,NativePacketPayload>	packetReader

Constructor Summary

Constructors

Constructor and Description
TracingPacketReader(MessageReader<NativePacketHeader,NativePacketPayload> packetReader, Log log)

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.
private NativePacketHeader	traceHeader(NativePacketHeader hdr)
private NativePacketPayload	traceMessage(NativePacketPayload buf, int packetLength, boolean reuse)
MessageReader<NativePacketHeader,NativePacketPayload>	undecorate() Return the previous MessageReader instance from the decorators chain or the current MessageReader if it is the first entry in a chain.
MessageReader<NativePacketHeader,NativePacketPayload>	undecorateAll() Return a MessageReader instance free of decorators.

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, skipPacket, start, stopAfterNextMessage

Field Detail

MAX_PACKET_DUMP_LENGTH

private static final int MAX_PACKET_DUMP_LENGTH

Max number of bytes to dump when tracing the protocol

See Also:

Constant Field Values

packetReader

private MessageReader<NativePacketHeader,NativePacketPayload> packetReader

log

private Log log

Constructor Detail

TracingPacketReader

public TracingPacketReader(MessageReader<NativePacketHeader,NativePacketPayload> packetReader,
                           Log log)

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

traceHeader

private NativePacketHeader traceHeader(NativePacketHeader hdr)
                                throws java.io.IOException

Throws:

java.io.IOException

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

traceMessage

private NativePacketPayload traceMessage(NativePacketPayload buf,
                                         int packetLength,
                                         boolean reuse)
                                  throws java.io.IOException

Throws:

java.io.IOException

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>

undecorateAll

public MessageReader<NativePacketHeader,NativePacketPayload> undecorateAll()

Description copied from interface: MessageReader

Return a MessageReader instance free of decorators.

Specified by:

undecorateAll in interface MessageReader<NativePacketHeader,NativePacketPayload>

Returns:

MessageReader

undecorate

public MessageReader<NativePacketHeader,NativePacketPayload> undecorate()

Description copied from interface: MessageReader

Return the previous MessageReader instance from the decorators chain or the current MessageReader if it is the first entry in a chain.

Specified by:

undecorate in interface MessageReader<NativePacketHeader,NativePacketPayload>

Returns:

MessageReader