net.lecousin.framework.io

Interface IO.OutputToInput

All Superinterfaces:

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

All Known Implementing Classes:

OutputToInput, OutputToInputBuffers

Enclosing interface:

IO

public static interface IO.OutputToInput
extends IO.Readable, IO.Writable

An OutputToInput is an IO on which a producer is writing, and a consumer is reading.
The producer receive it as a Writable, and the consumer as a Readable.
Both can work concurrently: as soon as data is written by the producer, it can be read by the consumer.
The producer must call the method endOfData or signalErrorBeforeEndOfData, so the consumer can receive the information it reaches the end of the IO.
The implementations may add additional capabilities such as Readable.Seekable if it keeps the data.

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.Writable

IO.Writable.Buffered, IO.Writable.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
void	endOfData() Signal that no more data will be written by the producer.
long	getAvailableDataSize() If available, return the size.
boolean	isFullDataAvailable() Return true if endOfData has been already called.
void	signalErrorBeforeEndOfData(IOException error) Signal that no more data will be written by the producer because of an error.

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.Writable

canStartWriting, writeAsync, writeAsync, writeSync

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

endOfData

void endOfData()

Signal that no more data will be written by the producer.

signalErrorBeforeEndOfData

void signalErrorBeforeEndOfData(IOException error)

Signal that no more data will be written by the producer because of an error.

isFullDataAvailable

boolean isFullDataAvailable()

Return true if endOfData has been already called.

getAvailableDataSize

long getAvailableDataSize()

If available, return the size. A negative value means no size available.