com.github.dm.jrt.channel

Interface Channel.InputChannel<IN>

Type Parameters:

IN - the input data type.

All Superinterfaces:

Channel

All Known Subinterfaces:

InvocationChannel<IN,OUT>, IOChannel<IN,OUT>, ResultChannel<OUT>, StreamingChannel<IN,OUT>

Enclosing interface:

Channel

public static interface Channel.InputChannel<IN>
extends Channel

Interface defining an input channel.

Note that the delivery order of the input 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.InputChannel<IN>	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.
Channel.InputChannel<IN>	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.
Channel.InputChannel<IN>	now() Tells the channel to not delay the transfer of data.
Channel.InputChannel<IN>	orderByCall() Tells the channel to sort the passed input data based on the order of the calls to the pass methods.
Channel.InputChannel<IN>	orderByChance() Tells the channel to avoid sorting the passed input in any particular order.
Channel.InputChannel<IN>	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.
Channel.InputChannel<IN>	pass(Channel.OutputChannel<? extends IN> channel) Passes the data returned by the specified channel to this one.
Channel.InputChannel<IN>	pass(IN... inputs) Passes the specified input data to this channel.
Channel.InputChannel<IN>	pass(IN input) Passes the specified input to this channel.
Channel.InputChannel<IN>	pass(Iterable<? extends IN> inputs) Passes the data returned by the specified iterable to this channel.

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

abort, abort, isEmpty, isOpen

Method Detail

after

@NotNull
Channel.InputChannel<IN> 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.

Parameters:

delay - the delay.

Returns:

this channel.

Throws:

RoutineException - if the execution has been aborted.

IllegalStateException - if this channel is already closed.

after

@NotNull
Channel.InputChannel<IN> 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.

Parameters:

delay - the delay value.

timeUnit - the delay time unit.

Returns:

this channel.

Throws:

RoutineException - if the execution has been aborted.

IllegalArgumentException - if the specified delay is negative.

IllegalStateException - if this channel is already closed.

now

@NotNull
Channel.InputChannel<IN> now()

Tells the channel to not delay the transfer of data.

Returns:

this channel.

Throws:

RoutineException - if the execution has been aborted.

IllegalStateException - if this channel is already closed.

orderByCall

@NotNull
Channel.InputChannel<IN> 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.

Returns:

this channel.

Throws:

RoutineException - if the execution has been aborted.

IllegalStateException - if this channel is already closed.

See Also:

orderByChance(), orderByDelay()

orderByChance

@NotNull
Channel.InputChannel<IN> orderByChance()

Tells the channel to avoid sorting the passed input in any particular order.

This is the default behavior.

Returns:

this channel.

Throws:

RoutineException - if the execution has been aborted.

IllegalStateException - if this channel is already closed.

See Also:

orderByCall(), orderByDelay()

orderByDelay

@NotNull
Channel.InputChannel<IN> 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.

Returns:

this channel.

Throws:

RoutineException - if the execution has been aborted.

IllegalStateException - if this channel is already closed.

See Also:

orderByCall(), orderByChance()

pass

@NotNull
Channel.InputChannel<IN> 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.

Parameters:

channel - the output channel.

Returns:

this channel.

Throws:

RoutineException - if the execution has been aborted.

IllegalStateException - if this channel is already closed.

pass

@NotNull
Channel.InputChannel<IN> pass(@Nullable
                                    Iterable<? extends IN> inputs)

Passes the data returned by the specified iterable to this channel.

Parameters:

inputs - the iterable returning the input data.

Returns:

this channel.

Throws:

RoutineException - if the execution has been aborted.

IllegalStateException - if this channel is already closed.

pass

@NotNull
Channel.InputChannel<IN> pass(@Nullable
                                    IN input)

Passes the specified input to this channel.

Parameters:

input - the input.

Returns:

this channel.

Throws:

RoutineException - if the execution has been aborted.

IllegalStateException - if this channel is already closed.

pass

@NotNull
Channel.InputChannel<IN> pass(@Nullable
                                    IN... inputs)

Passes the specified input data to this channel.

Parameters:

inputs - the input data.

Returns:

this channel.

Throws:

RoutineException - if the execution has been aborted.

IllegalStateException - if this channel is already closed.