User Guide

Revision as of 12:51, 7 May 2009 (view source) Ktrueman (Talk | contribs) (New page: ToolPack Users’ guide ToolPackArchitecture # 1.1.1 Overview # 1.1.2 CMC library # 1.1.3 CMC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ....)		Latest revision as of 15:42, 15 February 2011 (view source) Cbilodeau (Talk | contribs) m (fix link)
(69 intermediate revisions by 4 users not shown)
Line 1:		Line 1:
−	ToolPack Users’ guide	+	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.
−	ToolPackArchitecture	+	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.
−	# 1.1.1 Overview	+	== Toolpack Architecture ==
−	# 1.1.2 CMC library	+	*[[Overview]] *
−	# 1.1.3 CMC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	+	*[[CMC library]]
−	# 1.1.4 HA Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	+	*[[Toolpack_Application:toolpack_engine|Toolpack Engine]]
−	# 1.1.5 TCAP Control library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	+	*[[Toolpack_Application:toolpack_sys_manager|Toolpack System Manager]]
		+	*[[TCAP Control Library]]
−	ToolPackConcepts ............................................
		+	== Toolpack Concepts ==
		+	*[[Interfaces]]
		+	*[[Classes]]
		+	*[[Services]]
		+	*[[Behaviors]]
−	1.2.1 Interfaces .............................................
−	1.2.2 Classes ..............................................
−	1.2.3 Services..............................................
−	1.2.4 Behaviors .............................................
−	ToolPack Reference Applications
−	TelephonyApplication ..........................................	+	== ToolPack Reference Applications ==
		+	*[[Telephony Application]]
		+	*[[Bridging Service]]
		+	*[[Voicemail Service]]
−	2.1.1 Description............................................	+	== ToolPack Modules ==
−	2.1.2 Features..............................................	+	*Call and Leg management
−	2.1.3 Usage...............................................	+	:*[[CMC Call Leg class]]*
−	2.1.4 Caveats	+	:*[[CAF Call interface]]
−	..............................................	+	:*[[CAF Bridge class]]
		+	*CallBehaviors
		+	**CAFCallRingbackTone
		+	**CAFCallVoiceMailFallback
		+	**CAFCallFaxRelay
		+	**CAFCallFollowMe
		+	*[[CallRouting]]
		+	*[[IVR|Interactive Voice Response]] (IVR)
		+	*[[Web OAM&P]]
−	2.2 Bridging Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12	+	== Database ==
−	2.2.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12	+	*[[Framework database]]
−	2.2.2 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12	+	*[[Application database]]
−	2.2.3 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12	+	*Data access objects
		+	*System Logging
−	�	+	== ToolPack Classes ==
−	CONTENTS	+	*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
−	2.2.4 Caveats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
−	2.3 Voicemail Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
−	2.3.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
−	2.3.2 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
−	2.3.3 Caveats	+	== Annexes ==
−	2.3.4 Classes	+
−	..............................................	+
−	..............................................	+
		+	'''Advanced programming concepts'''
−	ToolPack Modules	+	*ITBCMCFreeListener interface template
−	Callandlegmanagement ... . ... . ... . .. . ... . ... . ... . ... . .. . ... . ...	+	'''Internal data flows'''
−	3.1.1 CMC Call Leg class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	+	*CTBCAFBridge internal data flow
−	3.1.2 CAF Call interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	+	*CTBCAFCallBehaviorRbt detailed internal data flow
−	3.1.3 CAF Bridge class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	+
−		+
−	CallBehaviors ..............................................	+
−	3.2.1 CAFCallRingbackTone .....................................	+
−	3.2.2 CAFCallVoiceMailFallback ..................................	+
−	3.2.3 CAFCallFaxRelay .......................................	+
−	3.2.4 CAFCallFollowMe .......................................	+
−	CallRouting ... ... . ... . ... . ... . .. . ... . ... . ... . ... . .. . ... . ...	+
−	3.3.1 Description............................................	+
−	3.3.2 Usage...............................................	+
−	3.3.3 Caveats ..............................................	+
−	Interactivevoiceresponse(IVR) .....................................	+
−	3.4.1 Description............................................	+
−		+
−		+
−	3.4.2 Usage...............................................	+
−	3.4.3 Caveats ..............................................	+
−	3.4.4 Classes ..............................................	+
−	Web OAM&P	+
−	...............................................	+
−		+
−		+
−	3.5.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34	+
−	3.5.2 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35	+
−	3.5.3 Caveats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35	+
−	3.6 Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36	+
−		+
−	CMC User’s Guide	+
−		+
−	�	+
−	CONTENTS iii	+
−	3.6.1 Framework database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36	+
−	3.6.2 Application database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36	+
−	3.6.3 Data access objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37	+
−	3.7 System Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39	+
−		+
−	3.7.1 Description	+
−	............................................	+
−	...............................................	+
−		+
−		+
−	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	+
−		+
−	CMC User’s Guide	+
−		+
−	�	+
−	CONTENTS	+
−		+
−	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	+
−		+
−		+
−	CMC User’s Guide	+
−		+
−	�	+
−	CONTENTS	+
−		+
−	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<	+
−	T >	+
−	ClassTemplateReference .. . ... . ... . ... ... . ... . ...	+
−		+
−	4.21.1 DetailedDescription .......................................	+
−		+
−		+
−	4.21.2 MemberFunctionDocumentation ................................	+
−		+
−		+
−	Annexes	+
−		+
−	Advancedprogrammationconcepts .. . ... . .. . ... . ... . ... . ... . .. . ... . ...	+
−		+
−	5.1.1 Factory objects and CTBCAFPoolOfBuffers template . . . . . . . . . . . . . . . . . . . . . 143	+
−		+
−	5.1.2 ITBCMCFreeListenerinterfacetemplate ............................ 145	+
−		+
−		+
−	5.2 Internaldataflows ............................................. 147	+
−		+
−		+
−	5.2.1 CTBCAFBridgeinternaldataflow ................................ 147	+

---

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 1 Toolpack Architecture 2 Toolpack Concepts 3 ToolPack Reference Applications 4 ToolPack Modules 5 Database 6 ToolPack Classes 7 Annexes

Toolpack Architecture

• Overview *
• CMC library
• Toolpack Engine
• Toolpack System Manager
• TCAP Control Library

Toolpack Concepts

• Interfaces
• Classes
• Services
• Behaviors

ToolPack Reference Applications

• Telephony Application
• Bridging Service
• Voicemail Service

ToolPack Modules

• Call and Leg management

• CMC Call Leg class*
• CAF Call interface
• CAF Bridge class

• CallBehaviors
  • CAFCallRingbackTone
  • CAFCallVoiceMailFallback
  • CAFCallFaxRelay
  • CAFCallFollowMe
• CallRouting
• Interactive Voice Response (IVR)
• Web OAM&P

Database

• Framework database
• Application database
• Data access objects
• System Logging

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