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 Object
implements Writer

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	buf
protected MutableInt	compressSequence
protected int	pos
protected MutableInt	sequence
static int	SMALL_BUFFER_SIZE

Constructor Summary

Constructors

Constructor	Description
PacketWriter(OutputStream out, int maxQuerySizeToLog, MutableInt sequence, MutableInt compressSequence)	Common feature to write data into socket, creating MariaDB Packet.

Method Summary

Modifier and Type	Method	Description
boolean	bufIsDataAfterMark()
void	close()
void	flush()	Send packet to socket.
void	flushBufferStopAtMark()	Flush to last mark.
long	getCmdLength()
boolean	hasFlushed()
void	initPacket()
boolean	isMarked()
void	mark()
void	permitTrace(boolean permitTrace)
int	pos()
void	pos(int pos)
byte[]	resetMark()	Reset mark flag and send bytes after mark flag.
void	setMaxAllowedPacket(int maxAllowedPacket)
void	setServerThreadId(Long serverThreadId, HostAddress hostAddress)	Set server thread id.
boolean	throwMaxAllowedLength(int length)
void	writeAscii(String str)
void	writeByte(int value)	Write byte into buf, flush buf to socket if needed.
void	writeBytes(byte[] arr)
void	writeBytes(byte[] arr, int off, int len)	Write byte array to buf.
void	writeBytesAtPos(byte[] arr, int pos)
void	writeBytesEscaped(byte[] bytes, int len, boolean noBackslashEscapes)	Write escape bytes to socket.
void	writeDouble(double value)
void	writeEmptyPacket()	Send empty packet.
void	writeFloat(float value)
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(String str)
void	writeStringEscaped(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

See Also:

Constant Field Values

sequence

protected final MutableInt sequence

compressSequence

protected final MutableInt compressSequence

buf

protected byte[] buf

pos

protected int pos

Constructor Detail

PacketWriter

public PacketWriter(OutputStream out,
                    int maxQuerySizeToLog,
                    MutableInt sequence,
                    MutableInt compressSequence)

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

Parameters:

out - output stream

maxQuerySizeToLog - maximum query size to log

sequence - packet sequence

compressSequence - compressed packet sequence

Method Detail

pos

public int pos()

Specified by:

pos in interface Writer

pos

public void pos(int pos)
         throws IOException

Specified by:

pos in interface Writer

Throws:

IOException

getCmdLength

public long getCmdLength()

Specified by:

getCmdLength in interface Writer

writeByte

public void writeByte(int value)
               throws IOException

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

Specified by:

writeByte in interface Writer

Parameters:

value - byte to send

Throws:

IOException - if socket error occur.

writeShort

public void writeShort(short value)
                throws IOException

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

Specified by:

writeShort in interface Writer

Parameters:

value - short value

Throws:

IOException - if socket error occur

writeInt

public void writeInt(int value)
              throws IOException

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

Specified by:

writeInt in interface Writer

Parameters:

value - int value

Throws:

IOException - if socket error occur

writeLong

public void writeLong(long value)
               throws IOException

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

Specified by:

writeLong in interface Writer

Parameters:

value - long value

Throws:

IOException - if socket error occur

writeDouble

public void writeDouble(double value)
                 throws IOException

Specified by:

writeDouble in interface Writer

Throws:

IOException

writeFloat

public void writeFloat(float value)
                throws IOException

Specified by:

writeFloat in interface Writer

Throws:

IOException

writeBytes

public void writeBytes(byte[] arr)
                throws IOException

Specified by:

writeBytes in interface Writer

Throws:

IOException

writeBytesAtPos

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

Specified by:

writeBytesAtPos in interface Writer

writeBytes

public void writeBytes(byte[] arr,
                       int off,
                       int len)
                throws 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:

IOException - if socket error occur

writeLength

public void writeLength(long length)
                 throws IOException

Write field length into buf, flush socket if needed.

Specified by:

writeLength in interface Writer

Parameters:

length - field length

Throws:

IOException - if socket error occur.

writeAscii

public void writeAscii(String str)
                throws IOException

Specified by:

writeAscii in interface Writer

Throws:

IOException

writeString

public void writeString(String str)
                 throws IOException

Specified by:

writeString in interface Writer

Throws:

IOException

writeStringEscaped

public void writeStringEscaped(String str,
                               boolean noBackslashEscapes)
                        throws IOException

Write string to socket.

Specified by:

writeStringEscaped in interface Writer

Parameters:

str - string

noBackslashEscapes - escape method

Throws:

IOException - if socket error occur

writeBytesEscaped

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

Write escape bytes to socket.

Specified by:

writeBytesEscaped in interface Writer

Parameters:

bytes - bytes

len - len to write

noBackslashEscapes - escape method

Throws:

IOException - if socket error occur

writeEmptyPacket

public void writeEmptyPacket()
                      throws IOException

Send empty packet.

Specified by:

writeEmptyPacket in interface Writer

Throws:

IOException - if socket error occur.

flush

public void flush()
           throws IOException

Send packet to socket.

Specified by:

flush in interface Writer

Throws:

IOException - if socket error occur.

throwMaxAllowedLength

public boolean throwMaxAllowedLength(int length)

Specified by:

throwMaxAllowedLength in interface Writer

setMaxAllowedPacket

public void setMaxAllowedPacket(int maxAllowedPacket)

Specified by:

setMaxAllowedPacket in interface Writer

permitTrace

public void permitTrace(boolean permitTrace)

Specified by:

permitTrace in interface Writer

setServerThreadId

public void setServerThreadId(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()

Specified by:

mark in interface Writer

isMarked

public boolean isMarked()

Specified by:

isMarked in interface Writer

hasFlushed

public boolean hasFlushed()

Specified by:

hasFlushed in interface Writer

flushBufferStopAtMark

public void flushBufferStopAtMark()
                           throws IOException

Flush to last mark.

Specified by:

flushBufferStopAtMark in interface Writer

Throws:

IOException - if flush fail.

bufIsDataAfterMark

public boolean bufIsDataAfterMark()

Specified by:

bufIsDataAfterMark in interface Writer

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()

Specified by:

initPacket in interface Writer

writeSocket

protected void writeSocket(boolean commandEnd)
                    throws IOException

Flush the internal buf.

Parameters:

commandEnd - command end

Throws:

IOException - id connection error occur.

close

public void close()
           throws IOException

Specified by:

close in interface Writer

Throws:

IOException