man TrunkGroup () - Trunk 'groups' provide keydata configuration information that apply to a group of trunk ports represented under a common 'group' identity. Trunk group configuration.

NAME

TrunkGroup - Trunk 'groups' provide keydata configuration information that apply to a group of trunk ports represented under a common 'group' identity. Trunk group configuration.

SYNOPSIS



#include <bayonne.h>

Inherits CallStat.

Public Member Functions

TrunkGroup (char *name=NULL)

Create a trunk group data key from the bayonne.conf file. const char * getName (void)

Get the name of this trunk group. unsigned getAnswer (void)

Get the number of rings before answering. bool getAccept (void)

Get the accepting state option for this trunk. bool getDetect (void)

Get dialtone detect state for the trunk. timeout_t getCallerid (void)

Get the number of milliseconds for active caller id. timeout_t getPickup (void)

Get pickup gaurd time for this trunk group. const char * chkRequest (void)

Get handling for trunk group 'pending requests'. seltype_t getSelect (void)

Get a trunk group port selection method. unsigned getThreashold (void)

Get trunk threashold for requests to be posted. unsigned getAnalysis (void)

Get call progress analysis timeout for dialing. timeout_t getReady (void)

Get ready timer for trunk before handling requests when idle. timeout_t getIdleTime (void)

Get the initial idle timer for this group. unsigned getSiezeTime (void)

Get the trunk seizure timer for dialtone detect. unsigned getRingTime (void)

Get the time delay of each ring. unsigned getMinDigits (void)

Get call progress minimum digits. unsigned getMDigTimeOut (void)

Get call progress time out to get more digits. timeout_t getHangup (void)

Get disconnect gaurd time before answering. timeout_t getFlash (void)

Get default hook flash time for this trunk group. timeout_t getDialtone (void)

Get dialtone wait time for this trunk group. timeout_t getDialspeed (void)

Get dialing speed in milliseconds. const char * getNumber (void)

Get the telephone number associated with this trunk group if one is associated with it. const char * getSchedule (char *buf)

Get the name of the script to 'schedule' for this group. const char * getRedirect (const char *redirect, char *buf)

Get the name of the script to 'schedule' for a given call redirection mode for this group. void incCapacity (void)

Used when mapping trunk groups to activated trunks. Request * getRequest (void)

Get the next active request pending for this group. TrunkGroup * getNext (void)

Get next group record.

Friends

const char * getGroups (void)

void cancel (TrunkGroup *group, const char *tag)

Request * locate (TrunkGroup *group, const char *tag, int *pos=NULL)

TrunkGroup * getGroup (const char *name=NULL)

Find a named trunk group.

Detailed Description

Trunk 'groups' provide keydata configuration information that apply to a group of trunk ports represented under a common 'group' identity. Trunk group configuration.

These are initially given a [trunks] section for default group values followed by a specific entry. The [server] groups key lists the active trunk groups. A special default group is also created.

Author: David Sugar <dyfet@ostel.com>

Constructor & Destructor Documentation

TrunkGroup::TrunkGroup (char * name = NULL)

Create a trunk group data key from the bayonne.conf file.

Parameters: name of trunk group to load.

Member Function Documentation

const char* TrunkGroup::chkRequest (void) [inline]

Get handling for trunk group 'pending requests'.

Returns: symbol or timer value.

bool TrunkGroup::getAccept (void)

Get the accepting state option for this trunk.

Returns: true if should accept.

unsigned TrunkGroup::getAnalysis (void) [inline]

Get call progress analysis timeout for dialing.

Returns: timeout in seconds.

unsigned TrunkGroup::getAnswer (void) [inline]

Get the number of rings before answering.

Returns: number of rings to answer.

timeout_t TrunkGroup::getCallerid (void) [inline]

Get the number of milliseconds for active caller id.

Returns: number of milliseconds of caller id.

bool TrunkGroup::getDetect (void)

Get dialtone detect state for the trunk.

Returns: true if dialtone detect should be enabled.

timeout_t TrunkGroup::getDialspeed (void) [inline]

Get dialing speed in milliseconds.

Returns: dialspeed in milliseconds.

timeout_t TrunkGroup::getDialtone (void) [inline]

Get dialtone wait time for this trunk group.

Returns: dialtone wait time in milliseconds.

timeout_t TrunkGroup::getFlash (void) [inline]

Get default hook flash time for this trunk group.

Returns: hookflash time in milliseconds.

timeout_t TrunkGroup::getHangup (void) [inline]

Get disconnect gaurd time before answering.

Returns: gaurd time in milliseconds.

timeout_t TrunkGroup::getIdleTime (void) [inline]

Get the initial idle timer for this group.

Returns: idle time initial.

unsigned TrunkGroup::getMDigTimeOut (void) [inline]

Get call progress time out to get more digits.

Returns: Timeout in seconds

unsigned TrunkGroup::getMinDigits (void) [inline]

Get call progress minimum digits.

Returns: number of digits (only for dialogic drivers).

const char* TrunkGroup::getName (void) [inline]

Get the name of this trunk group.

Returns: name of trunk group.

TrunkGroup* TrunkGroup::getNext (void) [inline]

Get next group record.

Returns: next group link.

const char* TrunkGroup::getNumber (void)

Get the telephone number associated with this trunk group if one is associated with it.

Returns: telephone number if known.

timeout_t TrunkGroup::getPickup (void) [inline]

Get pickup gaurd time for this trunk group.

Returns: number of milliseconds for call pickup.

timeout_t TrunkGroup::getReady (void) [inline]

Get ready timer for trunk before handling requests when idle.

Returns: ready timer in milliseconds.

const char* TrunkGroup::getRedirect (const char * redirect, char * buf)

Get the name of the script to 'schedule' for a given call redirection mode for this group.

If no redirect option is found, then getSchedule is invoked.

Returns: name of scheduled script.

Parameters: redirect identifer.

buffer to copy schedule information into.

Request* TrunkGroup::getRequest (void)

Get the next active request pending for this group.

Returns: next request queued or NULL.

unsigned TrunkGroup::getRingTime (void) [inline]

Get the time delay of each ring.

Returns: ring time between rings.

const char* TrunkGroup::getSchedule (char * buf)

Get the name of the script to 'schedule' for this group.

Returns: name of scheduled script.

Parameters: buffer to copy schedule information into.

seltype_t TrunkGroup::getSelect (void)

Get a trunk group port selection method.

Returns: select method.

unsigned TrunkGroup::getSiezeTime (void) [inline]

Get the trunk seizure timer for dialtone detect.

Returns: siezure time for dialtone.

unsigned TrunkGroup::getThreashold (void) [inline]

Get trunk threashold for requests to be posted.

Returns: threashold.

void TrunkGroup::incCapacity (void) [inline]

Used when mapping trunk groups to activated trunks.

Friends And Related Function Documentation

TrunkGroup* getGroup (const char * name = NULL) [friend]

Find a named trunk group.

Returns: trunk group object if found.

Author

Generated automatically by Doxygen for Bayonne from the source code.