org.asteriskjava.fastagi

Class AbstractAgiServer

java.lang.Object

org.asteriskjava.fastagi.AbstractAgiServer

Direct Known Subclasses:

AsyncAgiServer, DefaultAgiServer

public abstract class AbstractAgiServer
extends Object

Abstract base class for FastAGI and AsyncAGI servers.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
AbstractAgiServer()
AbstractAgiServer(AgiChannelFactory agiChannelFactory) Creates a new AbstractAgiServer with the given channel factory.

Method Summary

Modifier and Type	Method and Description
protected ThreadPoolExecutor	createPool() Creates a new ThreadPoolExecutor to serve the AGI requests.
protected void	execute(Runnable command) Execute the runnable using the configured ThreadPoolExecutor obtained from getPool().
protected void	finalize()
protected AgiChannelFactory	getAgiChannelFactory() Returns the AgiChannelFactory to use for creating new AgiChannel instances.
protected MappingStrategy	getMappingStrategy()
int	getMaximumPoolSize() Returns the maximum number of worker threads in the thread pool.
int	getPoolActiveTaskCount() Returns the approximate number of AgiConnectionHandler threads that are actively executing tasks.
int	getPoolActiveThreadCount()
int	getPoolSize() Returns the default number of worker threads in the thread pool.
protected void	handleException(String message, Exception e)
protected boolean	isDie()
void	setMappingStrategy(MappingStrategy mappingStrategy) Sets the strategy to use for mapping AgiRequests to AgiScripts that serve them.
void	setMaximumPoolSize(int maximumPoolSize) Sets the maximum number of worker threads in the thread pool.
void	setPoolSize(int poolSize) Sets the default number of worker threads in the thread pool.
protected void	shutdown()

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAgiServer

public AbstractAgiServer()

AbstractAgiServer

public AbstractAgiServer(AgiChannelFactory agiChannelFactory)

Creates a new AbstractAgiServer with the given channel factory.

Parameters:

agiChannelFactory - the AgiChannelFactory to use for creating new AgiChannel instances.

Since:

1.0.0

Method Detail

getAgiChannelFactory

protected AgiChannelFactory getAgiChannelFactory()

Returns the AgiChannelFactory to use for creating new AgiChannel instances.

Returns:

the AgiChannelFactory to use for creating new AgiChannel instances.

getPoolSize

public int getPoolSize()

Returns the default number of worker threads in the thread pool.

Returns:

the default number of worker threads in the thread pool.

Since:

1.0.0

setPoolSize

public void setPoolSize(int poolSize)

Sets the default number of worker threads in the thread pool.
This is the number of threads that are available even if they are idle.
The default pool size is 10.

Parameters:

poolSize - the size of the worker thread pool.

Throws:

IllegalArgumentException - if the new pool size is negative

See Also:

ThreadPoolExecutor.setCorePoolSize(int)

getMaximumPoolSize

public int getMaximumPoolSize()

Returns the maximum number of worker threads in the thread pool.

Returns:

the maximum number of worker threads in the thread pool.

Since:

1.0.0

setMaximumPoolSize

public void setMaximumPoolSize(int maximumPoolSize)

Sets the maximum number of worker threads in the thread pool.
This equals the maximum number of concurrent requests this AgiServer can serve.
The default maximum pool size is 100.

Parameters:

maximumPoolSize - the maximum size of the worker thread pool.

Throws:

IllegalArgumentException - if maximumPoolSize is less than current pool size or less than or equal to 0.

See Also:

ThreadPoolExecutor.setMaximumPoolSize(int)

setMappingStrategy

public void setMappingStrategy(MappingStrategy mappingStrategy)

Sets the strategy to use for mapping AgiRequests to AgiScripts that serve them.

Parameters:

mappingStrategy - the mapping strategy to use.

getMappingStrategy

protected MappingStrategy getMappingStrategy()

isDie

protected boolean isDie()

shutdown

protected void shutdown()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

execute

protected void execute(Runnable command)
                throws RejectedExecutionException

Execute the runnable using the configured ThreadPoolExecutor obtained from getPool().

Parameters:

command - the command to run.

Throws:

RejectedExecutionException - if the runnable can't be executed

handleException

protected void handleException(String message,
                               Exception e)

getPoolActiveTaskCount

public int getPoolActiveTaskCount()

Returns the approximate number of AgiConnectionHandler threads that are actively executing tasks.

See Also:

ThreadPoolExecutor.getActiveCount(), getPoolActiveThreadCount(), AgiConnectionHandler.AGI_CONNECTION_HANDLERS

getPoolActiveThreadCount

public int getPoolActiveThreadCount()

createPool

protected ThreadPoolExecutor createPool()

Creates a new ThreadPoolExecutor to serve the AGI requests. The nature of this pool defines how many concurrent requests can be handled. The default implementation returns a dynamic thread pool defined by the poolSize and maximumPoolSize properties.

You can override this method to change this behavior. For example you can use a cached pool with

 return Executors.newCachedThreadPool(new DaemonThreadFactory());
 

Returns:

the ThreadPoolExecutor to use for serving AGI requests.

See Also:

setPoolSize(int), setMaximumPoolSize(int)