Actions

User Guide: Difference between revisions

No edit summary
m (fix link)
 
(67 intermediate revisions by 4 users not shown)
Line 1: Line 1:
    Normal  0              false  false  false      EN-CA  X-NONE  X-NONE                                                    MicrosoftInternetExplorer4
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.


ToolPack Users’ guide
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.


ToolPackArchitecture
== Toolpack Architecture ==
#
*[[Overview]] *
1.1.1 Overview  
*[[CMC library]]
1.1.2 CMC library
*[[Toolpack_Application:toolpack_engine|Toolpack Engine]]
1.1.3 CMC Server
*[[Toolpack_Application:toolpack_sys_manager|Toolpack System Manager]]
1.1.4 HA Manager
*[[TCAP Control Library]]
1.1.5 TCAP Control library.
#
ToolPackConcepts


1.2.1 Interfaces
1.2.2 Classes .
1.2.3 Services.
1.2.4 Behaviors


ToolPack Reference Applications
== Toolpack Concepts ==
*[[Interfaces]]
*[[Classes]]
*[[Services]]
*[[Behaviors]]


TelephonyApplication


2.1.1 Description
== ToolPack Reference Applications ==
2.1.2 Features.
*[[Telephony Application]]
2.1.3 Usage..
*[[Bridging Service]]
2.1.4 Caveats
*[[Voicemail Service]]


2.2 Bridging Service 12
2.2.1 Description. 12
2.2.2 Features12
2.2.3 Usage. 12
2.2.4 Caveats12
2.3 Voicemail Service 13
2.3.1 Description. 13
2.3.2 Usage. 13
2.3.3 Caveats
2.3.4 Classes


ToolPack Modules  
== ToolPack Modules ==
*Call and Leg management
:*[[CMC Call Leg class]]*
:*[[CAF Call interface]]
:*[[CAF Bridge class]]


Callandlegmanagement ........
*CallBehaviors
**CAFCallRingbackTone
**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


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
CallRouting  ...
*TBCAF::CTBCAFCallBehaviorFollowMe
3.3.1 Description
*TBCAF::CTBCAFCallBehaviorRbt
3.3.2 Usage..
*TBCAF::CTBCAFCallBehaviorVoiceMail
3.3.3 Caveats .
*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


Interactivevoiceresponse(IVR)
3.4.1 Description
3.4.2 Usage..
3.4.3 Caveats .
3.4.4 Classes .


Web OAM&P
== Annexes ==


3.5.1 Description. 34
'''Advanced programming concepts'''
3.5.2 Usage. 35
3.5.3 Caveats35


3.6 Database. 36
*ITBCMCFreeListener interface template


3.6.1 Framework database 36
'''Internal data flows'''
3.6.2 Application database 36
3.6.3 Data access objects37


3.7 System Logging39
*CTBCAFBridge internal data flow
3.7.1 Description
*CTBCAFCallBehaviorRbt detailed internal data flow
3.7.2 Usage
3.7.3 Caveats .
3.7.4 Classes .
 
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<
T >
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
 
Annexes
 
Advanced programming concepts ....
 
5.1.1 Factory objects and CTBCAFPoolOfBuffers template
5.1.2 ITBCMCFreeListenerinterfacetemplate
 
5.2 Internaldataflows
 
5.2.1 CTBCAFBridgeinternaldataflow 147
5.2.2 CTBCAFCallBehaviorRbt detailed internal dataflow
 
5.3 Glossary

Latest revision as of 16: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.

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