com.github.dm.jrt.channel

Interface Channel.OutputChannel<OUT>

Type Parameters:

OUT - the output data type.

All Superinterfaces:

Channel, Iterable<OUT>, Iterator<OUT>

All Known Subinterfaces:

IOChannel<IN,OUT>, StreamingChannel<IN,OUT>

Enclosing interface:

Channel

public static interface Channel.OutputChannel<OUT>
extends Channel, Iterator<OUT>, Iterable<OUT>

Interface defining an output channel, that is the channel used to read the routine invocation output data.

Note that the delivery order of the output data might not be guaranteed.

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.dm.jrt.channel.Channel

Channel.InputChannel<IN>, Channel.OutputChannel<OUT>

Method Summary

Methods

Modifier and Type	Method and Description
Channel.OutputChannel<OUT>	afterMax(long timeout, TimeUnit timeUnit) Tells the channel to wait at the max the specified time duration for the next result to be available.
Channel.OutputChannel<OUT>	afterMax(TimeDuration timeout) Tells the channel to wait at the max the specified time duration for the next result to be available.
List<OUT>	all() Consumes all the results by waiting for the routine to complete at the maximum for the set timeout.
Channel.OutputChannel<OUT>	allInto(Collection<? super OUT> results) Consumes all the results by waiting for the routine to complete at the maximum for the set timeout, and put them into the specified collection.
boolean	checkComplete() Checks if the routine is complete, waiting at the maximum for the set timeout.
Channel.OutputChannel<OUT>	eventuallyAbort() Tells the channel to abort the invocation execution in case no result is available before the timeout has elapsed.
Channel.OutputChannel<OUT>	eventuallyAbort(Throwable reason) Tells the channel to abort the invocation execution in case no result is available before the timeout has elapsed.
Channel.OutputChannel<OUT>	eventuallyExit() Tells the channel to break execution in case no result is available before the timeout has elapsed.
Channel.OutputChannel<OUT>	eventuallyThrow() Tells the channel to throw an ExecutionTimeoutException in case no result is available before the timeout has elapsed.
boolean	hasNext() Checks if more results are available by waiting at the maximum for the set timeout.
Channel.OutputChannel<OUT>	immediately() Tells the channel to not wait for results to be available.
boolean	isBound() Checks if this channel is bound to a consumer or another channel.
OUT	next() Consumes the first available result by waiting at the maximum for the set timeout.
List<OUT>	next(int count) Consumes the first count available results by waiting at the maximum for the set timeout.
<CHANNEL extends Channel.InputChannel<? super OUT>> CHANNEL	passTo(CHANNEL channel) Binds this channel to the specified one.
Channel.OutputChannel<OUT>	passTo(OutputConsumer<? super OUT> consumer) Binds this channel to the specified consumer.
Channel.OutputChannel<OUT>	skip(int count) Skips the first count available results by waiting at the maximum for the set timeout.

Methods inherited from interface com.github.dm.jrt.channel.Channel

abort, abort, isEmpty, isOpen

Methods inherited from interface java.util.Iterator

remove

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

afterMax

@NotNull
Channel.OutputChannel<OUT> afterMax(@NotNull
                                          TimeDuration timeout)

Tells the channel to wait at the max the specified time duration for the next result to be available.

By default the timeout is set to 0 to avoid unexpected deadlocks.

Parameters:

timeout - the maximum timeout.

Returns:

this channel.

afterMax

@NotNull
Channel.OutputChannel<OUT> afterMax(long timeout,
                                          @NotNull
                                          TimeUnit timeUnit)

Tells the channel to wait at the max the specified time duration for the next result to be available.

By default the timeout is set to 0 to avoid unexpected deadlocks.

Parameters:

timeout - the maximum timeout value.

timeUnit - the timeout time unit.

Returns:

this channel.

Throws:

IllegalArgumentException - if the specified timeout is negative.

all

@NotNull
List<OUT> all()

Consumes all the results by waiting for the routine to complete at the maximum for the set timeout.

Returns:

this channel.

Throws:

ExecutionTimeoutException - if the channel is set to throw an exception when the timeout elapses.

RoutineException - if the execution has been aborted.

IllegalStateException - if this channel is already bound to a consumer or another channel.

See Also:

afterMax(TimeDuration), afterMax(long, TimeUnit), immediately(), eventuallyAbort(), eventuallyAbort(Throwable), eventuallyExit(), eventuallyThrow()

allInto

@NotNull
Channel.OutputChannel<OUT> allInto(@NotNull
                                         Collection<? super OUT> results)

Consumes all the results by waiting for the routine to complete at the maximum for the set timeout, and put them into the specified collection.

Parameters:

results - the collection to fill.

Returns:

this channel.

Throws:

ExecutionTimeoutException - if the channel is set to throw an exception when the timeout elapses.

RoutineException - if the execution has been aborted.

IllegalStateException - if this channel is already bound to a consumer or another channel.

See Also:

afterMax(TimeDuration), afterMax(long, TimeUnit), immediately(), eventuallyAbort(), eventuallyAbort(Throwable), eventuallyExit(), eventuallyThrow()

checkComplete

boolean checkComplete()

Checks if the routine is complete, waiting at the maximum for the set timeout.

Returns:

whether the routine execution has complete.

See Also:

afterMax(TimeDuration), afterMax(long, TimeUnit), immediately()

eventuallyAbort

@NotNull
Channel.OutputChannel<OUT> eventuallyAbort()

Tells the channel to abort the invocation execution in case no result is available before the timeout has elapsed.

By default an ExecutionTimeoutException exception will be thrown.

Returns:

this channel.

See Also:

afterMax(TimeDuration), afterMax(long, TimeUnit), immediately(), eventuallyAbort(Throwable), eventuallyExit(), eventuallyThrow()

eventuallyAbort

@NotNull
Channel.OutputChannel<OUT> eventuallyAbort(@Nullable
                                                 Throwable reason)

Tells the channel to abort the invocation execution in case no result is available before the timeout has elapsed.

By default an ExecutionTimeoutException exception will be thrown.

Parameters:

reason - the throwable object identifying the reason of the invocation abortion.

Returns:

this channel.

See Also:

afterMax(TimeDuration), afterMax(long, TimeUnit), immediately(), eventuallyAbort(), eventuallyExit(), eventuallyThrow()

eventuallyExit

@NotNull
Channel.OutputChannel<OUT> eventuallyExit()

Tells the channel to break execution in case no result is available before the timeout has elapsed.

By default an ExecutionTimeoutException exception will be thrown.

Returns:

this channel.

See Also:

afterMax(TimeDuration), afterMax(long, TimeUnit), immediately(), eventuallyAbort(), eventuallyAbort(Throwable), eventuallyThrow()

eventuallyThrow

@NotNull
Channel.OutputChannel<OUT> eventuallyThrow()

Tells the channel to throw an ExecutionTimeoutException in case no result is available before the timeout has elapsed.

This is the default behavior.

Returns:

this channel.

See Also:

afterMax(TimeDuration), afterMax(long, TimeUnit), immediately(), eventuallyAbort(), eventuallyAbort(Throwable), eventuallyExit()

hasNext

boolean hasNext()

Checks if more results are available by waiting at the maximum for the set timeout.

Specified by:

hasNext in interface Iterator<OUT>

Returns:

whether at least one result is available.

Throws:

ExecutionTimeoutException - if the channel is set to throw an exception when the timeout elapses.

RoutineException - if the execution has been aborted.

IllegalStateException - if this channel is already bound to a consumer or another channel.

See Also:

afterMax(TimeDuration), afterMax(long, TimeUnit), immediately(), eventuallyAbort(), eventuallyAbort(Throwable), eventuallyExit(), eventuallyThrow()

next

OUT next()

Consumes the first available result by waiting at the maximum for the set timeout.

Specified by:

next in interface Iterator<OUT>

Returns:

the first available result.

Throws:

ExecutionTimeoutException - if the channel is set to throw an exception when the timeout elapses.

RoutineException - if the execution has been aborted.

IllegalStateException - if this channel is already bound to a consumer or another channel.

NoSuchElementException - if no output is available (it might be thrown also in the case the read timeout elapses and no timeout exception is set to be thrown).

See Also:

afterMax(TimeDuration), afterMax(long, TimeUnit), immediately(), eventuallyAbort(), eventuallyAbort(Throwable), eventuallyExit(), eventuallyThrow()

immediately

@NotNull
Channel.OutputChannel<OUT> immediately()

Tells the channel to not wait for results to be available.

By default the timeout is set to 0 to avoid unexpected deadlocks.

Returns:

this channel.

isBound

boolean isBound()

Checks if this channel is bound to a consumer or another channel.

Returns:

whether the channel is bound.

See Also:

passTo(InputChannel), passTo(OutputConsumer)

next

@NotNull
List<OUT> next(int count)

Consumes the first count available results by waiting at the maximum for the set timeout.

Returns:

the first available results.

Throws:

ExecutionTimeoutException - if the channel is set to throw an exception when the timeout elapses.

RoutineException - if the execution has been aborted.

IllegalStateException - if this channel is already bound to a consumer or another channel.

See Also:

afterMax(TimeDuration), afterMax(long, TimeUnit), immediately(), eventuallyAbort(), eventuallyAbort(Throwable), eventuallyExit(), eventuallyThrow()

passTo

@NotNull
<CHANNEL extends Channel.InputChannel<? super OUT>> CHANNEL passTo(@NotNull
                                                                         CHANNEL channel)

Binds this channel to the specified one. After the call, all the output will be passed only to the specified input channel. Attempting to read through the dedicated methods will cause an IllegalStateException to be thrown.

Type Parameters:

CHANNEL - the input channel type.

Parameters:

channel - the input channel

Returns:

this channel.

Throws:

IllegalStateException - if this channel is already bound.

passTo

@NotNull
Channel.OutputChannel<OUT> passTo(@NotNull
                                        OutputConsumer<? super OUT> consumer)

Binds this channel to the specified consumer. After the call, all the output will be passed only to the consumer. Attempting to read through the dedicated methods will cause an IllegalStateException to be thrown.
Note that the consumer methods will be called on the runner thread.

Parameters:

consumer - the consumer instance.

Returns:

this channel.

Throws:

IllegalStateException - if this channel is already bound.

skip

@NotNull
Channel.OutputChannel<OUT> skip(int count)

Skips the first count available results by waiting at the maximum for the set timeout.

Returns:

the first available results.

Throws:

ExecutionTimeoutException - if the channel is set to throw an exception when the timeout elapses.

RoutineException - if the execution has been aborted.

IllegalStateException - if this channel is already bound to a consumer or another channel.

See Also:

afterMax(TimeDuration), afterMax(long, TimeUnit), immediately(), eventuallyAbort(), eventuallyAbort(Throwable), eventuallyExit(), eventuallyThrow()