net.lecousin.framework.io

Class SubIO.Readable

java.lang.Object

net.lecousin.framework.util.ConcurrentCloseable<IOException>

net.lecousin.framework.io.SubIO

net.lecousin.framework.io.SubIO.Readable

All Implemented Interfaces:

AutoCloseable, IO, IO.KnownSize, IO.PositionKnown, IO.Readable, AsyncCloseable<IOException>, CloseableListenable, IConcurrentCloseable<IOException>

Enclosing class:

SubIO

public static class SubIO.Readable
extends SubIO
implements IO.Readable

Sub-part of a Readable IO.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubIO.Readable.Seekable Sub-part of a Seekable Readable IO.

Nested classes/interfaces inherited from class net.lecousin.framework.io.SubIO

SubIO.Readable, SubIO.ReadWrite, SubIO.Writable

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

IO.Readable.Buffered

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

Field Summary

Fields inherited from class net.lecousin.framework.io.SubIO

closeContainer, description, io, pos, size, start

Constructor Summary

Constructors

Constructor and Description
Readable(IO.Readable src, long size, String description, boolean closeSrcOnClose) Constructor.

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.
AsyncSupplier<Integer,IOException>	readAsync(ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone) Asynchronous read operation.
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.
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 class net.lecousin.framework.io.SubIO

canStartWriting, closeResources, closeUnderlyingResources, getPosition, getPriority, getSizeAsync, getSizeSync, getSourceDescription, getTaskManager, getWrappedIO, readAsync, readFullyAsync, readFullySync, readSync, seekAsync, seekSync, setPriority, writeAsync, writeAsync, writeSync, writeSync

Methods inherited from class net.lecousin.framework.util.ConcurrentCloseable

addCloseListener, addCloseListener, close, closeAsync, isClosed, isClosing, lockClose, operation, operation, removeCloseListener, removeCloseListener, unlockClose

Methods inherited from class java.lang.Object

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

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

readAsync, readFullyAsync, skipAsync

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

Constructor Detail

Readable

public Readable(IO.Readable src,
                long size,
                String description,
                boolean closeSrcOnClose)

Constructor.

Method Detail

canStartReading

public IAsync<IOException> canStartReading()

Description copied from interface: IO.Readable

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.

Specified by:

canStartReading in interface IO.Readable

Overrides:

canStartReading in class SubIO

readSync

public int readSync(ByteBuffer buffer)
             throws IOException

Description copied from interface: IO.Readable

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.

Specified by:

readSync in interface IO.Readable

Overrides:

readSync in class SubIO

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

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

Description copied from interface: IO.Readable

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.

Specified by:

readAsync in interface IO.Readable

Overrides:

readAsync in class SubIO

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.

readFullySync

public int readFullySync(ByteBuffer buffer)
                  throws IOException

Description copied from interface: IO.Readable

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.

Specified by:

readFullySync in interface IO.Readable

Overrides:

readFullySync in class SubIO

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

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

Description copied from interface: IO.Readable

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.

Specified by:

readFullyAsync in interface IO.Readable

Overrides:

readFullyAsync in class SubIO

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.

skipSync

public long skipSync(long n)
              throws IOException

Description copied from interface: IO.Readable

Returns the number of bytes skipped.

Specified by:

skipSync in interface IO.Readable

Throws:

IOException

skipAsync

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

Description copied from interface: IO.Readable

Returns the number of bytes skipped.

Specified by:

skipAsync in interface IO.Readable