org.mariadb.jdbc.internal.stream

Class PacketOutputStream

java.lang.Object

java.io.OutputStream

org.mariadb.jdbc.internal.stream.PacketOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class PacketOutputStream
extends OutputStream

Field Summary

Fields

Modifier and Type	Field and Description
ByteBuffer	buffer

Constructor Summary

Constructors

Constructor and Description
PacketOutputStream(OutputStream outputStream) Initialization with server outputStream.

Method Summary

Modifier and Type	Method and Description
PacketOutputStream	assureBufferCapacity(int len) Ensure that the buffer remaining size permit to write a data with a size len.
boolean	checkRewritableLength(int length) Check that current buffer + length will not be superior to max_allowed_packet + header size.
void	close()
void	finishPacket() Ending command that tell to send buffer to server.
void	flush()
protected void	increase(int newCapacity)
void	sendFile(InputStream is, int seq) Used to send LOAD DATA INFILE.
void	sendStream(InputStream is) Send stream to server.
void	sendStream(InputStream is, long readLength) Send stream to server.
void	sendStream(Reader reader, long readLength, MariaDbCharset charset) Send reader stream to server.
void	sendStream(Reader reader, MariaDbCharset charset) Send reader stream to server.
void	setMaxAllowedPacket(int maxAllowedPacket) Initialize maximal send size (can be send in multiple stream).
void	setUseCompression(boolean useCompression)
void	startPacket(int seqNo) Initialize stream sequence.
void	startPacket(int seqNo, boolean checkPacketLength) Initialize stream sequence.
void	write(byte[] bytes)
void	write(byte[] bytes, int off, int len)
void	write(int byteInt)
PacketOutputStream	writeByte(byte theByte) Write a byte data to buffer.
PacketOutputStream	writeByteArray(byte[] bytes) Write byte array to buffer.
PacketOutputStream	writeByteArrayLength(byte[] bytes) Write byte array data to binary data.
PacketOutputStream	writeBytes(byte theByte, int count) Write count time the byte value.
PacketOutputStream	writeDateLength(Calendar calendar) Write date in binary format.
void	writeEmptyPacket(int seqNo) Send an empty stream to server.
PacketOutputStream	writeFieldLength(long length) Write field length to encode in binary format.
PacketOutputStream	writeInt(int theInt) Write int data in binary format.
PacketOutputStream	writeLong(long theLong) Write long data in binary format.
PacketOutputStream	writeShort(short theShort) Write short data in binary format.
PacketOutputStream	writeString(String str) Write string data in binary format.
PacketOutputStream	writeStringLength(String str) Write string in binary format.
PacketOutputStream	writeTimeLength(Calendar calendar, boolean fractionalSeconds) Write time in binary format.
PacketOutputStream	writeTimestampLength(Calendar calendar, Timestamp ts, boolean fractionalSeconds) Write timestamp in binary format.

Methods inherited from class java.lang.Object

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

Field Detail

buffer

public ByteBuffer buffer

Constructor Detail

PacketOutputStream

public PacketOutputStream(OutputStream outputStream)

Initialization with server outputStream.

Parameters:

outputStream - server outPutStream

Method Detail

increase

protected void increase(int newCapacity)

setUseCompression

public void setUseCompression(boolean useCompression)

startPacket

public void startPacket(int seqNo,
                        boolean checkPacketLength)
                 throws IOException

Initialize stream sequence. Max stream allowed size will be checked.

Parameters:

seqNo - stream sequence number

checkPacketLength - indication that max stream allowed size will be checked.

Throws:

IOException - if any error occur during data send to server

startPacket

public void startPacket(int seqNo)
                 throws IOException

Initialize stream sequence.

Parameters:

seqNo - stream sequence number

Throws:

IOException - if any error occur during data send to server

writeEmptyPacket

public void writeEmptyPacket(int seqNo)
                      throws IOException

Send an empty stream to server.

Parameters:

seqNo - stream sequence number

Throws:

IOException - if any error occur during data send to server

sendFile

public void sendFile(InputStream is,
                     int seq)
              throws IOException

Used to send LOAD DATA INFILE. End of data is indicated by stream of length 0.

Parameters:

is - inputStream to send

seq - stream sequence number

Throws:

IOException - if any error occur during data send to server

sendStream

public void sendStream(InputStream is)
                throws IOException

Send stream to server.

Parameters:

is - inputStream to send

Throws:

IOException - if any error occur during data send to server

sendStream

public void sendStream(InputStream is,
                       long readLength)
                throws IOException

Send stream to server.

Parameters:

is - inputStream to send

readLength - max size to send

Throws:

IOException - if any error occur during data send to server

sendStream

public void sendStream(Reader reader,
                       MariaDbCharset charset)
                throws IOException

Send reader stream to server.

Parameters:

reader - reader to send

charset - charset converter

Throws:

IOException - if any error occur during data send to server

sendStream

public void sendStream(Reader reader,
                       long readLength,
                       MariaDbCharset charset)
                throws IOException

Send reader stream to server.

Parameters:

reader - reader to send

readLength - max size to send

charset - charset converter

Throws:

IOException - if any error occur during data send to server

finishPacket

public void finishPacket()
                  throws IOException

Ending command that tell to send buffer to server.

Throws:

IOException - if any connection error occur

write

public void write(byte[] bytes)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(int byteInt)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] bytes,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

checkRewritableLength

public boolean checkRewritableLength(int length)

Check that current buffer + length will not be superior to max_allowed_packet + header size. That permit to separate rewritable queries to be separate in multiple stream.

Parameters:

length - additionnal length

Returns:

true if with this additional length stream can be send in the same stream

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

setMaxAllowedPacket

public void setMaxAllowedPacket(int maxAllowedPacket)

Initialize maximal send size (can be send in multiple stream).

Parameters:

maxAllowedPacket - value of server maxAllowedPacket

assureBufferCapacity

public PacketOutputStream assureBufferCapacity(int len)

Ensure that the buffer remaining size permit to write a data with a size len.

Parameters:

len - size of the data

Returns:

this

writeByte

public PacketOutputStream writeByte(byte theByte)

Write a byte data to buffer.

Parameters:

theByte - byte to write

Returns:

this

writeBytes

public PacketOutputStream writeBytes(byte theByte,
                                     int count)

Write count time the byte value.

Parameters:

theByte - byte to write to buffer

count - number of time the value will be put to buffer

Returns:

this

writeByteArray

public PacketOutputStream writeByteArray(byte[] bytes)

Write byte array to buffer.

Parameters:

bytes - byte array

Returns:

this.

writeByteArrayLength

public PacketOutputStream writeByteArrayLength(byte[] bytes)

Write byte array data to binary data.

Parameters:

bytes - byte array to encode

Returns:

this.

writeString

public PacketOutputStream writeString(String str)

Write string data in binary format.

Parameters:

str - string value to encode

Returns:

this.

writeShort

public PacketOutputStream writeShort(short theShort)

Write short data in binary format.

Parameters:

theShort - short data to encode

Returns:

this

writeInt

public PacketOutputStream writeInt(int theInt)

Write int data in binary format.

Parameters:

theInt - int data

Returns:

this.

writeLong

public PacketOutputStream writeLong(long theLong)

Write long data in binary format.

Parameters:

theLong - long data

Returns:

this

writeFieldLength

public PacketOutputStream writeFieldLength(long length)

Write field length to encode in binary format.

Parameters:

length - data length to encode

Returns:

this.

writeStringLength

public PacketOutputStream writeStringLength(String str)

Write string in binary format.

Parameters:

str - string to encode

Returns:

this.

writeTimestampLength

public PacketOutputStream writeTimestampLength(Calendar calendar,
                                               Timestamp ts,
                                               boolean fractionalSeconds)

Write timestamp in binary format.

Parameters:

calendar - session calendar

ts - timestamp to send

fractionalSeconds - must fractionnal second be send to server

Returns:

this

writeDateLength

public PacketOutputStream writeDateLength(Calendar calendar)

Write date in binary format.

Parameters:

calendar - date

Returns:

this

writeTimeLength

public PacketOutputStream writeTimeLength(Calendar calendar,
                                          boolean fractionalSeconds)

Write time in binary format.

Parameters:

calendar - session calendar.

fractionalSeconds - fractional seconds must be send

Returns:

this