com.github.dm.jrt.channel

Interface Channel

All Known Subinterfaces:

Channel.InputChannel<IN>, Channel.OutputChannel<OUT>, InvocationChannel<IN,OUT>, IOChannel<IN,OUT>, ResultChannel<OUT>, StreamingChannel<IN,OUT>

public interface Channel

Interface defining the basic communication channel with the routine invocation.

Channel instances are used to transfer data to and from the code executed inside the routine invocation.

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Channel.InputChannel<IN> Interface defining an input channel.
static interface	Channel.OutputChannel<OUT> Interface defining an output channel, that is the channel used to read the routine invocation output data.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	abort() Closes the channel and abort the transfer of data, thus aborting the routine invocation.
boolean	abort(Throwable reason) Closes the channel and abort the transfer of data, thus aborting the routine invocation and causing the specified throwable to be passed as the abortion reason. The throwable, unless it extends the base RoutineException, will be wrapped as the cause of an AbortException instance.
boolean	isEmpty() Checks if the channel is empty, that is, no data is stored in it.
boolean	isOpen() Checks if the channel is open, that is, more data are expected to be passed to it.

Method Detail

abort

boolean abort()

Closes the channel and abort the transfer of data, thus aborting the routine invocation.

An instance of AbortException will be passed as the abortion reason.

Note that, in case the channel was already closed, the call to this method has no effect.

Returns:

whether the channel status changed as a result of the call.

abort

boolean abort(@Nullable
            Throwable reason)

Closes the channel and abort the transfer of data, thus aborting the routine invocation and causing the specified throwable to be passed as the abortion reason.
The throwable, unless it extends the base RoutineException, will be wrapped as the cause of an AbortException instance.

Note that, in case the channel was already closed, the call to this method has no effect.

Parameters:

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

Returns:

whether the channel status changed as a result of the call.

isEmpty

boolean isEmpty()

Checks if the channel is empty, that is, no data is stored in it.

Returns:

whether the channel is empty.

isOpen

boolean isOpen()

Checks if the channel is open, that is, more data are expected to be passed to it.

Returns:

whether the channel is open.