net.lecousin.framework.io

Class SubIO.Writable

java.lang.Object

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

net.lecousin.framework.io.SubIO

net.lecousin.framework.io.SubIO.Writable

All Implemented Interfaces:

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

Enclosing class:

SubIO

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

Sub-part of a Writable IO.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubIO.Writable.Seekable Sub-part of a Seekable Writable 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.Writable

IO.Writable.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
Writable(IO.Writable src, long start, long size, String description, boolean closeSrcOnClose) Constructor.

Method Summary

Modifier and Type	Method and Description
IAsync<IOException>	canStartWriting() Return a synchronization point that is unblocked when data is ready to be written.
AsyncSupplier<Integer,IOException>	writeAsync(ByteBuffer buffer, Consumer<Pair<Integer,IOException>> ondone) Write asynchronously all bytes available in the given buffer at the current position.
int	writeSync(ByteBuffer buffer) Write synchronously all bytes available in the given buffer at the current position.

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

canStartReading, closeResources, closeUnderlyingResources, getPosition, getPriority, getSizeAsync, getSizeSync, getSourceDescription, getTaskManager, getWrappedIO, readAsync, readAsync, readFullyAsync, readFullyAsync, readFullySync, readFullySync, readSync, readSync, seekAsync, seekSync, setPriority, writeAsync, 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.Writable

writeAsync

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

Writable

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

Constructor.

Method Detail

canStartWriting

public IAsync<IOException> canStartWriting()

Description copied from interface: IO.Writable

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

Specified by:

canStartWriting in interface IO.Writable

Overrides:

canStartWriting in class SubIO

writeSync

public int writeSync(ByteBuffer buffer)
              throws IOException

Description copied from interface: IO.Writable

Write synchronously all bytes available in the given buffer at the current position. If not all bytes can be written, an error must be thrown. Return the number of bytes written.

Specified by:

writeSync in interface IO.Writable

Overrides:

writeSync in class SubIO

Throws:

IOException

writeAsync

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

Description copied from interface: IO.Writable

Write asynchronously all bytes available in the given buffer at the current position. If not all bytes can be written, an error must be returned. Return the number of bytes written.

Specified by:

writeAsync in interface IO.Writable

Overrides:

writeAsync in class SubIO