OpenH323
1.14.4(PandoraRC1)
OpenH323 is an Open Source class library for the development of applications using the H.323 protocol for multi-media communications over packet based networks. It uses the PWLib library to provide platform independence, and makes extensive use of the C++ techniques of inheritance and polymorphism.
This document is intended as reference guide, not a tutorial. For examples of using OpenH323, see the sample programs provided in the samples directory. A tutorial on using PWLib and OpenH323 is also available at http://toncar.cz/openh323/tut.
Last updated 17 May, 2004
Copyright (C) 1999-2003 Equivalence Pty Ltd, All right reserved
Portions Copyright (C) 2004 Post Increment, All Rights Reserved
The fundamental object in the ownership hierarchy is the H323Endpoint class. An application would typically have one instance of a descendant of this class. The application defined descendant would set up defaults for various H323 parameters (timeouts etc), the most important of which is the capability table which defines the codecs and channel types the application is capable of handling.
Also created by the application in the H323Endpoint would be instances of one or more descendants of the H323Listener class. There is a descendant of this class for each protocol that is supported. For example H323ListenerIP would be for Internet use. Each listener spawns a thread that monitors its protocol and when a new incoming call is detected, creates an instance of a H323Transport class descendent. As for the H323Listener class, there is a descendent for each protocol supported, eg H323TransportIP.
When the first PDU arrives on a H323Transport using the Q.931 and H.225 protocols, there is a call reference that identifies the connection that has been made. These connections are embodied by the H323Connection class, which contains all of the state information for a connection between H323 endpoints. The H323Endpoint instance keeps track of these active connections. If there is no connection for the call reference number already, a new one is created and H323 signalling negotiations begun.
An application would often have the system create an instance of a descendant of the H323Connection class, rather than that class itself. This is so that any of a large number of virtual methods may be overridden. These virtual methods are "callback" functions by the library to allow the application to either obtain information or modify the behaviour at various phases of the protocol negotiations. For example, there is a callback for when an incoming call is in progress and the application user should be "alerted". This is highly application specific being anything from a simple audible beep to displaying a pop up window with bells and whistles.
The H323Negotiator classes are used to maintain the state and functionality of each command or variable defined by the H.245 protocol. Their main reason for existence is actually to reduce the scope of the h225.h and h245.h files, which define many hundreds of classes. A user of the H323Connection class thus does not have to include all of these classes on every compilation unit.
During some of the H.245 negotiations, logical channels may be created, both by the remote endpoint and by the local application. The H323Channel class descendants represents this. A typical use of one of these classes is to open a stream of encoded audio data. The H323Channel class would create a H323Codec using the H323Capability that was passed during the protocol negotiations.
OpenH323 provides a rich class hierarchy that allows access to most of the functions requires for H.323 endponts. The list below is not intended an exhaustive list of the classes available (which is available here) but is good starting point for finding out more information on the various functions available
- H323EndPoint - implements a H.323 endpoint that can make or receive calls
- H323Connection - an instance of the class is created for each outgoing or incoming call
- H323Channel - the base class for all H.323 logical channels
- H323Codec - the base class for all codecs. See also H323AudioCode and H323VideoCodec
- H323SignalPDU - the base class for all H.323 Protocol Data Units (PDU)
- H323DataPDU - the base class for all H.323 Protocol Data Units (PDU)
- H323GatekeeperServer - implements a H.323 Gatekeeper, i.e. a server for H.225 RAS protocl
These classes are created from the H.225 ASN definitions
- H225_Setup_UUIE
- H225_CallProceeding_UUIE
- H225_Connect_UUIE
- H225_Alerting_UUIE
- H225_Information_UUIE
- H225_ReleaseComplete_UUIE
- H225_Facility_UUIE
- H225_Progress_UUIE
- H225_Status_UUIE
- H225_StatusInquiry_UUIE
- H225_SetupAcknowledge_UUIE
- H225_Notify_UUIE
- H225_GatekeeperRequest,
- H225_GatekeeperConfirm,
- H225_GatekeeperReject,
- H225_RegistrationRequest,
- H225_RegistrationConfirm,
- H225_RegistrationReject,
- H225_UnregistrationRequest,
- H225_UnregistrationConfirm,
- H225_UnregistrationReject,
- H225_AdmissionRequest,
- H225_AdmissionConfirm,
- H225_AdmissionReject,
- H225_BandwidthRequest,
- H225_BandwidthConfirm,
- H225_BandwidthReject,
- H225_DisengageRequest,
- H225_DisengageConfirm,
- H225_DisengageReject,
- H225_LocationRequest,
- H225_LocationConfirm,
- H225_LocationReject,
- H225_InfoRequest,
- H225_InfoRequestResponse,
- H225_NonStandardMessage,
- H225_UnknownMessageResponse,
- H225_RequestInProgress,
- H225_ResourcesAvailableIndicate,
- H225_ResourcesAvailableConfirm,
- H225_InfoRequestAck,
- H225_InfoRequestNak,
- H225_ServiceControlIndication,
- H225_ServiceControlResponse,
These classes are created from the H.245 ASN definitions
- 17 May 2004 - Converted from Doc++ to Doxygen format by Craig Southeren
Generated on Sat Jul 24 17:03:06 2004 for OpenH323 by
1.3.7