net.lecousin.framework.io

Interface IO.Readable

All Superinterfaces:

AsyncCloseable<IOException>, AutoCloseable, CloseableListenable, IConcurrentCloseable<IOException>, IO

All Known Subinterfaces:

IO.OutputToInput, IO.Readable.Buffered, IO.Readable.Seekable

All Known Implementing Classes:

BufferedIO, BufferedIO.ReadWrite, ByteArrayIO, ByteBuffersIO, EmptyReadable, FileIO.ReadOnly, FileIO.ReadWrite, FragmentedSubIO.Readable, FragmentedSubIO.ReadWrite, IOFromInputStream, IOFromInputStream.KnownSize, IOInMemoryOrFile, LinkedIO.Readable, LinkedIO.Readable.Buffered, LinkedIO.Readable.Buffered.DeterminedSize, LinkedIO.Readable.DeterminedSize, LinkedIO.Readable.Seekable, LinkedIO.Readable.Seekable.Buffered, LinkedIO.Readable.Seekable.Buffered.DeterminedSize, LinkedIO.Readable.Seekable.DeterminedSize, LinkedIO.ReadWrite, MemoryIO, NonBufferedReadableIOAsBuffered, OutputToInput, OutputToInputBuffers, PositionKnownWrapper.Readable, PositionKnownWrapper.Readable.Buffered, PreBufferedReadable, ReadableSeekableToDeterminedSize, ReadableToSeekable, ReadableWithProgress, SimpleBufferedReadable, SingleBufferReadable, SubIO.Readable, SubIO.Readable.Seekable, SubIO.Readable.Seekable.Buffered, SubIO.ReadWrite, TwoBuffersIO, TwoBuffersIO.DeterminedSize

Enclosing interface:

IO

public static interface IO.Readable
extends IO

Add the capability to read forward on an IO.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IO.Readable.Buffered Indicates the IO is buffered, and add operations.
static interface	IO.Readable.Seekable Add read operations to read at a specific position.

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
IAsync<IOException>	canStartReading() Return a synchronization point that is unblocked when data is ready to be read.
default AsyncSupplier<Integer,IOException>	readAsync(ByteBuffer buffer) Equivalent to readAsync(buffer, null).
AsyncSupplier<Integer,IOException>	readAsync(ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone) Asynchronous read operation.
default AsyncSupplier<Integer,IOException>	readFullyAsync(ByteBuffer buffer) Equivalent to readFullyAsync(buffer, null).
AsyncSupplier<Integer,IOException>	readFullyAsync(ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone) Asynchronous read operation to fully fill the given buffer.
int	readFullySync(ByteBuffer buffer) Synchronous read operation to fully fill the given buffer.
int	readSync(ByteBuffer buffer) Read synchronously into the given buffer.
default AsyncSupplier<Long,IOException>	skipAsync(long n) Returns the number of bytes skipped.
AsyncSupplier<Long,IOException>	skipAsync(long n, Consumer<Pair<Long,IOException>> ondone) Returns the number of bytes skipped.
long	skipSync(long n) Returns the number of bytes skipped.

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

canStartReading

IAsync<IOException> canStartReading()

Return a synchronization point that is unblocked when data is ready to be read. This allows to start reading operations only when we know it won't block.

readSync

int readSync(ByteBuffer buffer)
      throws IOException

Read synchronously into the given buffer. The buffer may not be filled, but at least one byte is read. If there is no available byte, this method is blocking.

Parameters:

buffer - buffer to fill

Returns:

the number of bytes read, or 0 or -1 if the end of the IO is reached.

Throws:

IOException

readAsync

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

Asynchronous read operation. The buffer may not be filled, but at least one byte is read. If there is no available byte, the returned AsyncWork won't be unblocked until at least one byte is available, or we know that the end of the IO has been reached.

Parameters:

buffer - buffer to fill

ondone - called before the returned AsyncWork is unblocked and its listeners are called.

Returns:

the Integer contains the number of bytes read, or 0 or -1 if the end of the IO is reached.

readAsync

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

Equivalent to readAsync(buffer, null).

readFullySync

int readFullySync(ByteBuffer buffer)
           throws IOException

Synchronous read operation to fully fill the given buffer. This method does not return until the buffer has been fully filled, or the end of the IO has been reached.

Parameters:

buffer - the buffer to fill

Returns:

the number of bytes read, possibly 0 if the end of the IO has been reached.

Throws:

IOException

readFullyAsync

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

Asynchronous read operation to fully fill the given buffer. The returned AsyncWork is not unblocked until the buffer has been fully filled, or the end of the IO has been reached.

Parameters:

buffer - the buffer to fill

ondone - called before the returned AsyncWork is unblocked and its listeners are called.

Returns:

the Integer contains the number of bytes read, possibly 0 if the end of the IO has been reached.

readFullyAsync

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

Equivalent to readFullyAsync(buffer, null).

skipSync

long skipSync(long n)
       throws IOException

Returns the number of bytes skipped.

Throws:

IOException

skipAsync

AsyncSupplier<Long,IOException> skipAsync(long n,
                                          Consumer<Pair<Long,IOException>> ondone)

Returns the number of bytes skipped.

skipAsync

default AsyncSupplier<Long,IOException> skipAsync(long n)

Returns the number of bytes skipped.