Package io.deephaven.io.streams

Interface ByteBufferSink

All Known Subinterfaces:

CurrentByteBufferSink

All Known Implementing Classes:

CurrentByteBufferSink.Adapter, LogEntryImpl, LogOutputBaseImpl, LogOutputCsvImpl, NullByteBufferSink, SimpleByteBufferSink

public interface ByteBufferSink

Method Summary

Modifier and Type	Method	Description
java.nio.ByteBuffer	acceptBuffer(java.nio.ByteBuffer b, int need)	Dispose of the contents of the buffer b, probably by writing them to a channel, and return a new buffer in which writing can continue.
void	close(java.nio.ByteBuffer b)	Dispose of the contents of the final buffer in an output sequence, probably by writing them to a channel.

Method Detail

acceptBuffer

java.nio.ByteBuffer acceptBuffer(java.nio.ByteBuffer b,
                                 int need)
                          throws java.io.IOException

Dispose of the contents of the buffer b, probably by writing them to a channel, and return a new buffer in which writing can continue. The returned buffer must have at least need bytes of space remaining. The return value may be the same buffer, as long as it's remaining() value has been increased to be >= need.

Parameters:

b - the buffer whose contents need to be disposed of.

Returns:

the buffer in which further output should be written.

Throws:

java.io.IOException

close

void close(java.nio.ByteBuffer b)
    throws java.io.IOException

Dispose of the contents of the final buffer in an output sequence, probably by writing them to a channel. Note that the argument buffer may be empty. Then do whatever it takes to release the resources of the sink, probably by closing a channel.

Throws:

java.io.IOException