Package org.mariadb.jdbc.client.socket.impl

Class PacketWriter

java.lang.Object

org.mariadb.jdbc.client.socket.impl.PacketWriter

All Implemented Interfaces:

Writer

public class PacketWriter
extends java.lang.Object
implements Writer

Packet writer

Field Summary

Fields

Modifier and Type	Field	Description
private static byte	BACKSLASH
protected byte[]	buf	internal buffer
private boolean	bufContainDataAfterMark
private long	cmdLength
protected MutableByte	compressSequence	compressed packet sequence
private static byte	DBL_QUOTE
private static int	LARGE_BUFFER_SIZE
private static Logger	logger
private int	mark
private static int	MAX_PACKET_LENGTH
private java.lang.Integer	maxAllowedPacket
private int	maxPacketLength
private int	maxQuerySizeToLog
private static int	MEDIUM_BUFFER_SIZE
private java.io.OutputStream	out
private boolean	permitTrace
protected int	pos	buffer position
private static byte	QUOTE
protected MutableByte	sequence	packet sequence
private java.lang.String	serverThreadLog
static int	SMALL_BUFFER_SIZE	initial buffer size
private static byte	ZERO_BYTE

Constructor Summary

Constructors

Constructor	Description
PacketWriter(java.io.OutputStream out, int maxQuerySizeToLog, java.lang.Integer maxAllowedPacket, MutableByte sequence, MutableByte compressSequence)	Common feature to write data into socket, creating MariaDB Packet.

Method Summary

Modifier and Type	Method	Description
byte[]	buf()	Current buffer
boolean	bufIsDataAfterMark()	Buffer has data after marked position
private void	checkMaxAllowedLength(int length)	Count query size.
void	close()	Close socket stream
void	flush()	Send packet to socket.
void	flushBufferStopAtMark()	Flush to last mark.
void	flushPipeline()	Send packet to buffered outputstream without flushing
long	getCmdLength()	get current command length
byte	getSequence()	Get current sequence object
private void	growBuffer(int len)	buf growing use 4 size only to avoid creating/copying that are expensive operations.
boolean	hasFlushed()	Current command has flushed packet to socket
void	initPacket()	reset sequences and position for sending a new packet
boolean	isMarked()	has some position been marked
void	mark()	mark position
void	permitTrace(boolean permitTrace)	Indicate if logging trace are permitted
int	pos()	get current position
void	pos(int pos)	position setter
byte[]	resetMark()	Reset mark flag and send bytes after mark flag.
void	setServerThreadId(java.lang.Long serverThreadId, HostAddress hostAddress)	Set server thread id.
boolean	throwMaxAllowedLength(int length)	must a max allowed length exception be thrown
void	writeAscii(java.lang.String str)	Write ascii string to buffer
void	writeByte(int value)	Write byte into buf, flush buf to socket if needed.
void	writeBytes(byte[] arr)	Write byte array to buffer
void	writeBytes(byte[] arr, int off, int len)	Write byte array to buf.
void	writeBytesAtPos(byte[] arr, int pos)	Write byte array to buffer at a specific position
void	writeBytesEscaped(byte[] bytes, int len, boolean noBackslashEscapes)	Write escape bytes to socket.
void	writeDouble(double value)	Write Double binary value to buffer
void	writeEmptyPacket()	Send empty packet.
void	writeFloat(float value)	Write float binary value to buffer
void	writeInt(int value)	Write int value into buf.
void	writeLength(long length)	Write field length into buf, flush socket if needed.
void	writeLong(long value)	Write long value into buf.
void	writeShort(short value)	Write short value into buf.
protected void	writeSocket(boolean commandEnd)	Flush the internal buf.
void	writeString(java.lang.String str)	Write utf8 string to buffer
void	writeStringEscaped(java.lang.String str, boolean noBackslashEscapes)	Write string to socket.

Methods inherited from class java.lang.Object

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

Field Detail

SMALL_BUFFER_SIZE

public static final int SMALL_BUFFER_SIZE

initial buffer size

See Also:

Constant Field Values

logger

private static final Logger logger

QUOTE

private static final byte QUOTE

See Also:

Constant Field Values

DBL_QUOTE

private static final byte DBL_QUOTE

See Also:

Constant Field Values

ZERO_BYTE

private static final byte ZERO_BYTE

See Also:

Constant Field Values

BACKSLASH

private static final byte BACKSLASH

See Also:

Constant Field Values

MEDIUM_BUFFER_SIZE

private static final int MEDIUM_BUFFER_SIZE

See Also:

Constant Field Values

LARGE_BUFFER_SIZE

private static final int LARGE_BUFFER_SIZE

See Also:

Constant Field Values

MAX_PACKET_LENGTH

private static final int MAX_PACKET_LENGTH

See Also:

Constant Field Values

sequence

protected final MutableByte sequence

packet sequence

compressSequence

protected final MutableByte compressSequence

compressed packet sequence

maxQuerySizeToLog

private final int maxQuerySizeToLog

out

private final java.io.OutputStream out

maxPacketLength

private final int maxPacketLength

See Also:

Constant Field Values

maxAllowedPacket

private final java.lang.Integer maxAllowedPacket

buf

protected byte[] buf

internal buffer

pos

protected int pos

buffer position

cmdLength

private long cmdLength

permitTrace

private boolean permitTrace

serverThreadLog

private java.lang.String serverThreadLog

mark

private int mark

bufContainDataAfterMark

private boolean bufContainDataAfterMark

Constructor Detail

PacketWriter

public PacketWriter(java.io.OutputStream out,
                    int maxQuerySizeToLog,
                    java.lang.Integer maxAllowedPacket,
                    MutableByte sequence,
                    MutableByte compressSequence)

Common feature to write data into socket, creating MariaDB Packet.

Parameters:

out - output stream

maxQuerySizeToLog - maximum query size to log

maxAllowedPacket - max allowed packet value if known

sequence - packet sequence

compressSequence - compressed packet sequence

Method Detail

pos

public int pos()

get current position

Specified by:

pos in interface Writer

Returns:

current position

pos

public void pos(int pos)
         throws java.io.IOException

position setter

Specified by:

pos in interface Writer

Parameters:

pos - new position

Throws:

java.io.IOException - if buffer is not big enough to contains new position

getCmdLength

public long getCmdLength()

get current command length

Specified by:

getCmdLength in interface Writer

Returns:

current command length

writeByte

public void writeByte(int value)
               throws java.io.IOException

Write byte into buf, flush buf to socket if needed.

Specified by:

writeByte in interface Writer

Parameters:

value - byte to send

Throws:

java.io.IOException - if socket error occur.

writeShort

public void writeShort(short value)
                throws java.io.IOException

Write short value into buf. flush buf if too small.

Specified by:

writeShort in interface Writer

Parameters:

value - short value

Throws:

java.io.IOException - if socket error occur

writeInt

public void writeInt(int value)
              throws java.io.IOException

Write int value into buf. flush buf if too small.

Specified by:

writeInt in interface Writer

Parameters:

value - int value

Throws:

java.io.IOException - if socket error occur

writeLong

public void writeLong(long value)
               throws java.io.IOException

Write long value into buf. flush buf if too small.

Specified by:

writeLong in interface Writer

Parameters:

value - long value

Throws:

java.io.IOException - if socket error occur

writeDouble

public void writeDouble(double value)
                 throws java.io.IOException

Description copied from interface: Writer

Write Double binary value to buffer

Specified by:

writeDouble in interface Writer

Parameters:

value - double value

Throws:

java.io.IOException - if socket error occur

writeFloat

public void writeFloat(float value)
                throws java.io.IOException

Description copied from interface: Writer

Write float binary value to buffer

Specified by:

writeFloat in interface Writer

Parameters:

value - float value

Throws:

java.io.IOException - if socket error occur

writeBytes

public void writeBytes(byte[] arr)
                throws java.io.IOException

Description copied from interface: Writer

Write byte array to buffer

Specified by:

writeBytes in interface Writer

Parameters:

arr - bytes

Throws:

java.io.IOException - if socket error occur

writeBytesAtPos

public void writeBytesAtPos(byte[] arr,
                            int pos)

Description copied from interface: Writer

Write byte array to buffer at a specific position

Specified by:

writeBytesAtPos in interface Writer

Parameters:

arr - bytes

pos - position

writeBytes

public void writeBytes(byte[] arr,
                       int off,
                       int len)
                throws java.io.IOException

Write byte array to buf. If buf is full, flush socket.

Specified by:

writeBytes in interface Writer

Parameters:

arr - byte array

off - offset

len - byte length to write

Throws:

java.io.IOException - if socket error occur

writeLength

public void writeLength(long length)
                 throws java.io.IOException

Write field length into buf, flush socket if needed.

Specified by:

writeLength in interface Writer

Parameters:

length - field length

Throws:

java.io.IOException - if socket error occur.

writeAscii

public void writeAscii(java.lang.String str)
                throws java.io.IOException

Description copied from interface: Writer

Write ascii string to buffer

Specified by:

writeAscii in interface Writer

Parameters:

str - string

Throws:

java.io.IOException - if socket error occurs

writeString

public void writeString(java.lang.String str)
                 throws java.io.IOException

Description copied from interface: Writer

Write utf8 string to buffer

Specified by:

writeString in interface Writer

Parameters:

str - string

Throws:

java.io.IOException - if socket error occurs

buf

public byte[] buf()

Current buffer

Specified by:

buf in interface Writer

Returns:

current buffer

writeStringEscaped

public void writeStringEscaped(java.lang.String str,
                               boolean noBackslashEscapes)
                        throws java.io.IOException

Write string to socket.

Specified by:

writeStringEscaped in interface Writer

Parameters:

str - string

noBackslashEscapes - escape method

Throws:

java.io.IOException - if socket error occur

writeBytesEscaped

public void writeBytesEscaped(byte[] bytes,
                              int len,
                              boolean noBackslashEscapes)
                       throws java.io.IOException

Write escape bytes to socket.

Specified by:

writeBytesEscaped in interface Writer

Parameters:

bytes - bytes

len - len to write

noBackslashEscapes - escape method

Throws:

java.io.IOException - if socket error occur

growBuffer

private void growBuffer(int len)
                 throws java.io.IOException

buf growing use 4 size only to avoid creating/copying that are expensive operations. possible size

1. SMALL_buf_SIZE = 8k (default)
2. MEDIUM_buf_SIZE = 128k
3. LARGE_buf_SIZE = 1M
4. getMaxPacketLength = 16M (+ 4 if using no compression)

Parameters:

len - length to add

Throws:

java.io.IOException

writeEmptyPacket

public void writeEmptyPacket()
                      throws java.io.IOException

Send empty packet.

Specified by:

writeEmptyPacket in interface Writer

Throws:

java.io.IOException - if socket error occur.

flush

public void flush()
           throws java.io.IOException

Send packet to socket.

Specified by:

flush in interface Writer

Throws:

java.io.IOException - if socket error occur.

flushPipeline

public void flushPipeline()
                   throws java.io.IOException

Description copied from interface: Writer

Send packet to buffered outputstream without flushing

Specified by:

flushPipeline in interface Writer

Throws:

java.io.IOException - if socket error occur.

checkMaxAllowedLength

private void checkMaxAllowedLength(int length)
                            throws MaxAllowedPacketException

Count query size. If query size is greater than max_allowed_packet and nothing has been already send, throw an exception to avoid having the connection closed.

Parameters:

length - additional length to query size

Throws:

MaxAllowedPacketException - if query has not to be sent.

throwMaxAllowedLength

public boolean throwMaxAllowedLength(int length)

Description copied from interface: Writer

must a max allowed length exception be thrown

Specified by:

throwMaxAllowedLength in interface Writer

Parameters:

length - command length

Returns:

true if too big

permitTrace

public void permitTrace(boolean permitTrace)

Description copied from interface: Writer

Indicate if logging trace are permitted

Specified by:

permitTrace in interface Writer

Parameters:

permitTrace - permits trace to be logged

setServerThreadId

public void setServerThreadId(java.lang.Long serverThreadId,
                              HostAddress hostAddress)

Set server thread id.

Specified by:

setServerThreadId in interface Writer

Parameters:

serverThreadId - current server thread id.

hostAddress - host information

mark

public void mark()

Description copied from interface: Writer

mark position

Specified by:

mark in interface Writer

isMarked

public boolean isMarked()

Description copied from interface: Writer

has some position been marked

Specified by:

isMarked in interface Writer

Returns:

is marked

hasFlushed

public boolean hasFlushed()

Description copied from interface: Writer

Current command has flushed packet to socket

Specified by:

hasFlushed in interface Writer

Returns:

indicate if some packet have been flushed

flushBufferStopAtMark

public void flushBufferStopAtMark()
                           throws java.io.IOException

Flush to last mark.

Specified by:

flushBufferStopAtMark in interface Writer

Throws:

java.io.IOException - if flush fail.

bufIsDataAfterMark

public boolean bufIsDataAfterMark()

Description copied from interface: Writer

Buffer has data after marked position

Specified by:

bufIsDataAfterMark in interface Writer

Returns:

indicate if there is data after marked position

resetMark

public byte[] resetMark()

Reset mark flag and send bytes after mark flag.

Specified by:

resetMark in interface Writer

Returns:

bytes after mark flag

initPacket

public void initPacket()

Description copied from interface: Writer

reset sequences and position for sending a new packet

Specified by:

initPacket in interface Writer

writeSocket

protected void writeSocket(boolean commandEnd)
                    throws java.io.IOException

Flush the internal buf.

Parameters:

commandEnd - command end

Throws:

java.io.IOException - id connection error occur.

close

public void close()
           throws java.io.IOException

Description copied from interface: Writer

Close socket stream

Specified by:

close in interface Writer

Throws:

java.io.IOException - if any error occurs

getSequence

public byte getSequence()

Description copied from interface: Writer

Get current sequence object

Specified by:

getSequence in interface Writer

Returns:

current sequence