net.lecousin.framework.io.util

Class BroadcastIO

java.lang.Object

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

net.lecousin.framework.io.util.BroadcastIO

All Implemented Interfaces:

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

public class BroadcastIO
extends ConcurrentCloseable<IOException>
implements IO.Writable

Aggregation of several IOs, every write is performed on all IOs.

Nested Class Summary

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

Constructor Summary

Constructors

Constructor and Description
BroadcastIO(IO.Writable[] ios, byte priority, boolean closeIOs) 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.
protected void	closeResources(Async<IOException> ondone)
protected IAsync<IOException>	closeUnderlyingResources()
byte	getPriority() Return the priority.
String	getSourceDescription() Describe the IO, which can be used for logging or debugging purposes.
TaskManager	getTaskManager() Return the TaskManager used for asynchronous operations.
IO	getWrappedIO() If this IO is wrapping another one (such as adding Buffered capabilities), this method returns it, or null if it does not wrap another IO.
void	setPriority(byte priority) Set the priority of asynchronous operations.
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.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

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

BroadcastIO

public BroadcastIO(IO.Writable[] ios,
                   byte priority,
                   boolean closeIOs)

Constructor.

Method Detail

getPriority

public byte getPriority()

Description copied from class: ConcurrentCloseable

Return the priority.

Specified by:

getPriority in interface IO

Specified by:

getPriority in class ConcurrentCloseable<IOException>

setPriority

public void setPriority(byte priority)

Description copied from interface: IO

Set the priority of asynchronous operations.

Specified by:

setPriority in interface IO

getTaskManager

public TaskManager getTaskManager()

Description copied from interface: IO

Return the TaskManager used for asynchronous operations.

Specified by:

getTaskManager in interface IO

getSourceDescription

public String getSourceDescription()

Description copied from interface: IO

Describe the IO, which can be used for logging or debugging purposes.

Specified by:

getSourceDescription in interface IO

getWrappedIO

public IO getWrappedIO()

Description copied from interface: IO

If this IO is wrapping another one (such as adding Buffered capabilities), this method returns it, or null if it does not wrap another IO.

Specified by:

getWrappedIO in interface IO

closeUnderlyingResources

protected IAsync<IOException> closeUnderlyingResources()

Specified by:

closeUnderlyingResources in class ConcurrentCloseable<IOException>

closeResources

protected void closeResources(Async<IOException> ondone)

Specified by:

closeResources in class ConcurrentCloseable<IOException>

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

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

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