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:

List of all members.

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.
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.
Static Public Member Functions
static void	logStats (void)
	Interface to force logging of call statistics.
static TrunkGroup *	getGroup (const char *name=NULL)
	Find a named trunk group.
static TrunkGroup *	assign (Trunk *trunk)
	Assign a trunk to it's appropriate trunk group.
Friends
class	KeyServer
class	Request
class	Policy
class	Trunk
class	MappedStats
const char *	getGroups (void)
__EXPORT void	cancel (TrunkGroup *group, const char *tag)
__EXPORT Request *	locate (TrunkGroup *group, const char *tag, int *pos=NULL)

---

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

static TrunkGroup* TrunkGroup::assign (  Trunk *  trunk  )  [static]

Assign a trunk to it's appropriate trunk group. Parameters: trunk  to look for. Returns: trunk group assigned.

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.

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

Find a named trunk group. Returns: trunk group object if found.

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. Reimplemented from CallStat.

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.

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.

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.

static void TrunkGroup::logStats (  void   )  [static]

Interface to force logging of call statistics.

---

Friends And Related Function Documentation

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

const char* getGroups (  void   )  [friend]

friend class KeyServer [friend]

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

friend class MappedStats [friend]

friend class Policy [friend]

friend class Request [friend]

friend class Trunk [friend]

---

The documentation for this class was generated from the following file:

• bayonne.h

---