IOChannel (Javadoc

Type Parameters:
IN - the input data type.
OUT - the output data type.

All Superinterfaces:

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

All Known Subinterfaces:

StreamingChannel<IN,OUT>
```
public interface IOChannel<IN,OUT>
extends Channel.InputChannel<IN>, Channel.OutputChannel<OUT>
```
Interface defining a channel which is both an input and an output.
An I/O channel is useful to make other asynchronous tasks communicate with a routine.
The channel output can be passed to a routine input channel in order to feed it with data coming asynchronously from other sources. Note however that, in any case, the close() method must be called in order to correctly terminate the invocation lifecycle.
Created by davide-maestroni on 09/24/2015.

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
`IOChannel<IN,OUT>`	`after(long delay, TimeUnit timeUnit)` Tells the channel to delay the transfer of data of the specified time duration. Note that an abortion command will be delayed as well.
`IOChannel<IN,OUT>`	`after(TimeDuration delay)` Tells the channel to delay the transfer of data of the specified time duration. Note that an abortion command will be delayed as well.
`IOChannel<IN,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.
`IOChannel<IN,OUT>`	`afterMax(TimeDuration timeout)` Tells the channel to wait at the max the specified time duration for the next result to be available.
`IOChannel<IN,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.
`Channel.InputChannel<IN>`	`asInput()` Returns this channel as an input one.
`Channel.OutputChannel<OUT>`	`asOutput()` Returns this channel as an output one.
`IOChannel<IN,OUT>`	`close()` Closes the channel input. If the channel is already closed, this method has no effect.
`IOChannel<IN,OUT>`	`eventuallyAbort()` Tells the channel to abort the invocation execution in case no result is available before the timeout has elapsed.
`IOChannel<IN,OUT>`	`eventuallyAbort(Throwable reason)` Tells the channel to abort the invocation execution in case no result is available before the timeout has elapsed.
`IOChannel<IN,OUT>`	`eventuallyExit()` Tells the channel to break execution in case no result is available before the timeout has elapsed.
`IOChannel<IN,OUT>`	`eventuallyThrow()` Tells the channel to throw an `ExecutionTimeoutException` in case no result is available before the timeout has elapsed.
`IOChannel<IN,OUT>`	`immediately()` Tells the channel to not wait for results to be available.
`IOChannel<IN,OUT>`	`now()` Tells the channel to not delay the transfer of data.
`IOChannel<IN,OUT>`	`orderByCall()` Tells the channel to sort the passed input data based on the order of the calls to the pass methods.
`IOChannel<IN,OUT>`	`orderByChance()` Tells the channel to avoid sorting the passed input in any particular order.
`IOChannel<IN,OUT>`	`orderByDelay()` Tells the channel to sort the passed input data based on the specific delay. Note that only the inputs passed with a 0 delay will be delivered in the same order as they are passed to the channel, while the others will be delivered as soon as the dedicated runner handles the specific execution.
`IOChannel<IN,OUT>`	`pass(Channel.OutputChannel<? extends IN> channel)` Passes the data returned by the specified channel to this one.
`IOChannel<IN,OUT>`	`pass(IN... inputs)` Passes the specified input data to this channel.
`IOChannel<IN,OUT>`	`pass(IN input)` Passes the specified input to this channel.
`IOChannel<IN,OUT>`	`pass(Iterable<? extends IN> inputs)` Passes the data returned by the specified iterable to this channel.
`IOChannel<IN,OUT>`	`passTo(OutputConsumer<? super OUT> consumer)` Binds this channel to the specified consumer.
`IOChannel<IN,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.OutputChannel
all, checkComplete, hasNext, isBound, next, next, passTo

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
  - after
```
@NotNull
IOChannel<IN,OUT> after(@NotNull
                              TimeDuration delay)
```
    Tells the channel to delay the transfer of data of the specified time duration.
    Note that an abortion command will be delayed as well. Note, however, that a delayed abortion will not prevent the invocation from completing, as input data do.
    
    Specified by:
    
    after in interface Channel.InputChannel<IN>
    
    Parameters:
    delay - the delay.
    
    Returns:
    this channel.
  - after
```
@NotNull
IOChannel<IN,OUT> after(long delay,
                              @NotNull
                              TimeUnit timeUnit)
```
    Tells the channel to delay the transfer of data of the specified time duration.
    Note that an abortion command will be delayed as well. Note, however, that a delayed abortion will not prevent the invocation from completing, as input data do.
    
    Specified by:
    
    after in interface Channel.InputChannel<IN>
    
    Parameters:
    delay - the delay value.
    timeUnit - the delay time unit.
    
    Returns:
    this channel.
  - now
```
@NotNull
IOChannel<IN,OUT> now()
```
    Tells the channel to not delay the transfer of data.
    
    Specified by:
    
    now in interface Channel.InputChannel<IN>
    
    Returns:
    this channel.
  - orderByCall
```
@NotNull
IOChannel<IN,OUT> orderByCall()
```
    Tells the channel to sort the passed input data based on the order of the calls to the pass methods.
    By default no particular order is applied.
    
    Specified by:
    
    orderByCall in interface Channel.InputChannel<IN>
    
    Returns:
    this channel.
    See Also:
    Channel.InputChannel.orderByChance(), Channel.InputChannel.orderByDelay()
  - orderByChance
```
@NotNull
IOChannel<IN,OUT> orderByChance()
```
    Tells the channel to avoid sorting the passed input in any particular order.
    This is the default behavior.
    
    Specified by:
    
    orderByChance in interface Channel.InputChannel<IN>
    
    Returns:
    this channel.
    See Also:
    Channel.InputChannel.orderByCall(), Channel.InputChannel.orderByDelay()
  - orderByDelay
```
@NotNull
IOChannel<IN,OUT> orderByDelay()
```
    Tells the channel to sort the passed input data based on the specific delay.
    Note that only the inputs passed with a 0 delay will be delivered in the same order as they are passed to the channel, while the others will be delivered as soon as the dedicated runner handles the specific execution.
    By default no particular order is applied.
    
    Specified by:
    
    orderByDelay in interface Channel.InputChannel<IN>
    
    Returns:
    this channel.
    See Also:
    Channel.InputChannel.orderByCall(), Channel.InputChannel.orderByChance()
  - pass
```
@NotNull
IOChannel<IN,OUT> pass(@Nullable
                             Channel.OutputChannel<? extends IN> channel)
```
    Passes the data returned by the specified channel to this one.
    Note that the output channel will be bound as a result of the call, thus effectively preventing any other consumer from getting data from it.
    
    Specified by:
    
    pass in interface Channel.InputChannel<IN>
    
    Parameters:
    channel - the output channel.
    
    Returns:
    this channel.
  - pass
```
@NotNull
IOChannel<IN,OUT> pass(@Nullable
                             Iterable<? extends IN> inputs)
```
    Passes the data returned by the specified iterable to this channel.
    
    Specified by:
    
    pass in interface Channel.InputChannel<IN>
    
    Parameters:
    inputs - the iterable returning the input data.
    
    Returns:
    this channel.
  - pass
```
@NotNull
IOChannel<IN,OUT> pass(@Nullable
                             IN input)
```
    Passes the specified input to this channel.
    
    Specified by:
    
    pass in interface Channel.InputChannel<IN>
    
    Parameters:
    input - the input.
    
    Returns:
    this channel.
  - pass
```
@NotNull
IOChannel<IN,OUT> pass(@Nullable
                             IN... inputs)
```
    Passes the specified input data to this channel.
    
    Specified by:
    
    pass in interface Channel.InputChannel<IN>
    
    Parameters:
    inputs - the input data.
    
    Returns:
    this channel.
  - afterMax
```
@NotNull
IOChannel<IN,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.
    
    Specified by:
    
    afterMax in interface Channel.OutputChannel<OUT>
    
    Parameters:
    timeout - the maximum timeout.
    
    Returns:
    this channel.
  - afterMax
```
@NotNull
IOChannel<IN,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.
    
    Specified by:
    
    afterMax in interface Channel.OutputChannel<OUT>
    
    Parameters:
    timeout - the maximum timeout value.
    timeUnit - the timeout time unit.
    
    Returns:
    this channel.
  - allInto
```
@NotNull
IOChannel<IN,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.
    
    Specified by:
    
    allInto in interface Channel.OutputChannel<OUT>
    
    Parameters:
    results - the collection to fill.
    
    Returns:
    this channel.
    See Also:
    Channel.OutputChannel.afterMax(TimeDuration), Channel.OutputChannel.afterMax(long, TimeUnit), Channel.OutputChannel.immediately(), Channel.OutputChannel.eventuallyAbort(), Channel.OutputChannel.eventuallyAbort(Throwable), Channel.OutputChannel.eventuallyExit(), Channel.OutputChannel.eventuallyThrow()
  - eventuallyAbort
```
@NotNull
IOChannel<IN,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.
    
    Specified by:
    
    eventuallyAbort in interface Channel.OutputChannel<OUT>
    
    Returns:
    this channel.
    See Also:
    Channel.OutputChannel.afterMax(TimeDuration), Channel.OutputChannel.afterMax(long, TimeUnit), Channel.OutputChannel.immediately(), Channel.OutputChannel.eventuallyAbort(Throwable), Channel.OutputChannel.eventuallyExit(), Channel.OutputChannel.eventuallyThrow()
  - eventuallyAbort
```
@NotNull
IOChannel<IN,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.
    
    Specified by:
    
    eventuallyAbort in interface Channel.OutputChannel<OUT>
    
    Parameters:
    reason - the throwable object identifying the reason of the invocation abortion.
    
    Returns:
    this channel.
    See Also:
    Channel.OutputChannel.afterMax(TimeDuration), Channel.OutputChannel.afterMax(long, TimeUnit), Channel.OutputChannel.immediately(), Channel.OutputChannel.eventuallyAbort(), Channel.OutputChannel.eventuallyExit(), Channel.OutputChannel.eventuallyThrow()
  - eventuallyExit
```
@NotNull
IOChannel<IN,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.
    
    Specified by:
    
    eventuallyExit in interface Channel.OutputChannel<OUT>
    
    Returns:
    this channel.
    See Also:
    Channel.OutputChannel.afterMax(TimeDuration), Channel.OutputChannel.afterMax(long, TimeUnit), Channel.OutputChannel.immediately(), Channel.OutputChannel.eventuallyAbort(), Channel.OutputChannel.eventuallyAbort(Throwable), Channel.OutputChannel.eventuallyThrow()
  - eventuallyThrow
```
@NotNull
IOChannel<IN,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.
    
    Specified by:
    
    eventuallyThrow in interface Channel.OutputChannel<OUT>
    
    Returns:
    this channel.
    See Also:
    Channel.OutputChannel.afterMax(TimeDuration), Channel.OutputChannel.afterMax(long, TimeUnit), Channel.OutputChannel.immediately(), Channel.OutputChannel.eventuallyAbort(), Channel.OutputChannel.eventuallyAbort(Throwable), Channel.OutputChannel.eventuallyExit()
  - immediately
```
@NotNull
IOChannel<IN,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.
    
    Specified by:
    
    immediately in interface Channel.OutputChannel<OUT>
    
    Returns:
    this channel.
  - passTo
```
@NotNull
IOChannel<IN,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.
    
    Specified by:
    
    passTo in interface Channel.OutputChannel<OUT>
    
    Parameters:
    consumer - the consumer instance.
    
    Returns:
    this channel.
  - skip
```
@NotNull
IOChannel<IN,OUT> skip(int count)
```
    Skips the first count available results by waiting at the maximum for the set timeout.
    
    Specified by:
    
    skip in interface Channel.OutputChannel<OUT>
    
    Returns:
    the first available results.
    See Also:
    Channel.OutputChannel.afterMax(TimeDuration), Channel.OutputChannel.afterMax(long, TimeUnit), Channel.OutputChannel.immediately(), Channel.OutputChannel.eventuallyAbort(), Channel.OutputChannel.eventuallyAbort(Throwable), Channel.OutputChannel.eventuallyExit(), Channel.OutputChannel.eventuallyThrow()
  - asInput
```
@NotNull
Channel.InputChannel<IN> asInput()
```
    Returns this channel as an input one.
    
    Returns:
    this channel.
  - asOutput
```
@NotNull
Channel.OutputChannel<OUT> asOutput()
```
    Returns this channel as an output one.
    
    Returns:
    this channel.
  - close
```
@NotNull
IOChannel<IN,OUT> close()
```
    Closes the channel input.
    If the channel is already closed, this method has no effect.
    Note that this method must be always called when done with the channel.
    
    Returns:
    this channel.

Interface IOChannel<IN,OUT>

Nested Class Summary

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

Method Summary

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

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

Methods inherited from interface java.util.Iterator

Methods inherited from interface java.lang.Iterable

Method Detail

after

after

now

orderByCall

orderByChance

orderByDelay

pass

pass

pass

pass

afterMax

afterMax

allInto

eventuallyAbort

eventuallyAbort

eventuallyExit

eventuallyThrow

immediately

passTo

skip

asInput

asOutput

close