Reliable Transaction Router
C++ Foundation Classes

Contents

Preface
Preface	Preface
Chapter 1
1	C++ API Concepts
1.1	Overview
1.2	Application Classes
1.2.1	Transaction Classes
1.2.2	Data Classes
1.2.3	Messages
1.2.4	Events
1.2.5	Client and Server Interaction
1.2.6	The Class Factory
1.2.7	Stream Classes
1.2.8	Application Classes Summary
1.3	Management Classes
1.3.1	Management Classes Descriptions
1.4	Processing Models
1.4.1	Event-Driven Model
1.4.2	Polling Model
1.5	Base Classes Message and Event Mapping
1.5.1	Client Messages
1.5.2	Client Events
1.5.3	Server Messages
1.5.4	Server Events for RTREvent
1.6	Using the C++ API with Existing Applications
1.6.1	Classes that Legacy Applications Can Use
1.6.2	Encapsulating Application Protocols
1.6.3	Implementation Example
1.7	Compiling and Linking your Application
Chapter 2
2	Design and Implementation
2.1	Design Steps
2.2	Implementation Steps
2.2.1	Implementing a Server
2.2.2	Implementing a Client
2.2.3	Implementation Example
2.3	Sample Application Walkthrough
2.3.1	Deriving from Base Classes in the Sample Application
2.3.2	Adding Functionality to Data Objects
2.3.3	Encapsulating Data with RTRData
2.3.4	Examining RTRData Objects
2.3.5	Sample Server Application
2.3.6	Sample Client Application
2.4	RTR Applications in a Multiplatform Environment
2.4.1	Defining a Message Format
Chapter 3
3	Application Classes
3.1	Server Classes
3.2	RTRServerEventHandler
Command 1	RTRServerEventHandler Class Members
Command 2	OnApplicationEvent()
Command 3	OnBackendGainedLinkToRouter()
Command 4	OnBackendLostLinkToRouter()
Command 5	OnFacilityDead()
Command 6	OnFacilityReady()
Command 7	OnFrontendGainedLinkToRouter()
Command 8	OnFrontendLostLinkToRouter()
Command 9	OnServerGainedShadow()
Command 10	OnServerIsPrimary()
Command 11	OnServerIsSecondary()
Command 12	OnServerIsStandby()
Command 13	OnServerLostShadow()
Command 14	OnServerRecoveryComplete()
Command 15	RTRServerEventHandler()
3.3	RTRServerMessageHandler
Command 16	RTRServerMessageHandler Class Members
Command 17	OnAccepted()
Command 18	OnApplicationMessage()
Command 19	OnInitialize()
Command 20	OnPrepareTransaction()
Command 21	OnRejected()
Command 22	OnUncertainTransaction()
Command 23	RTRServerMessageHandler()
3.4	RTRServerTransactionController
Command 24	RTRServerTransactionController Class Members
Command 25	AcceptTransaction()
Command 26	AcknowledgeTransactionOutcome()
Command 27	ForceTransactionRetry()
Command 28	GetFacilityName()
Command 29	GetPartitionName()
Command 30	GetProperties()
Command 31	Receive()
Command 32	RegisterClassFactory()
Command 33	RegisterFacility()
Command 34	RegisterHandlers()
Command 35	RegisterPartition()
Command 36	RejectTransaction()
Command 37	RTRServerTransactionController()
Command 38	SendApplicationEvent()
Command 39	SendApplicationMessage()
Command 40	UnRegisterPartition()
3.5	RTRServerTransactionProperties
Command 41	RTRServerTransactionProperties Class Members
Command 42	GetFacilityName()
Command 43	GetTID()
Command 44	GetTransactionState()
Command 45	RTRServerTransactionProperties()
Command 46	SetStateToAbort()
Command 47	SetStateToCommit()
Command 48	SetStateToDone()
Command 49	SetStateToException()
Command 50	TransactionIsOriginal()
Command 51	TransactionIsRecovery()
Command 52	TransactionIsReplay()
3.6	Client Classes
3.7	RTRClientEventHandler
Command 53	RTRClientEventHandler Class Members
Command 54	OnApplicationEvent()
Command 55	OnFacilityDead()
Command 56	OnFacilityReady()
Command 57	OnFrontendGainedLinkToRouter()
Command 58	OnFrontendLostLinkToRouter()
Command 59	OnNewKeyRangeAvailable()
Command 60	OnKeyRangeNoLongerAvailable()
Command 61	OnRouterGainedLinkToBackend()
Command 62	OnRouterLostLinkToBackend()
Command 63	RTRClientEventHandler()
3.8	RTRClientMessageHandler
Command 64	RTRClientMessageHandler Class Members
Command 65	OnAccepted()
Command 66	OnAllPreparedTransaction()
Command 67	OnApplicationMessage()
Command 68	OnInitialize()
Command 69	OnRejected()
Command 70	OnReturnToSender()
Command 71	RTRClientMessageHandler()
3.9	RTRClientTransactionController
Command 72	RTRClientTransactionController Class Members
Command 73	AcceptTransaction()
Command 74	Receive()
Command 75	RegisterClassFactory()
Command 76	RegisterFacility()
Command 77	RegisterHandlers()
Command 78	RejectTransaction()
Command 79	RTRClientTransactionController()
Command 80	SendApplicationEvent()
Command 81	SendApplicationMessage()
Command 82	StartTransaction()
3.10	RTRClientTransactionProperties
Command 83	RTRClientTransactionProperties Class Members
Command 84	RTRClientTransactionProperties()
3.11	Data Classes and the Class Factory
3.12	RTRApplicationEvent Class
Command 85	RTRApplicationEvent Class Members
Command 86	Dispatch()
Command 87	GetEventData()
Command 88	GetEventDataLength()
Command 89	GetEventNumber()
Command 90	SetEventData()
Command 91	SetEventNumber()
3.13	RTRApplicationMessage Class
Command 92	RTRApplicationMessage Class Members
Command 93	Dispatch()
Command 94	GetMessage()
Command 95	GetMessageLength()
3.14	RTRClassFactory Class
Command 96	RTRClassFactory Class Members
Command 97	CreateRTRApplicationEvent()
Command 98	CreateRTRApplicationMessage()
Command 99	CreateRTREvent()
Command 100	CreateRTRMessage()
3.15	RTRData
Command 101	RTRData Class Members
Command 102	Dispatch()
Command 103	GetActualBufferLength()
Command 104	GetLogicalBufferLength()
Command 105	IsApplicationEvent()
Command 106	IsApplicationMessage()
Command 107	IsEvent()
Command 108	IsMessage()
Command 109	IsRTREvent()
Command 110	IsRTRMessage()
Command 111	RTRData()
3.16	RTREvent Class
Command 112	RTREvent Class Members
Command 113	Dispatch()
Command 114	GetEventData()
Command 115	GetEventDataLength()
Command 116	GetEventNumber()
3.17	RTRMessage
Command 117	RTRMessage Class Members
Command 118	Dispatch()
Command 119	GetMessageType()
Command 120	GetReason()
Command 121	GetSecondaryStatus
3.18	RTRStream Class
Command 122	RTRStream Class Members
Command 123	operator>>
Command 124	operator<<
Command 125	ReadFromStream()
Command 126	RTRStream()
Command 127	WriteToStream()