com.mysql.cj.protocol.x

Class CompressionSplittedOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.mysql.cj.protocol.x.CompressionSplittedOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class CompressionSplittedOutputStream
extends java.io.FilterOutputStream

An OutputStream wrapper that analyzes X Protocol frames and routes them directly to the original underlying OutputStream or passes them through to a compressor-able OutputStream to compresses the frame, rebuilds it and then sends a newly compressed X Protocol frame, depending on defined data size threshold.

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.ByteArrayOutputStream	bufferOut
private boolean	closed
private boolean	compressionEnabled
private CompressorStreamsFactory	compressorIoStreamsFactory
private java.io.OutputStream	compressorOut
private byte[]	frameHeader
private int	frameHeaderBuffered
private int	frameHeaderDumped
private int	framePayloadDumped
private int	framePayloadLength
private byte[]	singleByte
private XMessageHeader	xMessageHeader

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
CompressionSplittedOutputStream(java.io.OutputStream out, CompressorStreamsFactory ioStreamsFactory)

Method Summary

Modifier and Type	Method and Description
void	close() Closes this stream.
private void	ensureOpen() Ensures that this OutputStream wasn't closed yet.
private void	finalizeWrite() Finalizes the writing of the compressed OutputStream, if one is currently in use, by flushing it into a temporary buffer and reassembling the original X Protocol frame into a compressed one.
private boolean	isFrameHeaderBuffered() Checks if there is a complete frame header already buffered.
private boolean	isFrameHeaderWriteComplete() Checks if the entire frame X Protocol frame header has been fully written.
private boolean	isPayloadWriteReady() Checks if the X Protocol frame payload is ready to be written on the underlying OutputStream.
private boolean	isWriteComplete() Checks if current X Protocol frame has been fully written.
private int	peekFrameHeader(byte[] b, int off, int len) Captures the first bytes of each X Protocol frame into a byte buffer.
void	write(byte[] b) Forwards the write to write(byte[], int, int);
void	write(byte[] b, int off, int len) Analyzes the given bytes as an X Protocol frame and, depending on its size, writes it as-is in the underlying OutputStream or rebuilds it as a compressed X Protocol packet.
void	write(int b) Forwards the write to write(byte[], int, int);

Methods inherited from class java.io.FilterOutputStream

flush

Methods inherited from class java.lang.Object

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

Field Detail

compressorIoStreamsFactory

private CompressorStreamsFactory compressorIoStreamsFactory

frameHeader

private byte[] frameHeader

frameHeaderBuffered

private int frameHeaderBuffered

frameHeaderDumped

private int frameHeaderDumped

framePayloadLength

private int framePayloadLength

framePayloadDumped

private int framePayloadDumped

xMessageHeader

private XMessageHeader xMessageHeader

compressionEnabled

private boolean compressionEnabled

bufferOut

private java.io.ByteArrayOutputStream bufferOut

compressorOut

private java.io.OutputStream compressorOut

singleByte

private byte[] singleByte

closed

private boolean closed

Constructor Detail

CompressionSplittedOutputStream

public CompressionSplittedOutputStream(java.io.OutputStream out,
                                       CompressorStreamsFactory ioStreamsFactory)

Method Detail

close

public void close()
           throws java.io.IOException

Closes this stream.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.FilterOutputStream

Throws:

java.io.IOException

See Also:

FilterOutputStream.close()

write

public void write(int b)
           throws java.io.IOException

Forwards the write to write(byte[], int, int);

Overrides:

write in class java.io.FilterOutputStream

Throws:

java.io.IOException

See Also:

FilterOutputStream.write(int)

write

public void write(byte[] b)
           throws java.io.IOException

Forwards the write to write(byte[], int, int);

Overrides:

write in class java.io.FilterOutputStream

Throws:

java.io.IOException

See Also:

FilterOutputStream.write(byte[])

write

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

Analyzes the given bytes as an X Protocol frame and, depending on its size, writes it as-is in the underlying OutputStream or rebuilds it as a compressed X Protocol packet.

Overrides:

write in class java.io.FilterOutputStream

Throws:

java.io.IOException

See Also:

FilterOutputStream.write(int)

peekFrameHeader

private int peekFrameHeader(byte[] b,
                            int off,
                            int len)

Captures the first bytes of each X Protocol frame into a byte buffer.

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

Returns:

the number of bytes actually buffered.

isFrameHeaderBuffered

private boolean isFrameHeaderBuffered()

Checks if there is a complete frame header already buffered.

Returns:

true if the frame header buffer is full, false otherwise.

isFrameHeaderWriteComplete

private boolean isFrameHeaderWriteComplete()

Checks if the entire frame X Protocol frame header has been fully written.

Returns:

true if the frame header was written, false otherwise.

isPayloadWriteReady

private boolean isPayloadWriteReady()

Checks if the X Protocol frame payload is ready to be written on the underlying OutputStream.

Returns:

true the payload can be written, false otherwise.

isWriteComplete

private boolean isWriteComplete()

Checks if current X Protocol frame has been fully written.

Returns:

true if the frame currently in progress was fully written, false otherwise.

finalizeWrite

private void finalizeWrite()
                    throws java.io.IOException

Finalizes the writing of the compressed OutputStream, if one is currently in use, by flushing it into a temporary buffer and reassembling the original X Protocol frame into a compressed one. Finally, writes the entire compressed frame into the underlying OutputStream.

Throws:

java.io.IOException - if any of the underlying I/O operations fail.

ensureOpen

private void ensureOpen()
                 throws java.io.IOException

Ensures that this OutputStream wasn't closed yet.

Throws:

java.io.IOException - if this OutputStream was closed.