Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

TrunkGroup Class Reference

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

#include <bayonne.h>

Inheritance diagram for TrunkGroup::

Keydata CallStat Mutex List of all members.

Public Methods

 TrunkGroup (char *name=NULL)
 Create a trunk group data key from the bayonne.conf file. More...

const char * getName (void)
 Get the name of this trunk group. More...

unsigned getAnswer (void)
 Get the number of rings before answering. More...

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

bool getDetect (void)
 Get dialtone detect state for the trunk. More...

unsigned getCallerid (void)
 Get the number of milliseconds for active caller id. More...

unsigned getPickup (void)
 Get pickup gaurd time for this trunk group. More...

const char * chkRequest (void)
 Get handling for trunk group "pending requests". More...

seltype_t getSelect (void)
 Get a trunk group port selection method. More...

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

unsigned getAnalysis (void)
 Get call progress analysis timeout for dialing. More...

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

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

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

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

int getHangup (void)
 Get disconnect gaurd time before answering. More...

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

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

timeout_t getDialspeed (void)
 Get dialing speed in milliseconds. More...

const char * getNumber (void)
 Get the telephone number associated with this trunk group if one is associated with it. More...

const char * getSchedule (char *buf)
 Get the name of the script to "schedule" for this group. More...

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. More...

void incCapacity (void)
 Used when mapping trunk groups to activated trunks. More...

RequestgetRequest (void)
 Get the next active request pending for this group. More...


Friends

class KeyServer
class Scheduler
class Audit
class TestDebug
class Request
class Policy
class Trunk
const char * getGroups (void)
void cancel (TrunkGroup *group, const char *tag)
Requestlocate (TrunkGroup *group, const char *tag, int *pos=NULL)
TrunkGroup * getGroup (const char *name)
 Find a named trunk group. More...


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.

unsigned 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.

int TrunkGroup::getHangup void   [inline]
 

Get disconnect gaurd time before answering.

Returns:
gaurd time in milliseconds.

unsigned TrunkGroup::getIdleTime void   [inline]
 

Get the initial idle timer for this group.

Returns:
idle time initial.

const char* TrunkGroup::getName void   [inline]
 

Get the name of this trunk group.

Returns:
name of trunk group.

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.

unsigned 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

friend class Audit [friend]
 

friend class KeyServer [friend]
 

friend class Policy [friend]
 

friend class Request [friend]
 

friend class Scheduler [friend]
 

friend class TestDebug [friend]
 

friend class Trunk [friend]
 

void cancel TrunkGroup *   group,
const char *   tag
[friend]
 

TrunkGroup* getGroup const char *   name [friend]
 

Find a named trunk group.

Returns:
trunk group object if found.

const char* getGroups void   [friend]
 

Request* locate TrunkGroup *   group,
const char *   tag,
int *   pos = NULL
[friend]
 


The documentation for this class was generated from the following file:
Generated at Wed Dec 5 09:13:32 2001 for Bayonne by doxygen1.2.10 written by Dimitri van Heesch, © 1997-2001