org.asteriskjava.live
Interface AsteriskQueue

public interface AsteriskQueue

An Asterisk ACD queue.

Version:

$Id: AsteriskQueue.java 835 2007-07-08 08:39:32Z srt $

Author:

srt

Method Summary

void	addAsteriskQueueListener(AsteriskQueueListener listener) Registers a new queue listener.
java.util.List<AsteriskChannel>	getEntries() Returns the list of channels currently waiting in this queue.
java.lang.Integer	getMax() Returns the maximum number of people allowed to wait in this queue or 0 for unlimited.
java.lang.String	getName() Returns the name of this queue as defined in Asterisk's queues.conf.
java.lang.Integer	getServiceLevel() Returns the service level (in seconds) as defined by the servicelevel setting in queues.conf.
java.lang.String	getStrategy() Returns the strategy used for this queue.
java.lang.Integer	getWeight() Returns the weight of this queue.
void	removeAsteriskQueueListener(AsteriskQueueListener listener) Removes a previously registered queue listener.

Method Detail

getName

java.lang.String getName()

Returns the name of this queue as defined in Asterisk's queues.conf.

Returns:

the name of this queue.

getMax

java.lang.Integer getMax()

Returns the maximum number of people allowed to wait in this queue or 0 for unlimited.

Corresponds to the maxlen option in Asterisk's queues.conf.

Returns:

the maximum number of people allowed to wait in this queue.

getStrategy

java.lang.String getStrategy()

Returns the strategy used for this queue.

Possible values are:

• ringall
• roundrobin
• leastrecent
• fewestcalls
• random
• rrmemory

Available since Asterisk 1.6

Returns:

the strategy used for this queue.

Since:

1.0.0

getServiceLevel

java.lang.Integer getServiceLevel()

Returns the service level (in seconds) as defined by the servicelevel setting in queues.conf.

Returns:

the service level (in seconds).

getWeight

java.lang.Integer getWeight()

Returns the weight of this queue.

A queue can be assigned a 'weight' to ensure calls waiting in a higher priority queue will deliver its calls first. Only delays the lower weight queue's call if the member is also in the higher weight queue.

Available since Asterisk 1.2

Returns:

the weight of this queue or null if not supported by your version of Asterisk.

getEntries

java.util.List<AsteriskChannel> getEntries()

Returns the list of channels currently waiting in this queue.

Returns:

the list of channels currently waiting in this queue.

addAsteriskQueueListener

void addAsteriskQueueListener(AsteriskQueueListener listener)

Registers a new queue listener.

Parameters:

listener - the listener to add.

Since:

0.3

removeAsteriskQueueListener

void removeAsteriskQueueListener(AsteriskQueueListener listener)

Removes a previously registered queue listener.

Parameters:

listener - the listener to remove.

Since:

0.3