com.github.dm.jrt.channel

Interface InvocationChannel<IN,OUT>

Type Parameters:

IN - the input data type.

OUT - the output data type.

All Superinterfaces:

Channel, Channel.InputChannel<IN>

public interface InvocationChannel<IN,OUT>
extends Channel.InputChannel<IN>

Interface defining an invocation input channel, that is the channel used to pass input data to the routine invocation.

Created by davide-maestroni on 09/15/2014.

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

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

abort, abort, isEmpty, isOpen

Method Detail

after

@NotNull
InvocationChannel<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
InvocationChannel<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
InvocationChannel<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
InvocationChannel<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
InvocationChannel<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
InvocationChannel<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
InvocationChannel<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
InvocationChannel<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
InvocationChannel<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
InvocationChannel<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.

result

@NotNull
Channel.OutputChannel<OUT> result()

Closes the input channel and returns the output one.

Returns:

the routine output channel.

Throws:

IllegalStateException - if this method has been already called.