net.lecousin.framework.io

Interface IO.Writable

All Superinterfaces:

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

All Known Subinterfaces:

IO.OutputToInput, IO.Writable.Buffered, IO.Writable.Seekable

All Known Implementing Classes:

BroadcastIO, BufferedIO.ReadWrite, ByteArrayIO, ByteBuffersIO, FileIO.ReadWrite, FileIO.WriteOnly, FragmentedSubIO.ReadWrite, IOFromOutputStream, IOInMemoryOrFile, LinkedIO.ReadWrite, MemoryIO, OutputToInput, OutputToInputBuffers, SimpleBufferedWritable, SubIO.ReadWrite, SubIO.Writable, SubIO.Writable.Seekable

Enclosing interface:

IO

public static interface IO.Writable
extends IO, IO.WriterAsync

Add the capability to write forward on an IO.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IO.Writable.Buffered Add a flush operation to force writing on the underlying IO.
static interface	IO.Writable.Seekable Add operations to write 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>	canStartWriting() Return a synchronization point that is unblocked when data is ready to be written.
default AsyncSupplier<Integer,IOException>	writeAsync(ByteBuffer buffer) Equivalent to writeAsync(buffer, null).
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 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

canStartWriting

IAsync<IOException> canStartWriting()

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.

writeSync

int writeSync(ByteBuffer buffer)
       throws IOException

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.

Throws:

IOException

writeAsync

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

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.

writeAsync

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

Equivalent to writeAsync(buffer, null).

Specified by:

writeAsync in interface IO.WriterAsync