java.lang.Object
- org.mariadb.jdbc.client.socket.Writer

public class Writer
extends java.lang.Object

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
`Writer(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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`byte[]`	`buf()`	Current buffer
`boolean`	`bufIsDataAfterMark()`
`private void`	`checkMaxAllowedLength(int length)`	Count query size.
`void`	`close()`
`void`	`flush()`	Send packet to socket.
`void`	`flushBufferStopAtMark()`	Flush to last mark.
`void`	`flushPipeline()`
`long`	`getCmdLength()`	get current command length
`byte`	`getSequence()`
`private void`	`growBuffer(int len)`	buf growing use 4 size only to avoid creating/copying that are expensive operations.
`boolean`	`hasFlushed()`
`void`	`initPacket()`
`boolean`	`isMarked()`
`void`	`mark()`
`void`	`permitTrace(boolean permitTrace)`
`int`	`pos()`	get current position
`void`	`pos(int pos)`	position setter
`byte[]`	`resetMark()`	Reset mark flag and send bytes after mark flag.
`void`	`setMaxAllowedPacket(java.lang.Integer maxAllowedPacket)`	Set the maximum size (in bytes) of a packet the writer will send.
`void`	`setServerThreadId(java.lang.Long serverThreadId, HostAddress hostAddress)`	Set server thread id.
`boolean`	`throwMaxAllowedLength(int length)`
`boolean`	`throwMaxAllowedLengthOr16M(int length)`
`void`	`writeAscii(java.lang.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(java.lang.String str)`
`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 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
  - Writer
```
public Writer(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
    
    Returns:
    
    current position
  - pos
```
public void pos(int pos)
         throws java.io.IOException
```
    position setter
    
    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
    
    Returns:
    
    current command length
  - writeByte
```
public void writeByte(int value)
               throws java.io.IOException
```
    Write byte into buf, flush buf to socket if needed.
    
    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.
    
    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.
    
    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.
    
    Parameters:
    
    value - long value
    
    Throws:
    
    java.io.IOException - if socket error occur
  - writeDouble
```
public void writeDouble(double value)
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeFloat
```
public void writeFloat(float value)
                throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeBytes
```
public void writeBytes(byte[] arr)
                throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeBytesAtPos
```
public void writeBytesAtPos(byte[] arr,
                            int pos)
```
  - 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.
    
    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.
    
    Parameters:
    
    length - field length
    
    Throws:
    
    java.io.IOException - if socket error occur.
  - writeAscii
```
public void writeAscii(java.lang.String str)
                throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeString
```
public void writeString(java.lang.String str)
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - buf
```
public byte[] buf()
```
    Current buffer
    
    Returns:
    
    current buffer
  - writeStringEscaped
```
public void writeStringEscaped(java.lang.String str,
                               boolean noBackslashEscapes)
                        throws java.io.IOException
```
    Write string to socket.
    
    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.
    
    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
    
    SMALL_buf_SIZE = 8k (default)
    MEDIUM_buf_SIZE = 128k
    LARGE_buf_SIZE = 1M
    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.
    
    Throws:
    
    java.io.IOException - if socket error occur.
  - flush
```
public void flush()
           throws java.io.IOException
```
    Send packet to socket.
    
    Throws:
    
    java.io.IOException - if socket error occur.
  - flushPipeline
```
public void flushPipeline()
                   throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - 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)
```
  - throwMaxAllowedLengthOr16M
```
public boolean throwMaxAllowedLengthOr16M(int length)
```
  - setMaxAllowedPacket
```
public void setMaxAllowedPacket(java.lang.Integer maxAllowedPacket)
```
    Set the maximum size (in bytes) of a packet the writer will send. Called once the handshake/authentication phase is over to raise the limit from the 16Mb connection-phase cap to the configured maxAllowedPacket.
    
    Parameters:
    
    maxAllowedPacket - maximum packet size to send, or null for no explicit limit
  - permitTrace
```
public void permitTrace(boolean permitTrace)
```
  - setServerThreadId
```
public void setServerThreadId(java.lang.Long serverThreadId,
                              HostAddress hostAddress)
```
    Set server thread id.
    
    Parameters:
    
    serverThreadId - current server thread id.
    
    hostAddress - host information
  - mark
```
public void mark()
```
  - isMarked
```
public boolean isMarked()
```
  - hasFlushed
```
public boolean hasFlushed()
```
  - flushBufferStopAtMark
```
public void flushBufferStopAtMark()
                           throws java.io.IOException
```
    Flush to last mark.
    
    Throws:
    
    java.io.IOException - if flush fail.
  - bufIsDataAfterMark
```
public boolean bufIsDataAfterMark()
```
  - resetMark
```
public byte[] resetMark()
```
    Reset mark flag and send bytes after mark flag.
    
    Returns:
    
    bytes after mark flag
  - initPacket
```
public void initPacket()
```
  - 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
```
    Throws:
    
    java.io.IOException
  - getSequence
```
public byte getSequence()
```

Class Writer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SMALL_BUFFER_SIZE

logger

QUOTE

DBL_QUOTE

ZERO_BYTE

BACKSLASH

MEDIUM_BUFFER_SIZE

LARGE_BUFFER_SIZE

MAX_PACKET_LENGTH

sequence

compressSequence

maxQuerySizeToLog

out

maxPacketLength

maxAllowedPacket

buf

pos

cmdLength

permitTrace

serverThreadLog

mark

bufContainDataAfterMark

Constructor Detail

Writer

Method Detail

pos

pos

getCmdLength

writeByte

writeShort

writeInt

writeLong

writeDouble

writeFloat

writeBytes

writeBytesAtPos

writeBytes

writeLength

writeAscii

writeString

buf

writeStringEscaped

writeBytesEscaped

growBuffer

writeEmptyPacket

flush

flushPipeline

checkMaxAllowedLength

throwMaxAllowedLength

throwMaxAllowedLengthOr16M

setMaxAllowedPacket

permitTrace

setServerThreadId

mark

isMarked

hasFlushed

flushBufferStopAtMark

bufIsDataAfterMark

resetMark

initPacket

writeSocket

close

getSequence