Package com.clickhouse.client.stream

Class BlockingPipedOutputStream

java.lang.Object

java.io.OutputStream

com.clickhouse.client.ClickHouseOutputStream

com.clickhouse.client.ClickHousePipedOutputStream

com.clickhouse.client.stream.BlockingPipedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class BlockingPipedOutputStream
extends ClickHousePipedOutputStream

A combination of PipedOutputStream and PipedInputStream for streaming data between server and client. To avoid dead lock and high memory usage, please make sure writer and reader are on two separate threads.

Field Summary

Fields

Modifier and Type	Field	Description
protected BlockingQueue<ByteBuffer>	queue

Fields inherited from class com.clickhouse.client.ClickHouseOutputStream

closed, ERROR_INCOMPLETE_READ, ERROR_NULL_BYTES, ERROR_REUSE_BUFFER, ERROR_STREAM_CLOSED, file, postCloseAction

Constructor Summary

Constructors

Constructor	Description
BlockingPipedOutputStream(int bufferSize, int queueLength, int timeout, Runnable postCloseAction)

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
ClickHouseInputStream	getInputStream(Runnable postCloseAction)	Gets input stream to reada data being written into the output stream.
ClickHouseOutputStream	transferBytes(byte[] bytes, int offset, int length)	Transfers the given bytes into output stream, without creating a copy as in ClickHouseOutputStream.writeBytes(byte[], int, int).
ClickHouseOutputStream	writeByte(byte b)	Writes a single byte into output stream.
ClickHouseOutputStream	writeBytes(byte[] bytes, int offset, int length)	Writes copy of given bytes into output stream.
ClickHouseOutputStream	writeCustom(ClickHouseDataUpdater writer)	Writes bytes using custom writer.

Methods inherited from class com.clickhouse.client.ClickHousePipedOutputStream

getInput, getInputStream

Methods inherited from class com.clickhouse.client.ClickHouseOutputStream

empty, ensureOpen, getUnderlyingFile, isClosed, of, of, of, of, transferBytes, transferBytes, write, write, write, writeAsciiString, writeBuffer, writeBytes, writeBytes, writeString, writeUnicodeString, writeUnsignedVarInt, writeVarInt

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Field Detail

queue

protected final BlockingQueue<ByteBuffer> queue

Constructor Detail

BlockingPipedOutputStream

public BlockingPipedOutputStream(int bufferSize,
                                 int queueLength,
                                 int timeout,
                                 Runnable postCloseAction)

Method Detail

getInputStream

public ClickHouseInputStream getInputStream(Runnable postCloseAction)

Description copied from class: ClickHousePipedOutputStream

Gets input stream to reada data being written into the output stream.

Specified by:

getInputStream in class ClickHousePipedOutputStream

Parameters:

postCloseAction - custom action will be performed right after closing the input stream

Returns:

non-null input stream

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class ClickHouseOutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

transferBytes

public ClickHouseOutputStream transferBytes(byte[] bytes,
                                            int offset,
                                            int length)
                                     throws IOException

Description copied from class: ClickHouseOutputStream

Transfers the given bytes into output stream, without creating a copy as in ClickHouseOutputStream.writeBytes(byte[], int, int).

Specified by:

transferBytes in class ClickHouseOutputStream

Parameters:

bytes - non-null byte array

offset - offset of the byte array

length - bytes to write

Returns:

current output stream

Throws:

IOException - when failed to write value into output stream, not able to sent all bytes, or opereate on a closed stream

writeByte

public ClickHouseOutputStream writeByte(byte b)
                                 throws IOException

Description copied from class: ClickHouseOutputStream

Writes a single byte into output stream.

Specified by:

writeByte in class ClickHouseOutputStream

Parameters:

b - byte to write

Returns:

current output stream

Throws:

IOException - when failed to write value into output stream, not able to sent all bytes, or opereate on a closed stream

writeBytes

public ClickHouseOutputStream writeBytes(byte[] bytes,
                                         int offset,
                                         int length)
                                  throws IOException

Description copied from class: ClickHouseOutputStream

Writes copy of given bytes into output stream.

Specified by:

writeBytes in class ClickHouseOutputStream

Parameters:

bytes - non-null byte array

offset - offset of the byte array

length - bytes to write

Returns:

current output stream

Throws:

IOException - when failed to write value into output stream, not able to sent all bytes, or opereate on a closed stream

writeCustom

public ClickHouseOutputStream writeCustom(ClickHouseDataUpdater writer)
                                   throws IOException

Description copied from class: ClickHouseOutputStream

Writes bytes using custom writer.

Specified by:

writeCustom in class ClickHouseOutputStream

Parameters:

writer - non-null data writer

Returns:

current output stream

Throws:

IOException - when failed to write value into output stream, not able to sent all bytes, or opereate on a closed stream