com.github.dm.jrt.channel

Interface OutputConsumer<OUT>

Type Parameters:

OUT - the output data type.

All Known Implementing Classes:

OutputConsumerBuilder, TemplateOutputConsumer

public interface OutputConsumer<OUT>

Interface defining an output consumer that can be bound to an output channel.
The same instance can be safely bound to different output channels.

The typical lifecycle of a consumer object is the following:

     

                           --------
                     |    |        |
                     V    V        |
               ----------------    |
               |  onOutput()  |----
               ----------------
                     |    |
                     |    |
               ------      ------
       |      |                  |      |
       V      V                  V      V
   ----------------          ----------------
   | onComplete() |          |  onError()   |
   ----------------          ----------------
     
 

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

Method Summary

Methods

Modifier and Type	Method and Description
void	onComplete() Called when the channel closes after the invocation completes its execution.
void	onError(RoutineException error) Called when the bounded channel transfer is aborted.
void	onOutput(OUT output) Called when an output is passed to the channel.

Method Detail

onComplete

void onComplete()

Called when the channel closes after the invocation completes its execution.

onError

void onError(@Nullable
           RoutineException error)

Called when the bounded channel transfer is aborted.

Parameters:

error - the reason of the abortion.

onOutput

void onOutput(OUT output)

Called when an output is passed to the channel.

Parameters:

output - the output.