org.asteriskjava.fastagi

Interface AgiServer

All Known Implementing Classes:

ConfiguableAGIServer, DefaultAgiServer

public interface AgiServer

Listens for incoming FastAGI connections, reads the inital data and builds an AgiRequest that is then handed over to the appropriate AgiScript for processing.

To pass a call from Asterisk to the AGI server add an extension to your dialplan that makes use of the AGI() application. For example:

 exten => 5551212,1,AGI(agi://192.168.0.2/GetCallerRecord)
 

Before Asterisk-Java returns control to the dialplan it sets the channel variable AJ_AGISTATUS to one of the following values:

• NOT_FOUND if no AGI script had been configured to handle the request.
• SUCCESS if the AGI script was executed successfully.
• FAILED if the AGI script terminated abnormally by throwing an exception or there was an internal error processing it.

If Asterisk-Java was not able to process the request because its thread pool was exhausted the AJ_AGISTATUS variable is not set.

The AJ_AGISTATUS variable complements the AGISTATUS variable that is set by Asterisk to SUCCESS, FAILURE or HANGUP and is available since Asterisk 1.4.

Version:

$Id$

Author:

srt

See Also:

AgiServerThread

Method Summary

Modifier and Type	Method and Description
void	setSocketReadTimeout(int socketReadTimeout) Connection is dropped if it stales on read longer than the timeout.
void	shutdown() Stops this AgiServer.
void	startup() Starts this AgiServer.

Method Detail

startup

void startup()
      throws IOException,
             IllegalStateException

Starts this AgiServer.

After calling startup() this AgiServer is ready to receive requests from Asterisk servers and process them.

Note that this method will not return until the AgiServer has been shut down. If you want to run the AgiServer in the background use wrap it with an AgiServerThread.

Throws:

IOException - if the server socket cannot be bound.

IllegalStateException - if this AgiServer is already running.

shutdown

void shutdown()
       throws IllegalStateException

Stops this AgiServer.

The server socket is closed, new connections are refused and resources are freed. Any running AgiScripts are finish before shutdown completes.

Throws:

IllegalStateException - if this AgiServer is already shut down or has not yet been started.

setSocketReadTimeout

void setSocketReadTimeout(int socketReadTimeout)

Connection is dropped if it stales on read longer than the timeout.

Parameters:

socketReadTimeout - the read timeout value to be used in milliseconds.

Since:

3.0.0

See Also:

Socket.setSoTimeout(int)