com.nuecho.rivr.core.channel

Interface DialogueChannel<I extends InputTurn,O extends OutputTurn>

Type Parameters:

O - type of OutputTurn

I - type of InputTurn

All Known Subinterfaces:

VoiceXmlDialogueChannel

All Known Implementing Classes:

SynchronousDialogueChannel, TestDialogueChannel, VoiceXmlTestDialogueChannel

public interface DialogueChannel<I extends InputTurn,O extends OutputTurn>

Core concept of Rivr, a DialogueChannel is the interface between the Dialogue and the controller (such as the DialogueServlet).

The dialogue produces OutputTurns and sends them to the controller via the doTurn(OutputTurn, Duration) method. The DialogueChannel will return the response from the controller as an InputTurn.

Note: The DialogueChannel is typically wrapped in DialogueContext.

Method Summary

Modifier and Type	Method and Description
void	addListener(DialogueChannelListener<I,O> listener) Adds a listener to this dialogue channel.
I	doTurn(O outputTurn, Duration timeout) Performs a turn exchange: the dialogue channel will return the InputTurn
void	removeListener(DialogueChannelListener<I,O> listener) Removes a listener from this dialogue channel.

Method Detail

doTurn

I doTurn(O outputTurn,
         Duration timeout)
  throws Timeout,
         InterruptedException

Performs a turn exchange: the dialogue channel will return the InputTurn

Parameters:

outputTurn - The output turn to send. Cannot be null.

timeout - maximum time allowed to receive the turn from the dialogue. If null, uses the default value of this dialogue channel. A value of Duration.ZERO (or equivalent) means to wait forever.

Returns:

the received InputTurn. Cannot be null.

Throws:

Timeout - if the dialogue channel has not been able to give the InputTurn before timeout parameter.

InterruptedException - if the thread has been interrupted while waiting for the result.

addListener

void addListener(DialogueChannelListener<I,O> listener)

Adds a listener to this dialogue channel.

Parameters:

listener - the listener to add.

removeListener

void removeListener(DialogueChannelListener<I,O> listener)

Removes a listener from this dialogue channel.

Parameters:

listener - the listener to remove.