User Guide

From TBwiki
(Difference between revisions)
Jump to: navigation, search
m (fix link)
 
(44 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
'''Toolpack Architecture'''
+
This is the User Guide for the Toolpack software. It is intended to give system designers and software developers a clear understanding of the different modules available to easily build small and large, fault-tolerant, scaleable systems.
  
−
<ul>
+
The initial content presented here is copied from the documentation supplied with release 2.3 of Toolpack. Items marked with an asterisk are incomplete as copied from the manual.
−
<li>Overview
+
−
<li>[[CMC library]]
+
−
<li>[[CMC Server]]
+
−
<li>[[HA Manager]]
+
−
<li>[[TCAP Control Library]]
+
−
</ul>
+
  
 +
== Toolpack Architecture ==
 +
*[[Overview]] *
 +
*[[CMC library]]
 +
*[[Toolpack_Application:toolpack_engine|Toolpack Engine]]
 +
*[[Toolpack_Application:toolpack_sys_manager|Toolpack System Manager]]
 +
*[[TCAP Control Library]]
  
−
'''Toolpack Concepts'''
 
  
−
<ul>
+
== Toolpack Concepts ==
−
<li>[[Interfaces]] *
+
*[[Interfaces]]
−
<li>[[Classes]]
+
*[[Classes]]
−
<li>[[Services]]
+
*[[Services]]
−
<li>[[Behaviors]]
+
*[[Behaviors]]
−
</ul>
+
  
  
−
'''ToolPack Reference Applications'''
+
== ToolPack Reference Applications ==
 +
*[[Telephony Application]]
 +
*[[Bridging Service]]
 +
*[[Voicemail Service]]
  
−
<ul>
 
−
<li>Telephony Application
 
−
<li>Bridging Service
 
−
<li>Voicemail Service
 
−
</ul>
 
  
 +
== ToolPack Modules ==
 +
*Call and Leg management
 +
:*[[CMC Call Leg class]]*
 +
:*[[CAF Call interface]]
 +
:*[[CAF Bridge class]]
  
−
'''ToolPack Modules'''
+
*CallBehaviors
−
<ul>
+
**CAFCallRingbackTone
−
<li>Callandlegmanagement
+
**CAFCallVoiceMailFallback
 +
**CAFCallFaxRelay
 +
**CAFCallFollowMe
 +
*[[CallRouting]]
 +
*[[IVR|Interactive Voice Response]] (IVR)
 +
*[[Web OAM&P]]
  
−
3.1.1 CMC Call Leg class
+
== Database ==
−
3.1.2 CAF Call interface
+
*[[Framework database]]
−
3.1.3 CAF Bridge class.
+
*[[Application database]]
 +
*Data access objects
 +
*System Logging
  
−
<li>CallBehaviors
+
== ToolPack Classes ==
−
3.2.1 CAFCallRingbackTone
+
*CTBCMCCallLeg
−
3.2.2 CAFCallVoiceMailFallback ..
+
*TBCAF::ITBCAFCall
−
3.2.3 CAFCallFaxRelay 
+
*TBCAF::CTBCAFCallLeg
−
3.2.4 CAFCallFollowMe 
+
*TBCAF::CTBCAFCallBehaviorFaxRelay
−
 
+
*TBCAF::CTBCAFCallBehaviorFollowMe
−
<li>[[CallRouting]]
+
*TBCAF::CTBCAFCallBehaviorRbt
−
<li>[[IVR|Interactive Voice Response]] (IVR)
+
*TBCAF::CTBCAFCallBehaviorVoiceMail
−
<li>[[Web OAM&P]]
+
*TBCAF::ITBCAFRouting
−
</ul>
+
*TBCAF::CTBCAFRoute
−
 
+
*CTBCMC_CALL_LEG_ATTRIBUTE
−
'''Database'''
+
*TBCAF::CTBCAFIvr
−
 
+
*TBCAF::CTBCAFVoiceMailMenu
−
<ul>
+
*TBCAF::CTBCAFDaoConnection
−
<li>[[Framework database]]
+
*TBCAF::CTBCAFDaoConnMgr
−
<li>[[Application database]]
+
*TBCAF::ITBCAFLog
−
<li>[[Data access objects]]
+
*TBCAF::CTBCAFLog
−
</ul>
+
*TBCAF::ITBCAFLogDao
−
 
+
*TBCAF::CTBCAFLogDao
−
<li>3.7 System Logging
+
*TBCAF::CTBS2GWGateway
−
 
+
*ITBCMCFreeListener
−
</ul>
+
−
 
+
−
'''ToolPack Classes '''
+
−
 
+
−
CTBCMCCallLegClassReference ....
+
−
 
+
−
4.1.1 Detailed Description
+
−
4.1.2 Constructor & Destructor Documentation
+
−
4.1.3 Member Function Documentation.
+
−
4.1.4 Member Data Documentation
+
−
 
+
−
TBCAF::ITBCAFCallClassReference .
+
−
4.2.1 DetailedDescription 
+
−
4.2.2 MemberFunctionDocumentation
+
−
 
+
−
TBCAF::CTBCAFCallLegClassReference
+
−
4.3.1 DetailedDescription 
+
−
4.3.2 Constructor&DestructorDocumentation ..
+
−
4.3.3 MemberFunctionDocumentation
+
−
 
+
−
TBCAF::CTBCAFCallBehaviorFaxRelay Class Reference.
+
−
4.4.1 DetailedDescription 
+
−
4.4.2 MemberFunctionDocumentation
+
−
 
+
−
TBCAF::CTBCAFCallBehaviorFollowMe Class Reference.
+
−
 
+
−
4.5.1 Detailed Description
+
−
4.5.2 Member Function Documentation. 85
+
−
 
+
−
4.6 TBCAF::CTBCAFCallBehaviorRbt Class Reference. 86
+
−
4.6.1 Detailed Description 86
+
−
4.6.2 Member Function Documentation. 87
+
−
 
+
−
4.7 TBCAF::CTBCAFCallBehaviorVoiceMail Class Reference. 89
+
−
4.7.1 DetailedDescription  89
+
−
4.7.2 MemberFunctionDocumentation 90
+
−
 
+
−
4.8 TBCAF::ITBCAFRoutingClassReference 93
+
−
4.8.1 Detailed Description
+
−
4.8.2 Member Function Documentation
+
−
 
+
−
TBCAF::CTBCAFRouteClassReference
+
−
 
+
−
4.9.1 DetailedDescription 
+
−
4.9.2 Constructor&DestructorDocumentation ..
+
−
4.9.3 MemberFunctionDocumentation
+
−
 
+
−
4.10 CTBCMC_CALL_LEG_ATTRIBUTEClassReference
+
−
4.10.1 DetailedDescription 
+
−
4.10.2 MemberFunctionDocumentation
+
−
 
+
−
4.11 TBCAF::CTBCAFIvrClassReference
+
−
4.11.1 DetailedDescription
+
−
4.11.2 Constructor&DestructorDocumentation
+
−
4.11.3 MemberFunctionDocumentation
+
−
4.11.4 MemberDataDocumentation
+
−
 
+
−
4.12 TBCAF::CTBCAFVoiceMailMenuClassReference
+
−
4.12.1 DetailedDescription
+
−
4.12.2 Constructor&DestructorDocumentation
+
−
 
+
−
 
+
−
4.13 TBCAF::CTBCAFDaoConnectionClassReference ..
+
−
 
+
−
4.13.1 DetailedDescription 
+
−
4.13.2 Constructor&DestructorDocumentation ..
+
−
 
+
−
4.14 TBCAF::CTBCAFDaoConnMgrClassReference...........
+
−
 
+
−
4.14.1 DetailedDescription 
+
−
4.14.2 Constructor & Destructor Documentation
+
−
4.14.3 MemberFunctionDocumentation 111
+
−
 
+
−
4.15TBCAF::ITBCAFLogClassReference ..113
+
−
 
+
−
4.15.1 DetailedDescription  113
+
−
4.15.2 MemberFunctionDocumentation 114
+
−
 
+
−
4.16TBCAF::CTBCAFLogClassReference .118
+
−
 
+
−
4.16.1 DetailedDescription  118
+
−
4.16.2 Constructor&DestructorDocumentation .. 121
+
−
4.16.3 MemberFunctionDocumentation 121
+
−
4.16.4 Member Data Documentation
+
−
 
+
−
4.17 TBCAF::ITBCAFLogDao Class Reference
+
−
 
+
−
4.17.1 DetailedDescription 
+
−
4.17.2 MemberFunctionDocumentation
+
−
 
+
−
4.18 TBCAF::CTBCAFLogDaoClassReference
+
−
 
+
−
4.18.1 DetailedDescription 
+
−
4.18.2 Constructor&DestructorDocumentation
+
−
4.18.3 MemberFunctionDocumentation
+
−
 
+
−
4.19 TBCAF::CTBS2GWGatewayClassReference
+
−
 
+
−
4.19.1 DetailedDescription 
+
−
4.19.2 Constructor&DestructorDocumentation
+
−
4.19.3 MemberFunctionDocumentation
+
−
4.20 TBCAF::CTBCAFPoolOfBuffers
+
−
ClassTemplateReference
+
−
 
+
−
4.20.1 DetailedDescription 
+
−
4.20.2 Constructor&DestructorDocumentation
+
−
4.20.3 MemberFunctionDocumentation
+
−
4.20.4 MemberDataDocumentation
+
−
 
+
−
4.21 ITBCMCFreeListener ClassTemplateReference
+
−
4.21.1 DetailedDescription 
+
−
4.21.2 MemberFunctionDocumentation
+
  
  
Line 177: Line 73:
 
'''Advanced programming concepts'''
 
'''Advanced programming concepts'''
  
−
5.1.1 Factory objects and CTBCAFPoolOfBuffers template
+
*ITBCMCFreeListener interface template
−
5.1.2 ITBCMCFreeListenerinterfacetemplate
+
−
 
+
−
5.2 Internaldataflows
+
−
 
+
−
5.2.1 CTBCAFBridgeinternaldataflow 147
+
−
5.2.2 CTBCAFCallBehaviorRbt detailed internal dataflow
+
−
 
+
−
 
+
−
== Glossary ==
+
−
 
+
−
'''Behavior''': A C++ class using a ITBCAFCall implementation and modifying the way it handles the call flow to achieve a new functionality (e.g. follow-me, ring-back-tone, etc).
+
−
 
+
−
'''Call''': An agglomeration of two or more call legs.
+
−
 
+
−
'''Call leg''': A full-duplex endpoint representing the media resource and its associated signaling (e.g. a Voip media resource with its associated SIP signaling call).
+
−
 
+
−
'''DAO''': Data access object
+
−
 
+
−
'''Interface''': C++ base class containing a set of member functions to be used as an API by other classes inheriting from it.
+
−
 
+
−
'''IVR''': Interactive voice response. This functions includes digit/tone play/collection and voice playing/recording.
+
  
−
'''Leg''': A full-duplex endpoint representing the media resource (e.g. a TDM trunk/timeslot or a Voip RTP media resource).
+
'''Internal data flows'''
  
−
'''NAP''': Network access point represents the entry point to another network or destination peer (e.g. SIP proxy, ISUP interface peer, etc).
+
*CTBCAFBridge internal data flow
 +
*CTBCAFCallBehaviorRbt detailed internal data flow

Latest revision as of 15:42, 15 February 2011

This is the User Guide for the Toolpack software. It is intended to give system designers and software developers a clear understanding of the different modules available to easily build small and large, fault-tolerant, scaleable systems.

The initial content presented here is copied from the documentation supplied with release 2.3 of Toolpack. Items marked with an asterisk are incomplete as copied from the manual.

Contents

Toolpack Architecture


Toolpack Concepts


ToolPack Reference Applications


ToolPack Modules

  • Call and Leg management

Database

ToolPack Classes

  • CTBCMCCallLeg
  • TBCAF::ITBCAFCall
  • TBCAF::CTBCAFCallLeg
  • TBCAF::CTBCAFCallBehaviorFaxRelay
  • TBCAF::CTBCAFCallBehaviorFollowMe
  • TBCAF::CTBCAFCallBehaviorRbt
  • TBCAF::CTBCAFCallBehaviorVoiceMail
  • TBCAF::ITBCAFRouting
  • TBCAF::CTBCAFRoute
  • CTBCMC_CALL_LEG_ATTRIBUTE
  • TBCAF::CTBCAFIvr
  • TBCAF::CTBCAFVoiceMailMenu
  • TBCAF::CTBCAFDaoConnection
  • TBCAF::CTBCAFDaoConnMgr
  • TBCAF::ITBCAFLog
  • TBCAF::CTBCAFLog
  • TBCAF::ITBCAFLogDao
  • TBCAF::CTBCAFLogDao
  • TBCAF::CTBS2GWGateway
  • ITBCMCFreeListener


Annexes

Advanced programming concepts

  • ITBCMCFreeListener interface template

Internal data flows

  • CTBCAFBridge internal data flow
  • CTBCAFCallBehaviorRbt detailed internal data flow
Retrieved from "https://docs.telcobridges.com/mediawiki/index.php?title=User_Guide&oldid=8728"
Personal tools