net.lecousin.framework.io

Interface IO.Readable.Buffered

All Superinterfaces:

AsyncCloseable<IOException>, AutoCloseable, CloseableListenable, IConcurrentCloseable<IOException>, IO, IO.Readable, IO.ReadableByteStream

All Known Implementing Classes:

BufferedIO, BufferedIO.ReadWrite, ByteArrayIO, ByteBuffersIO, EmptyReadable, LinkedIO.Readable.Buffered, LinkedIO.Readable.Buffered.DeterminedSize, LinkedIO.Readable.Seekable.Buffered, LinkedIO.Readable.Seekable.Buffered.DeterminedSize, MemoryIO, NonBufferedReadableIOAsBuffered, OutputToInputBuffers, PositionKnownWrapper.Readable.Buffered, PreBufferedReadable, ReadableToSeekable, SimpleBufferedReadable, SingleBufferReadable, SubIO.Readable.Seekable.Buffered, TwoBuffersIO, TwoBuffersIO.DeterminedSize

Enclosing interface:

IO.Readable

public static interface IO.Readable.Buffered
extends IO.Readable, IO.ReadableByteStream

Indicates the IO is buffered, and add operations.

Nested Class Summary

Nested classes/interfaces inherited from interface net.lecousin.framework.io.IO.Readable

IO.Readable.Buffered, IO.Readable.Seekable

Nested classes/interfaces inherited from interface net.lecousin.framework.io.IO

IO.KnownSize, IO.OperationType, IO.OutputToInput, IO.PositionKnown, IO.Readable, IO.ReadableByteStream, IO.Resizable, IO.Writable, IO.WritableByteStream, IO.WriterAsync

Nested classes/interfaces inherited from interface net.lecousin.framework.util.CloseableListenable

CloseableListenable.Impl

Method Summary

Modifier and Type	Method and Description
int	readAsync() Read a single byte if possible.
default AsyncSupplier<Integer,IOException>	readFullySyncIfPossible(ByteBuffer buffer) While readAsync methods are supposed to do the job in a separate thread, this method fills the given buffer synchronously if enough data is already buffered, else it finishes asynchronously.
AsyncSupplier<Integer,IOException>	readFullySyncIfPossible(ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone) While readAsync methods are supposed to do the job in a separate thread, this method fills the given buffer synchronously if enough data is already buffered, else it finishes asynchronously.
ByteBuffer	readNextBuffer() Retrieve a buffer of bytes in the most efficient way depending on the implementation of Buffered. Its returns the immediately available bytes with a minimum of operations.
default AsyncSupplier<ByteBuffer,IOException>	readNextBufferAsync() Equivalent to readNextBufferAsync(null).
AsyncSupplier<ByteBuffer,IOException>	readNextBufferAsync(Consumer<Pair<ByteBuffer,IOException>> ondone) Retrieve a buffer of bytes in the most efficient way depending on the implementation of Buffered. This method is similar to readAsync, it reads some bytes that are immediately available with a minimum of operations.

Methods inherited from interface net.lecousin.framework.io.IO.Readable

canStartReading, readAsync, readAsync, readFullyAsync, readFullyAsync, readFullySync, readSync, skipAsync, skipAsync, skipSync

Methods inherited from interface net.lecousin.framework.io.IO.ReadableByteStream

canStartReading, read, read, readByte, readFully, skip

Methods inherited from interface net.lecousin.framework.io.IO

cancelClosed, error, errorCancelled, getPriority, getSourceDescription, getTaskManager, getWrappedIO, setPriority

Methods inherited from interface net.lecousin.framework.util.IConcurrentCloseable

lockClose, unlockClose

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface net.lecousin.framework.util.AsyncCloseable

closeAfter, closeAsync

Methods inherited from interface net.lecousin.framework.util.CloseableListenable

addCloseListener, addCloseListener, close, isClosed, removeCloseListener, removeCloseListener

Method Detail

readNextBufferAsync

AsyncSupplier<ByteBuffer,IOException> readNextBufferAsync(Consumer<Pair<ByteBuffer,IOException>> ondone)

Retrieve a buffer of bytes in the most efficient way depending on the implementation of Buffered.
This method is similar to readAsync, it reads some bytes that are immediately available with a minimum of operations. The problem with readAsync is that we have to give a buffer to fill. If there are more bytes that can be read, a new call will be needed. If there not enough available bytes, the given buffer is not fully filled and uses more memory than needed.
This method is more efficient because it leaves the implementation allocating a buffer with a size that can be fully filled in a minimum number of operations.
In addition, using readAsync needs to keep the given buffer in a variable or in the closure, while using this method the buffer is directly given as the result of the operation.
The returned buffer is ready to be read (no need to flip), and the number of bytes read can be obtain using the method remaining of the buffer.

readNextBufferAsync

default AsyncSupplier<ByteBuffer,IOException> readNextBufferAsync()

Equivalent to readNextBufferAsync(null).

readNextBuffer

ByteBuffer readNextBuffer()
                   throws IOException

Retrieve a buffer of bytes in the most efficient way depending on the implementation of Buffered.
Its returns the immediately available bytes with a minimum of operations.

Throws:

IOException

readAsync

int readAsync()
       throws IOException

Read a single byte if possible.

Returns:

the next byte, or -1 if the end of the IO has been reached, or -2 if no more byte is available.

Throws:

IOException

readFullySyncIfPossible

AsyncSupplier<Integer,IOException> readFullySyncIfPossible(ByteBuffer buffer,
                                                           Consumer<Pair<Integer,IOException>> ondone)

While readAsync methods are supposed to do the job in a separate thread, this method fills the given buffer synchronously if enough data is already buffered, else it finishes asynchronously. The caller can check the returned AsyncWork by calling its method isUnblocked to know if the read has been performed synchronously. This method may be useful for processes that hope to work synchronously because this IO is buffered, but support also to work asynchronously without blocking a thread.

readFullySyncIfPossible

default AsyncSupplier<Integer,IOException> readFullySyncIfPossible(ByteBuffer buffer)

While readAsync methods are supposed to do the job in a separate thread, this method fills the given buffer synchronously if enough data is already buffered, else it finishes asynchronously. The caller can check the returned AsyncWork by calling its method isUnblocked to know if the read has been performed synchronously. This method may be useful for processes that hope to work synchronously because this IO is buffered, but support also to work asynchronously without blocking a thread.