MySQL Connector/J 9.2.0 · com.mysql.cj.protocol.x.CompressionSplittedOutputStream

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

Access	Constructor and Description
public	CompressionSplittedOutputStream(OutputStream out, CompressorStreamsFactory ioStreamsFactory)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.FilterOutputStream.close. Implements java.io.Closeable.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	Returns: `true` if the frame header buffer is full, `false` otherwise. isFrameHeaderBuffered() Checks if there is a complete frame header already buffered.
private boolean	Returns: `true` if the frame header was written, `false` otherwise. isFrameHeaderWriteComplete() Checks if the entire frame X Protocol frame header has been fully written.
private boolean	Returns: `true` the payload can be written, `false` otherwise. isPayloadWriteReady() Checks if the X Protocol frame payload is ready to be written on the underlying `OutputStream`.
private boolean	Returns: `true` if the frame currently in progress was fully written, `false` otherwise. isWriteComplete() Checks if current X Protocol frame has been fully written.
private int	Returns: the number of bytes actually buffered. peekFrameHeader(byte[] the data. b, int the start offset in the data. off, int the number of bytes to write. len) Captures the first bytes of each X Protocol frame into a byte buffer.
public void	write(int the `byte`. b) Overrides java.io.FilterOutputStream.write. Forwards the write to `write(byte[], int, int)`;
public void	write(byte[] the data to be written. b) Overrides java.io.FilterOutputStream.write. Forwards the write to `write(byte[], int, int)`;
public void	write(byte[] the data. b, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.FilterOutputStream.write. 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.

Inherited from java.io.FilterOutputStream:: flush

bufferOut	back to summary
private ByteArrayOutputStream bufferOut

closed	back to summary
private boolean closed Hides java.io.FilterOutputStream.closed.

compressionEnabled	back to summary
private boolean compressionEnabled

compressorIoStreamsFactory	back to summary
private CompressorStreamsFactory compressorIoStreamsFactory

compressorOut	back to summary
private OutputStream compressorOut

frameHeader	back to summary
private byte[] frameHeader

frameHeaderBuffered	back to summary
private int frameHeaderBuffered

frameHeaderDumped	back to summary
private int frameHeaderDumped

framePayloadDumped	back to summary
private int framePayloadDumped

framePayloadLength	back to summary
private int framePayloadLength

singleByte	back to summary
private byte[] singleByte

xMessageHeader	back to summary
private XMessageHeader xMessageHeader

CompressionSplittedOutputStream	back to summary
public CompressionSplittedOutputStream(OutputStream out, CompressorStreamsFactory ioStreamsFactory)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.FilterOutputStream.close. Implements java.io.Closeable.close. Closes this stream. Annotations @Override Exceptions IOException: Doc from java.io.FilterOutputStream.close. if an I/O error occurs. See Also `FilterOutputStream#close()`

public void close() throws IOException

Overrides java.io.FilterOutputStream.close.

Implements java.io.Closeable.close.

Closes this stream.

Annotations

@Override

Exceptions

IOException:

Doc from java.io.FilterOutputStream.close.

if an I/O error occurs.

See Also

FilterOutputStream#close()

ensureOpen back to summary

ensureOpen	back to summary
private void ensureOpen() throws IOException Ensures that this `OutputStream` wasn't closed yet. Exceptions IOException: if this `OutputStream` was closed.

private void ensureOpen() throws IOException

Ensures that this OutputStream wasn't closed yet.

Exceptions

IOException:: if this OutputStream was closed.

finalizeWrite back to summary

finalizeWrite	back to summary
private void finalizeWrite() throws 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`. Exceptions IOException: if any of the underlying I/O operations fail.

private void finalizeWrite() throws 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.

Exceptions

IOException:: if any of the underlying I/O operations fail.

isFrameHeaderBuffered back to summary

isFrameHeaderBuffered	back to summary
private boolean isFrameHeaderBuffered() Checks if there is a complete frame header already buffered. Returns:boolean `true` if the frame header buffer is full, `false` otherwise.

private boolean isFrameHeaderBuffered()

Checks if there is a complete frame header already buffered.

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

isFrameHeaderWriteComplete back to summary

isFrameHeaderWriteComplete	back to summary
private boolean isFrameHeaderWriteComplete() Checks if the entire frame X Protocol frame header has been fully written. Returns:boolean `true` if the frame header was written, `false` otherwise.

private boolean isFrameHeaderWriteComplete()

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

Returns:boolean: true if the frame header was written, false otherwise.

isPayloadWriteReady back to summary

isPayloadWriteReady	back to summary
private boolean isPayloadWriteReady() Checks if the X Protocol frame payload is ready to be written on the underlying `OutputStream`. Returns:boolean `true` the payload can be written, `false` otherwise.

private boolean isPayloadWriteReady()

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

Returns:boolean: true the payload can be written, false otherwise.

isWriteComplete back to summary

isWriteComplete	back to summary
private boolean isWriteComplete() Checks if current X Protocol frame has been fully written. Returns:boolean `true` if the frame currently in progress was fully written, `false` otherwise.

private boolean isWriteComplete()

Checks if current X Protocol frame has been fully written.

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

peekFrameHeader	back to summary
private int peekFrameHeader(byte[] b, int off, int len) Captures the first bytes of each X Protocol frame into a byte buffer. Parameters b:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Returns:int the number of bytes actually buffered.

peekFrameHeader

back to summary

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

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

Parameters

b:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Returns:int

the number of bytes actually buffered.

write back to summary

write	back to summary
public void write(int b) throws IOException Overrides java.io.FilterOutputStream.write. Forwards the write to `write(byte[], int, int)`; Parameters b:int Doc from java.io.FilterOutputStream.write. the `byte`. Annotations @Override Exceptions IOException: Doc from java.io.FilterOutputStream.write. if an I/O error occurs. See Also `FilterOutputStream#write(int)`

public void write(int b) throws IOException

Overrides java.io.FilterOutputStream.write.

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

Parameters

b:int

Doc from java.io.FilterOutputStream.write.

the byte.

Annotations

@Override

Exceptions

IOException:

Doc from java.io.FilterOutputStream.write.

if an I/O error occurs.

See Also

FilterOutputStream#write(int)

write back to summary

write	back to summary
public void write(byte[] b) throws IOException Overrides java.io.FilterOutputStream.write. Forwards the write to `write(byte[], int, int)`; Parameters b:byte[] Doc from java.io.FilterOutputStream.write. the data to be written. Annotations @Override Exceptions IOException: Doc from java.io.FilterOutputStream.write. if an I/O error occurs. See Also `FilterOutputStream#write(byte[])`

public void write(byte[] b) throws IOException

Overrides java.io.FilterOutputStream.write.

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

Parameters

b:byte[]

Doc from java.io.FilterOutputStream.write.

the data to be written.

Annotations

@Override

Exceptions

IOException:

Doc from java.io.FilterOutputStream.write.

if an I/O error occurs.

See Also

FilterOutputStream#write(byte[])

write back to summary

write	back to summary
public void write(byte[] b, int off, int len) throws IOException Overrides java.io.FilterOutputStream.write. 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. Parameters b:byte[] Doc from java.io.FilterOutputStream.write. the data. off:int Doc from java.io.FilterOutputStream.write. the start offset in the data. len:int Doc from java.io.FilterOutputStream.write. the number of bytes to write. Annotations @Override Exceptions IOException: Doc from java.io.FilterOutputStream.write. if an I/O error occurs. See Also `java.io.FilterOutputStream#write(int)`

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

Overrides java.io.FilterOutputStream.write.

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.

Parameters

b:byte[]

Doc from java.io.FilterOutputStream.write.

the data.

off:int

Doc from java.io.FilterOutputStream.write.

the start offset in the data.

len:int