de.unkrig.commons.util.concurrent

Class ByteStreamSequentializer

java.lang.Object

de.unkrig.commons.util.concurrent.ByteStreamSequentializer

public class ByteStreamSequentializer
extends java.lang.Object

Executes multiple tasks asynchronously, but forwards their output to a delegate OutputStream in the order the tasks were submitted, i.e. the last byte of output of one task appears before the output of all subsequently submitted tasks.

Constructor Summary

Constructors

Constructor and Description
ByteStreamSequentializer(java.io.OutputStream delegate, java.util.concurrent.ExecutorService squadExecutor)

Method Summary

Modifier and Type	Method and Description
void	awaitCompletion() Returns when all tasks that were previously submitted with submit(Consumer) and submit(ConsumerWhichThrows) have completed.
void	submit(Consumer<? super java.io.OutputStream> task) Data written to the task's subject will be written to the delegate after all data written by the previously submitted tasks, and before the data written by all tasks submitted afterwards.
<EX extends java.lang.Throwable> void	submit(ConsumerWhichThrows<? super java.io.OutputStream,EX> task)

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteStreamSequentializer

public ByteStreamSequentializer(java.io.OutputStream delegate,
                                java.util.concurrent.ExecutorService squadExecutor)

See Also:

ByteStreamSequentializer

Method Detail

submit

public void submit(Consumer<? super java.io.OutputStream> task)

Data written to the task's subject will be written to the delegate after all data written by the previously submitted tasks, and before the data written by all tasks submitted afterwards.

Notice that when a tasks submits another task (subtask), then the output of the subtask will appear after the output of the task (and the output of all other tasks submitted in the meantime). If you want to have the output of subtasks to be in the middle of the task's output, then you should create a second ByteStreamSequentializer and await its completion.

submit

public <EX extends java.lang.Throwable> void submit(ConsumerWhichThrows<? super java.io.OutputStream,EX> task)

See Also:

submit(Consumer)

awaitCompletion

public void awaitCompletion()
                     throws java.lang.InterruptedException,
                            java.util.concurrent.ExecutionException,
                            java.util.concurrent.CancellationException,
                            java.io.IOException

Returns when all tasks that were previously submitted with submit(Consumer) and submit(ConsumerWhichThrows) have completed.

Throws:

java.util.concurrent.CancellationException - One of the tasks was cancelled

java.util.concurrent.ExecutionException - One of the tasks threw an exception

java.lang.InterruptedException - The current thread was interrupted while waiting

java.io.IOException