org.jvoicexml.callmanager

Interface Terminal

public interface Terminal

Terminals are object that are waiting for incoming connections. Once a connection to a terminal is established the interpreter is called using the configured URI.

The term terminal is chosen as a tribute to JTAPI.

A terminal is responsible to accept incoming connections and to close the connection once the user hangs up or if application terminates. Other functionality, like streaming of audio to the phone should be handled by the corresponding implementation of a Telephony implementation (if present) or by the SpokenInput or SynthesizedOutput implementations. It may happen that the Telephony needs resources from the terminal to fulfill its job. In that case it is advisable to store a reference to the terminal in a custom implementation of a ConnectionInformation. The ConnectionInformation will be passed as an argument to the RemoteConnectable.connect(org.jvoicexml.ConnectionInformation) calls, once the resource is needed.

Since:

0.7

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Retrieves the name of a terminal.
void	stopWaiting() Stops waiting for incoming connections.
void	waitForConnections() Starts waiting for incoming connections.

Method Detail

getName

java.lang.String getName()

Retrieves the name of a terminal.

Returns:

name of the terminal

waitForConnections

void waitForConnections()
                 throws java.io.IOException

Starts waiting for incoming connections. This method is expected to run asynchronously.

This method is called if the CallManager starts up.

Throws:

java.io.IOException - error waiting for connections.

stopWaiting

void stopWaiting()

Stops waiting for incoming connections.