h323con.h

Go to the documentation of this file.

/*
 * h323con.h
 *
 * H.323 protocol handler
 *
 * Open H323 Library
 *
 * Copyright (c) 1998-2001 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Open H323 Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Portions of this code were written with the assisance of funding from
 * Vovida Networks, Inc. http://www.vovida.com.
 *
 * Contributor(s): ______________________________________.
 *
 * $Log: h323con.h,v $
 * Revision 2.67  2007/08/13 16:19:08  csoutheren
 * Ensure CreateMediaStream is only called *once* for each stream in H.323 calls
 *
 * Revision 2.66  2007/07/26 00:41:17  csoutheren
 * Remove functions which are identical to ancestor
 *
 * Revision 2.65  2007/05/09 14:59:19  hfriederich
 * Make SetRemotePartyInfo() virtual
 *
 * Revision 2.64  2007/04/26 07:01:00  csoutheren
 * Add extra code to deal with getting media formats from connections early enough to do proper
 * gatewaying between calls. The SIP and H.323 code need to have the handing of the remote
 * and local formats standardized, but this will do for now
 *
 * Revision 2.63  2007/04/10 05:15:53  rjongbloed
 * Fixed issue with use of static C string variables in DLL environment,
 *   must use functional interface for correct initialisation.
 *
 * Revision 2.62  2007/03/13 03:34:00  csoutheren
 * Fixed use of wrong ifdef
 *
 * Revision 2.61  2007/03/13 02:16:56  csoutheren
 * Remove warnings/errors when compiling with various turned off
 *
 * Revision 2.60  2007/03/13 00:32:16  csoutheren
 * Simple but messy changes to allow compile time removal of protocol
 * options such as H.450 and H.460
 * Fix MakeConnection overrides
 *
 * Revision 2.59  2007/03/01 05:51:03  rjongbloed
 * Fixed backward compatibility of OnIncomingConnection() virtual
 *   functions on various classes. If an old override returned FALSE
 *   then it will now abort the call as it used to.
 *
 * Revision 2.58  2007/02/19 04:42:27  csoutheren
 * Added OnIncomingMediaChannels so incoming calls can optionally be handled in two stages
 *
 * Revision 2.57  2007/01/24 04:00:55  csoutheren
 * Arrrghh. Changing OnIncomingConnection turned out to have a lot of side-effects
 * Added some pure viritual functions to prevent old code from breaking silently
 * New OpalEndpoint and OpalConnection descendants will need to re-implement
 * OnIncomingConnection. Sorry :)
 *
 * Revision 2.56  2007/01/18 04:45:16  csoutheren
 * Messy, but simple change to add additional options argument to OpalConnection constructor
 * This allows the provision of non-trivial arguments for connections
 *
 * Revision 2.55  2006/12/18 03:18:41  csoutheren
 * Messy but simple fixes
 *   - Add access to SIP REGISTER timeout
 *   - Ensure OpalConnection options are correctly progagated
 *
 * Revision 2.54  2006/11/11 12:23:17  hfriederich
 * Code reorganisation to improve RFC2833 handling for both SIP and H.323. Thanks Simon Zwahlen for the idea
 *
 * Revision 2.53  2006/08/22 08:55:46  csoutheren
 * Removed duplicate declaration of remoteIsNAT that was hiding variable of same name in the ancestor
 *
 * Revision 2.52  2006/08/12 03:55:39  csoutheren
 * Applied 1538066 - Make H323 StartControlNegotiations virtual
 * Thanks to Adam Butcher
 *
 * Revision 2.51  2006/08/03 04:57:12  csoutheren
 * Port additional NAT handling logic from OpenH323 and extend into OpalConnection class
 *
 * Revision 2.50  2006/06/27 13:07:37  csoutheren
 * Patch 1374533 - add h323 Progress handling
 * Thanks to Frederich Heem
 *
 * Revision 2.49  2006/06/27 12:54:35  csoutheren
 * Patch 1374489 - h450.7 message center support
 * Thanks to Frederich Heem
 *
 * Revision 2.48  2006/06/09 04:22:24  csoutheren
 * Implemented mapping between SIP release codes and Q.931 codes as specified
 *  by RFC 3398
 *
 * Revision 2.47  2006/05/30 11:33:02  hfriederich
 * Porting support for H.460 from OpenH323
 *
 * Revision 2.46  2006/05/30 04:58:05  csoutheren
 * Added suport for SIP INFO message (untested as yet)
 * Fixed some issues with SIP state machine on answering calls
 * Fixed some formatting issues
 *
 * Revision 2.45  2006/04/20 16:52:22  hfriederich
 * Adding support for H.224/H.281
 *
 * Revision 2.44  2006/01/02 15:52:38  dsandras
 * Added what was required to merge changes from OpenH323 Altas_devel_2 in gkclient.cxx, gkserver.cxx and channels.cxx.
 *
 * Revision 2.43  2005/12/09 05:41:10  csoutheren
 * Added ability to set explicit Q.931 cause code on call end
 *
 * Revision 2.42  2005/11/30 13:35:26  csoutheren
 * Changed tags for Doxygen
 *
 * Revision 2.41  2005/11/24 04:46:41  dereksmithies
 * Remove detectInBandDTMF, as it is already declared in the OpalConnection
 * class. Thanks to valgrind on suse 10 for finding this one.
 *
 * Revision 2.40  2005/10/04 13:01:51  rjongbloed
 * Moved addition of a media stream to list in OpalConnection to OnOpenMediaStream
 *   so is consistent across protocols.
 *
 * Revision 2.39  2005/09/29 20:20:36  dsandras
 * Added call to OnOpenMediaStream so that the stream can be added to the mediaStreams.
 *
 * Revision 2.38  2005/09/04 06:23:38  rjongbloed
 * Added OpalMediaCommand mechanism (via PNotifier) for media streams
 *   and media transcoders to send commands back to remote.
 *
 * Revision 2.37  2005/08/05 19:21:04  csoutheren
 * Ensure H323Connection calls OnAlerting even if no ALERT is received
 *
 * Revision 2.36  2005/07/11 01:52:15  csoutheren
 * Extended AnsweringCall to work for SIP as well as H.323
 * Fixed problems with external RTP connection in H.323
 * Added call to OnClosedMediaStream
 *
 * Revision 2.35  2005/04/10 20:35:20  dsandras
 * Added support for blind transfert.
 *
 * Revision 2.34  2005/04/10 20:33:53  dsandras
 * Added support to hold and retrieve a connection. Basically a rename of the old
 * functions while keeping backward compatibility.
 *
 * Revision 2.33  2005/04/10 20:31:17  dsandras
 * Added support to return the "best guess" callback h323 url.
 *
 * Revision 2.32  2005/03/01 17:51:02  dsandras
 * Removed erroneous definition of RTP_SessionManager preventing the get the RTP_Session from the connection when called on an OpalConnection object. The RTP_SessionManager is now part of OpalConnection.
 *
 * Revision 2.31  2005/01/16 11:28:04  csoutheren
 * Added GetIdentifier virtual function to OpalConnection, and changed H323
 * and SIP descendants to use this function. This allows an application to
 * obtain a GUID for any connection regardless of the protocol used
 *
 * Revision 2.30  2004/12/12 12:29:02  dsandras
 * Moved GetRemoteApplication () to OpalConnection so that it is usable for all types of connection.
 *
 * Revision 2.29  2004/08/14 07:56:28  rjongbloed
 * Major revision to utilise the PSafeCollection classes for the connections and calls.
 *
 * Revision 2.28  2004/06/04 06:54:17  csoutheren
 * Migrated updates from OpenH323 1.14.1
 *
 * Revision 2.27  2004/05/09 13:12:37  rjongbloed
 * Fixed issues with non fast start and non-tunnelled connections
 *
 * Revision 2.26  2004/05/01 10:00:41  rjongbloed
 * Fixed ClearCallSynchronous so now is actually signalled when call is destroyed.
 *
 * Revision 2.25  2004/04/26 04:33:03  rjongbloed
 * Move various call progress times from H.323 specific to general conenction.
 *
 * Revision 2.24  2004/03/13 06:25:49  rjongbloed
 * Slight rearrangement of local party name and alias list to beter match common
 *   behaviour in ancestor.
 * Abstracted local party name for endpoint into ancestor from H.,323.
 *
 * Revision 2.23  2004/02/24 11:28:45  rjongbloed
 * Normalised RTP session management across protocols
 *
 * Revision 2.22  2004/02/19 10:46:43  rjongbloed
 * Merged OpenH323 version 1.13.1 changes.
 *
 * Revision 2.21  2003/03/17 10:26:59  robertj
 * Added video support.
 *
 * Revision 2.20  2003/03/06 03:57:46  robertj
 * IVR support (work in progress) requiring large changes everywhere.
 *
 * Revision 2.19  2003/01/07 04:39:52  robertj
 * Updated to OpenH323 v1.11.2
 *
 * Revision 2.18  2002/11/10 22:59:20  robertj
 * Fixed override of SetCallEndReason to have same parameters as base virtual.
 *
 * Revision 2.17  2002/11/10 11:33:16  robertj
 * Updated to OpenH323 v1.10.3
 *
 * Revision 2.16  2002/09/16 02:52:33  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 2.15  2002/09/04 06:01:46  robertj
 * Updated to OpenH323 v1.9.6
 *
 * Revision 2.14  2002/07/01 04:56:29  robertj
 * Updated to OpenH323 v1.9.1
 *
 * Revision 2.13  2002/04/09 00:17:08  robertj
 * Changed "callAnswered" to better description of "originating".
 *
 * Revision 2.12  2002/02/19 07:43:40  robertj
 * Restructured media bypass functions to fix problems with RFC2833.
 *
 * Revision 2.11  2002/02/11 09:32:11  robertj
 * Updated to openH323 v1.8.0
 *
 * Revision 2.10  2002/02/11 07:37:43  robertj
 * Added media bypass for streams between compatible protocols.
 *
 * Revision 2.9  2002/01/22 04:59:04  robertj
 * Update from OpenH323, RFC2833 support
 *
 * Revision 2.8  2002/01/14 06:35:56  robertj
 * Updated to OpenH323 v1.7.9
 *
 * Revision 2.7  2001/11/02 10:45:19  robertj
 * Updated to OpenH323 v1.7.3
 *
 * Revision 2.6  2001/10/15 04:31:14  robertj
 * Removed answerCall signal and replaced with state based functions.
 * Maintained H.323 answerCall API for backward compatibility.
 *
 * Revision 2.5  2001/10/05 00:22:13  robertj
 * Updated to PWLib 1.2.0 and OpenH323 1.7.0
 *
 * Revision 2.4  2001/10/03 05:56:15  robertj
 * Changes abndwidth management API.
 *
 * Revision 2.3  2001/08/22 09:42:14  robertj
 * Removed duplicate member variables moved to ancestor.
 *
 * Revision 2.2  2001/08/17 08:21:15  robertj
 * Update from OpenH323
 * Moved call end reasons enum from OpalConnection to global.
 *
 * Revision 2.1  2001/08/01 05:11:04  robertj
 * Moved media formats list from endpoint to connection.
 *
 * Revision 2.0  2001/07/27 15:48:24  robertj
 * Conversion of OpenH323 to Open Phone Abstraction Library (OPAL)
 *
 * Revision 1.64  2003/12/28 02:38:14  csoutheren
 * Added H323EndPoint::OnOutgoingCall
 *
 * Revision 1.63  2003/12/14 10:42:29  rjongbloed
 * Changes for compilability without video support.
 *
 * Revision 1.62  2003/10/27 06:03:38  csoutheren
 * Added support for QoS
 *   Thanks to Henry Harrison of AliceStreet
 *
 * Revision 1.61  2003/10/09 09:47:45  csoutheren
 * Fixed problem with re-opening RTP half-channels under unusual
 * circumstances. Thanks to Damien Sandras
 *
 * Revision 1.60  2003/04/30 00:28:50  robertj
 * Redesigned the alternate credentials in ARQ system as old implementation
 *   was fraught with concurrency issues, most importantly it can cause false
 *   detection of replay attacks taking out an endpoint completely.
 *
 * Revision 1.59  2003/02/12 23:59:22  robertj
 * Fixed adding missing endpoint identifer in SETUP packet when gatekeeper
 * routed, pointed out by Stefan Klein
 * Also fixed correct rutrn of gk routing in IRR packet.
 *
 * Revision 1.58  2002/11/27 06:54:52  robertj
 * Added Service Control Session management as per Annex K/H.323 via RAS
 *   only at this stage.
 * Added H.248 ASN and very primitive infrastructure for linking into the
 *   Service Control Session management system.
 * Added basic infrastructure for Annex K/H.323 HTTP transport system.
 * Added Call Credit Service Control to display account balances.
 *
 * Revision 1.57  2002/11/15 05:17:22  robertj
 * Added facility redirect support without changing the call token for access
 *   to the call. If it gets redirected a new H323Connection object is
 *   created but it looks like the same thing to an application.
 *
 * Revision 1.56  2002/11/13 04:37:23  robertj
 * Added ability to get (and set) Q.931 release complete cause codes.
 *
 * Revision 1.55  2002/11/10 06:17:26  robertj
 * Fixed minor documentation errors.
 *
 * Revision 1.54  2002/11/05 00:24:09  robertj
 * Added function to determine if Q.931 CONNECT sent/received.
 *
 * Revision 1.53  2002/10/31 00:31:47  robertj
 * Enhanced jitter buffer system so operates dynamically between minimum and
 *   maximum values. Altered API to assure app writers note the change!
 *
 * Revision 1.52  2002/09/16 01:14:15  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 1.51  2002/09/03 06:19:36  robertj
 * Normalised the multi-include header prevention ifdef/define symbol.
 *
 * Revision 1.50  2002/08/05 10:03:47  robertj
 * Cosmetic changes to normalise the usage of pragma interface/implementation.
 *
 * Revision 1.49  2002/08/05 05:17:37  robertj
 * Fairly major modifications to support different authentication credentials
 *   in ARQ to the logged in ones on RRQ. For both client and server.
 * Various other H.235 authentication bugs and anomalies fixed on the way.
 *
 * Revision 1.48  2002/07/05 02:22:56  robertj
 * Added support for standard and non-standard T.38 mode change.
 *
 * Revision 1.47  2002/07/04 00:40:31  robertj
 * More H.450.11 call intrusion implementation, thanks Aleksandar Todorovic
 *
 * Revision 1.46  2002/06/22 06:11:30  robertj
 * Fixed bug on sometimes missing received endSession causing 10 second
 *   timeout in connection clean up.
 *
 * Revision 1.45  2002/06/22 05:48:38  robertj
 * Added partial implementation for H.450.11 Call Intrusion
 *
 * Revision 1.44  2002/06/13 06:15:19  robertj
 * Allowed TransferCall() to be used on H323Connection as well as H323EndPoint.
 *
 * Revision 1.43  2002/06/05 08:58:58  robertj
 * Fixed documentation of remote application name string.
 * Added missing virtual keywards on some protocol handler functions.
 *
 * Revision 1.42  2002/05/29 06:40:29  robertj
 * Changed sending of endSession/ReleaseComplete PDU's to occur immediately
 *   on call clearance and not wait for background thread to do it.
 * Stricter compliance by waiting for reply endSession before closing down.
 *
 * Revision 1.41  2002/05/29 03:55:17  robertj
 * Added protocol version number checking infrastructure, primarily to improve
 *   interoperability with stacks that are unforgiving of new features.
 *
 * Revision 1.40  2002/05/21 09:32:49  robertj
 * Added ability to set multiple alias names ona  connection by connection
 *   basis, defaults to endpoint list, thanks Artis Kugevics
 *
 * Revision 1.39  2002/05/15 23:59:33  robertj
 * Added memory management of created T.38 and T.120 handlers.
 * Improved documentation for use of T.38 and T.120 functions.
 * Added ability to initiate a mode change for non-standard T.38
 *
 * Revision 1.38  2002/05/07 01:31:51  dereks
 * Fix typo in documentation.
 *
 * Revision 1.37  2002/05/03 05:38:15  robertj
 * Added Q.931 Keypad IE mechanism for user indications (DTMF).
 *
 * Revision 1.36  2002/05/02 07:56:24  robertj
 * Added automatic clearing of call if no media (RTP data) is transferred in a
 *   configurable (default 5 minutes) amount of time.
 *
 * Revision 1.35  2002/04/25 20:55:25  dereks
 * Fix documentation. Thanks Olaf Schulz.
 *
 * Revision 1.34  2002/04/17 00:50:34  robertj
 * Added ability to disable the in band DTMF detection.
 *
 * Revision 1.33  2002/03/27 06:04:42  robertj
 * Added Temporary Failure end code for connection, an application may
 *   immediately retry the call if this occurs.
 *
 * Revision 1.32  2002/02/11 04:20:48  robertj
 * Fixed documentation errors, thanks Horacio J. Peña
 *
 * Revision 1.31  2002/02/11 04:16:37  robertj
 * Fixed bug where could send DRQ if never received an ACF.
 *
 * Revision 1.30  2002/02/06 06:30:47  craigs
 * Fixed problem whereby MSD/TCS was stalled if H245 was included in
 * SETUP, but other end did not respond
 *
 * Revision 1.29  2002/02/04 07:17:52  robertj
 * Added H.450.2 Consultation Transfer, thanks Norwood Systems.
 *
 * Revision 1.28  2002/01/25 05:20:05  robertj
 * Moved static strings for enum printing to inside of function, could crash with DLL's
 *
 * Revision 1.27  2002/01/24 06:29:02  robertj
 * Added option to disable H.245 negotiation in SETUP pdu, this required
 *   API change so have a bit mask instead of a series of booleans.
 *
 * Revision 1.26  2002/01/23 12:45:37  rogerh
 * Add the DTMF decoder. This identifies DTMF tones in an audio stream.
 *
 * Revision 1.25  2002/01/23 07:12:48  robertj
 * Added hooks for in band DTMF detection. Now need the detector!
 *
 * Revision 1.24  2002/01/22 22:48:21  robertj
 * Fixed RFC2833 support (transmitter) requiring large rewrite
 *
 * Revision 1.23  2002/01/18 06:02:08  robertj
 * Added some H323v4 functions (fastConnectRefused & TCS in SETUP)
 *
 * Revision 1.22  2002/01/17 07:04:58  robertj
 * Added support for RFC2833 embedded DTMF in the RTP stream.
 *
 * Revision 1.21  2002/01/14 00:05:24  robertj
 * Added H.450.6, better H.450.2 error handling and  and Music On Hold.
 * Added destExtraCallInfo field for ARQ.
 *   Thanks Ben Madsen of Norwood Systems
 *
 * Revision 1.20  2002/01/10 05:13:50  robertj
 * Added support for external RTP stacks, thanks NuMind Software Systems.
 *
 * Revision 1.19  2002/01/09 00:21:36  robertj
 * Changes to support outgoing H.245 RequstModeChange.
 *
 * Revision 1.18  2001/12/22 03:20:31  robertj
 * Added create protocol function to H323Connection.
 *
 * Revision 1.17  2001/12/22 03:09:36  robertj
 * Changed OnRequstModeChange to return ack, then actually do the change.
 *
 * Revision 1.16  2001/12/22 01:52:54  robertj
 * Added more support for H.245 RequestMode operation.
 *
 * Revision 1.15  2001/12/15 08:09:54  robertj
 * Added alerting, connect and end of call times to be sent to RAS server.
 *
 * Revision 1.14  2001/12/13 10:54:23  robertj
 * Added ability to automatically add ACF access token to SETUP pdu.
 *
 * Revision 1.13  2001/11/01 06:11:54  robertj
 * Plugged very small mutex hole that could cause crashes.
 *
 * Revision 1.12  2001/11/01 00:27:33  robertj
 * Added default Fast Start disabled and H.245 tunneling disable flags
 *   to the endpoint instance.
 *
 * Revision 1.11  2001/10/24 00:54:13  robertj
 * Made cosmetic changes to H.245 miscellaneous command function.
 *
 * Revision 1.10  2001/10/23 02:18:06  dereks
 * Initial release of CU30 video codec.
 *
 * Revision 1.9  2001/09/26 06:20:56  robertj
 * Fixed properly nesting connection locking and unlocking requiring a quite
 *   large change to teh implementation of how calls are answered.
 *
 * Revision 1.8  2001/09/19 03:30:53  robertj
 * Added some support for overlapped dialing, thanks Chris Purvis & Nick Hoath.
 *
 * Revision 1.7  2001/09/13 06:48:13  robertj
 * Added call back functions for remaining Q.931/H.225 messages.
 * Added call back to allow modification of Release Complete,thanks Nick Hoath
 *
 * Revision 1.6  2001/09/12 06:57:58  robertj
 * Added support for iNow Access Token from gk, thanks Nick Hoath
 *
 * Revision 1.5  2001/09/12 06:04:36  robertj
 * Added support for sending UUIE's to gk on request, thanks Nick Hoath
 *
 * Revision 1.4  2001/09/11 01:24:36  robertj
 * Added conditional compilation to remove video and/or audio codecs.
 *
 * Revision 1.3  2001/08/22 06:54:50  robertj
 * Changed connection locking to use double mutex to guarantee that
 *   no threads can ever deadlock or access deleted connection.
 *
 * Revision 1.2  2001/08/16 07:49:16  robertj
 * Changed the H.450 support to be more extensible. Protocol handlers
 *   are now in separate classes instead of all in H323Connection.
 *
 * Revision 1.1  2001/08/06 03:08:11  robertj
 * Fission of h323.h to h323ep.h & h323con.h, h323.h now just includes files.
 */

#ifndef __OPAL_H323CON_H
#define __OPAL_H323CON_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif


#include <opal/connection.h>
#include <opal/guid.h>
#include <opal/buildopts.h>
#include <h323/h323caps.h>
#include <ptclib/dtmf.h>


/* The following classes have forward references to avoid including the VERY
   large header files for H225 and H245. If an application requires access
   to the protocol classes they can include them, but for simple usage their
   inclusion can be avoided.
 */
class PPER_Stream;
class PASN_OctetString;

class H225_EndpointType;
class H225_TransportAddress;
class H225_ArrayOf_PASN_OctetString;
class H225_ProtocolIdentifier;
class H225_AdmissionRequest;
class H225_FeatureSet;

class H245_TerminalCapabilitySet;
class H245_TerminalCapabilitySetReject;
class H245_OpenLogicalChannel;
class H245_OpenLogicalChannelAck;
class H245_TransportAddress;
class H245_UserInputIndication;
class H245_RequestMode;
class H245_RequestModeAck;
class H245_RequestModeReject;
class H245_ModeDescription;
class H245_ArrayOf_ModeDescription;
class H245_SendTerminalCapabilitySet;
class H245_MultiplexCapability;
class H245_FlowControlCommand;
class H245_MiscellaneousCommand;
class H245_MiscellaneousIndication;
class H245_JitterIndication;

class H323SignalPDU;
class H323ControlPDU;
class H323EndPoint;
class H323TransportAddress;

class H235Authenticators;

class H245NegMasterSlaveDetermination;
class H245NegTerminalCapabilitySet;
class H245NegLogicalChannels;
class H245NegRequestMode;
class H245NegRoundTripDelay;

class H450xDispatcher;
class H4502Handler;
class H4504Handler;
class H4506Handler;
class H4507Handler;
class H45011Handler;

class OpalCall;

#ifdef H323_H460
class H460_FeatureSet;
#endif



class H323Connection : public OpalConnection
{
  PCLASSINFO(H323Connection, OpalConnection);

  public:
    H323Connection(
      OpalCall & call,                         
      H323EndPoint & endpoint,                 
      const PString & token,                   
      const PString & alias,                   
      const H323TransportAddress & address,    
      unsigned options = 0,                    
      OpalConnection::StringOptions * stringOptions = NULL 
    );

    ~H323Connection();

    virtual BOOL SetUpConnection();

    virtual BOOL SetAlerting(
      const PString & calleeName,   
      BOOL withMedia                
    );

    virtual BOOL SetConnected();

    virtual void OnSendARQ(
      H225_AdmissionRequest & arq
    );

    
    virtual BOOL SetProgressed();
    
    virtual void OnEstablished();

    virtual void OnReleased();

    virtual PString GetDestinationAddress();

    virtual OpalMediaFormatList GetMediaFormats() const;

    virtual BOOL OpenSourceMediaStream(
      const OpalMediaFormatList & mediaFormats, 
      unsigned sessionID                   
    );
    
    virtual OpalMediaStream * CreateMediaStream(
      const OpalMediaFormat & mediaFormat, 
      unsigned sessionID,                  
      BOOL isSource                        
    );

    void OnPatchMediaStream(BOOL isSource, OpalMediaPatch & patch);

    virtual BOOL IsMediaBypassPossible(
      unsigned sessionID                  
    ) const;

    virtual BOOL GetMediaInformation(
      unsigned sessionID,     
      MediaInformation & info 
    ) const;

    virtual void OnCleared();

    BOOL IsEstablished() const { return connectionState == EstablishedConnection; }

    virtual void CleanUpOnCallEnd();


    void AttachSignalChannel(
      const PString & token,    
      H323Transport * channel,  
      BOOL answeringCall        
    );

    BOOL WriteSignalPDU(
      H323SignalPDU & pdu       
    );

    virtual void HandleSignallingChannel();

    virtual BOOL HandleSignalPDU(
      H323SignalPDU & pdu       
    );

    virtual void HandleTunnelPDU(
      H323SignalPDU * txPDU       
    );

    virtual BOOL OnReceivedSignalSetup(
      const H323SignalPDU & pdu   
    );

    virtual BOOL OnReceivedSignalSetupAck(
      const H323SignalPDU & pdu   
    );

    virtual BOOL OnReceivedSignalInformation(
      const H323SignalPDU & pdu   
    );

    virtual BOOL OnReceivedCallProceeding(
      const H323SignalPDU & pdu   
    );

    virtual BOOL OnReceivedProgress(
      const H323SignalPDU & pdu   
    );

    virtual BOOL OnReceivedAlerting(
      const H323SignalPDU & pdu   
    );

    virtual BOOL OnReceivedSignalConnect(
      const H323SignalPDU & pdu   
    );

    virtual BOOL OnReceivedFacility(
      const H323SignalPDU & pdu   
    );

    virtual BOOL OnReceivedSignalNotify(
      const H323SignalPDU & pdu   
    );

    virtual BOOL OnReceivedSignalStatus(
      const H323SignalPDU & pdu   
    );

    virtual BOOL OnReceivedStatusEnquiry(
      const H323SignalPDU & pdu   
    );

    virtual void OnReceivedReleaseComplete(
      const H323SignalPDU & pdu   
    );

    virtual BOOL OnUnknownSignalPDU(
      const H323SignalPDU & pdu  
    );

    virtual BOOL OnIncomingCall(
      const H323SignalPDU & setupPDU,   
      H323SignalPDU & alertingPDU       
    );

    virtual BOOL ForwardCall(
      const PString & forwardParty   
    );

#if OPAL_H450

    void TransferCall(
      const PString & remoteParty,   
      const PString & callIdentity = PString::Empty()
    );

    void ConsultationTransfer(
      const PString & primaryCallToken  
    );

    virtual void HandleConsultationTransfer(
      const PString & callIdentity, 
      H323Connection & incoming     
    );

    BOOL IsTransferringCall() const;

    BOOL IsTransferredCall() const;

    virtual void HandleTransferCall(
      const PString & token,
      const PString & identity
    );

    int GetCallTransferInvokeId();

    virtual void HandleCallTransferFailure(
      const int returnError    
    );

    void SetAssociatedCallToken(
      const PString & token  
    );

    virtual void OnConsultationTransferSuccess(
      H323Connection & secondaryCall  
    );

    virtual void TransferConnection(
      const PString & remoteParty,
      const PString & callIdentity = PString::Empty()
    );

    virtual void HoldConnection();

    virtual void RetrieveConnection();

    virtual BOOL IsConnectionOnHold();

    void HoldCall(
      BOOL localHold   
    );

    void RetrieveCall();

    void SetHoldMedia(
      PChannel * audioChannel
    );

    BOOL IsMediaOnHold() const;

    BOOL IsLocalHold() const;

    BOOL IsRemoteHold() const;

    BOOL IsCallOnHold() const;

    virtual void IntrudeCall(
      unsigned capabilityLevel
    );

    virtual void HandleIntrudeCall(
      const PString & token,
      const PString & identity
    );

    void SetCallIntrusion() { isCallIntrusion = TRUE; }

    BOOL IsCallIntrusion() { return isCallIntrusion; }

    unsigned GetLocalCallIntrusionProtectionLevel() { return callIntrusionProtectionLevel; }

    virtual BOOL GetRemoteCallIntrusionProtectionLevel(
      const PString & callToken,
      unsigned callIntrusionProtectionLevel
    );

    virtual void SetIntrusionImpending();

    virtual void SetForcedReleaseAccepted();

    virtual void SetIntrusionNotAuthorized();

    void SendCallWaitingIndication(
      const unsigned nbOfAddWaitingCalls = 0   
    );

#endif

    virtual AnswerCallResponse OnAnswerCall(
      const PString & callerName,       
      const H323SignalPDU & setupPDU,   
      H323SignalPDU & connectPDU,       
      H323SignalPDU & progressPDU       
    );
    
    virtual AnswerCallResponse OnAnswerCall(
      const PString & callerName        
    );

    void AnsweringCall(
      AnswerCallResponse response 
    );

    virtual CallEndReason SendSignalSetup(
      const PString & alias,                
      const H323TransportAddress & address  
    );

    virtual BOOL OnSendSignalSetup(
      H323SignalPDU & setupPDU   
    );

    virtual BOOL OnSendCallProceeding(
      H323SignalPDU & callProceedingPDU   
    );

    virtual BOOL OnSendReleaseComplete(
      H323SignalPDU & releaseCompletePDU 
    );

    virtual BOOL OnAlerting(
      const H323SignalPDU & alertingPDU,  
      const PString & user                
    );

    virtual BOOL OnInsufficientDigits();

    virtual void SendMoreDigits(
      const PString & digits    
    );

    virtual BOOL OnOutgoingCall(
      const H323SignalPDU & connectPDU   
    );

    virtual BOOL SendFastStartAcknowledge(
      H225_ArrayOf_PASN_OctetString & array   
    );

    virtual BOOL HandleFastStartAcknowledge(
      const H225_ArrayOf_PASN_OctetString & array   
    );

    virtual BOOL CreateOutgoingControlChannel(
      const H225_TransportAddress & h245Address   
    );

    virtual BOOL CreateIncomingControlChannel(
      H225_TransportAddress & h245Address  
    );

    virtual BOOL WriteControlPDU(
      const H323ControlPDU & pdu
    );

    virtual BOOL StartControlNegotiations();

    virtual void HandleControlChannel();

    virtual BOOL HandleControlData(
      PPER_Stream & strm
    );

    virtual BOOL HandleControlPDU(
      const H323ControlPDU & pdu
    );

    virtual BOOL OnUnknownControlPDU(
      const H323ControlPDU & pdu  
    );

    virtual BOOL OnH245Request(
      const H323ControlPDU & pdu  
    );

    virtual BOOL OnH245Response(
      const H323ControlPDU & pdu  
    );

    virtual BOOL OnH245Command(
      const H323ControlPDU & pdu  
    );

    virtual BOOL OnH245Indication(
      const H323ControlPDU & pdu  
    );

    virtual BOOL OnH245_SendTerminalCapabilitySet(
      const H245_SendTerminalCapabilitySet & pdu  
    );

    virtual BOOL OnH245_FlowControlCommand(
      const H245_FlowControlCommand & pdu  
    );

    virtual BOOL OnH245_MiscellaneousCommand(
      const H245_MiscellaneousCommand & pdu  
    );

    virtual BOOL OnH245_MiscellaneousIndication(
      const H245_MiscellaneousIndication & pdu  
    );

    virtual BOOL OnH245_JitterIndication(
      const H245_JitterIndication & pdu  
    );

    enum ControlProtocolErrors {
      e_MasterSlaveDetermination,
      e_CapabilityExchange,
      e_LogicalChannel,
      e_ModeRequest,
      e_RoundTripDelay
    };

    virtual BOOL OnControlProtocolError(
      ControlProtocolErrors errorSource,  
      const void * errorData = NULL       
    );

    virtual void OnSendCapabilitySet(
      H245_TerminalCapabilitySet & pdu  
    );

    virtual BOOL OnReceivedCapabilitySet(
      const H323Capabilities & remoteCaps,      
      const H245_MultiplexCapability * muxCap,  
      H245_TerminalCapabilitySetReject & reject 
    );

    virtual void SendCapabilitySet(
      BOOL empty  
    );

    virtual void OnSetLocalCapabilities();

    BOOL IsH245Master() const;

    void StartRoundTripDelay();

    PTimeInterval GetRoundTripDelay() const;

    virtual void OnSelectLogicalChannels();

    virtual void SelectDefaultLogicalChannel(
      unsigned sessionID    
    );

    virtual void SelectFastStartChannels(
      unsigned sessionID,   
      BOOL transmitter,     
      BOOL receiver         
    );

    virtual void StartFastStartChannel(
      unsigned sessionID,               
      H323Channel::Directions direction 
    );

    virtual BOOL OpenLogicalChannel(
      const H323Capability & capability,  
      unsigned sessionID,                 
      H323Channel::Directions dir         
    );

    virtual BOOL OnOpenLogicalChannel(
      const H245_OpenLogicalChannel & openPDU,  
      H245_OpenLogicalChannelAck & ackPDU,      
      unsigned & errorCode                      
    );

    virtual BOOL OnConflictingLogicalChannel(
      H323Channel & channel    
    );

    virtual H323Channel * CreateLogicalChannel(
      const H245_OpenLogicalChannel & open, 
      BOOL startingFast,                    
      unsigned & errorCode                  
    );

    virtual H323Channel * CreateRealTimeLogicalChannel(
      const H323Capability & capability, 
      H323Channel::Directions dir,       
      unsigned sessionID,                
      const H245_H2250LogicalChannelParameters * param,
      RTP_QOS * rtpqos = NULL            
    );

    virtual BOOL OnCreateLogicalChannel(
      const H323Capability & capability,  
      H323Channel::Directions dir,        
      unsigned & errorCode                
    );

    virtual BOOL OnStartLogicalChannel(
      H323Channel & channel    
    );

    virtual void CloseLogicalChannel(
      unsigned number,    
      BOOL fromRemote     
    );

    virtual void CloseLogicalChannelNumber(
      const H323ChannelNumber & number    
    );

    virtual void CloseAllLogicalChannels(
      BOOL fromRemote     
    );

    virtual void OnClosedLogicalChannel(
      const H323Channel & channel   
    );

    virtual BOOL OnClosingLogicalChannel(
      H323Channel & channel   
    );

    virtual void OnLogicalChannelFlowControl(
      H323Channel * channel,   
      long bitRateRestriction  
    );

    virtual void OnLogicalChannelJitter(
      H323Channel * channel,   
      DWORD jitter,            
      int skippedFrameCount,   
      int additionalBuffer     
    );

    H323Channel * GetLogicalChannel(
      unsigned number,    
      BOOL fromRemote     
    ) const;

    H323Channel * FindChannel(
      unsigned sessionId,   
      BOOL fromRemote       
    ) const;

    virtual BOOL SetBandwidthAvailable(
      unsigned newBandwidth,    
      BOOL force = FALSE        
    );

    virtual unsigned GetBandwidthUsed() const;

    virtual SendUserInputModes GetRealSendUserInputMode() const;

    virtual BOOL SendUserInputString(
      const PString & value                   
    );

    virtual BOOL SendUserInputTone(
      char tone,             
      unsigned duration = 0  
    );

    virtual BOOL SendUserInputIndicationQ931(
      const PString & value                   
    );

    virtual BOOL SendUserInputIndicationString(
      const PString & value                   
    );

    virtual BOOL SendUserInputIndicationTone(
      char tone,                   
      unsigned duration = 0,       
      unsigned logicalChannel = 0, 
      unsigned rtpTimestamp = 0    
    );

    virtual BOOL SendUserInputIndication(
      const H245_UserInputIndication & pdu    
    );

    virtual void OnUserInputIndication(
      const H245_UserInputIndication & pdu  
    );

    virtual H323_RTP_Session * GetSessionCallbacks(
      unsigned sessionID
    ) const;

    virtual RTP_Session * UseSession(
      const OpalTransport & transport,
      unsigned sessionID,
      RTP_QOS * rtpqos = NULL
    );

    virtual void ReleaseSession(
      unsigned sessionID
    );

    virtual void OnRTPStatistics(
      const RTP_Session & session   
    ) const;

    virtual PString GetSessionCodecNames(
      unsigned sessionID
    ) const;


    virtual BOOL RequestModeChange(
      const PString & newModes  
    );

    virtual BOOL RequestModeChange(
      const H245_ArrayOf_ModeDescription & newModes  
    );

    virtual BOOL OnRequestModeChange(
      const H245_RequestMode & pdu,     
      H245_RequestModeAck & ack,        
      H245_RequestModeReject & reject,  
      PINDEX & selectedMode           
    );

    virtual void OnModeChanged(
      const H245_ModeDescription & newMode
    );

    virtual void OnAcceptModeChange(
      const H245_RequestModeAck & pdu  
    );

    virtual void OnRefusedModeChange(
      const H245_RequestModeReject * pdu  
    );

    virtual BOOL RequestModeChangeT38(
      const char * capabilityNames = "T.38\nT38FaxUDP"
    );

    virtual BOOL GetAdmissionRequestAuthentication(
      const H225_AdmissionRequest & arq,  
      H235Authenticators & authenticators 
    );

    H323EndPoint & GetEndPoint() const { return endpoint; }

    BOOL HadAnsweredCall() const { return !originating; }

    BOOL IsGatekeeperRouted() const { return gatekeeperRouted; }

    unsigned GetDistinctiveRing() const { return distinctiveRing; }

    void SetDistinctiveRing(unsigned pattern) { distinctiveRing = pattern&7; }

    const PString & GetCallToken() const { return GetToken(); }

    unsigned GetCallReference() const { return callReference; }

    inline const OpalGloballyUniqueID & GetCallIdentifier() const 
    { return GetIdentifier(); }

    const OpalGloballyUniqueID & GetConferenceIdentifier() const { return conferenceIdentifier; }

    void SetLocalPartyName(const PString & name);

    const PStringList & GetLocalAliasNames() const { return localAliasNames; }

    virtual void SetRemotePartyInfo(
      const H323SignalPDU & pdu 
    );

    void SetRemoteApplication(
      const H225_EndpointType & pdu 
    );
    
    const PString GetRemotePartyCallbackURL() const;
    
    const H323Capabilities & GetLocalCapabilities() const { return localCapabilities; }

    const H323Capabilities & GetRemoteCapabilities() const { return remoteCapabilities; }

    unsigned GetRemoteMaxAudioDelayJitter() const { return remoteMaxAudioDelayJitter; }

    const H323Transport * GetSignallingChannel() const { return signallingChannel; }

    unsigned GetSignallingVersion() const { return h225version; }

    const H323Transport & GetControlChannel() const;

    OpalTransport & GetTransport() const;

    unsigned GetControlVersion() const { return h245version; }

    unsigned GetUUIEsRequested() const { return uuiesRequested; }

    void SetUUIEsRequested(unsigned mask) { uuiesRequested = mask; }

    const PString GetGkAccessTokenOID() const { return gkAccessTokenOID; }

    void SetGkAccessTokenOID(const PString & oid) { gkAccessTokenOID = oid; }

    const PBYTEArray & GetGkAccessTokenData() const { return gkAccessTokenData; }

    void SetDestExtraCallInfo(
      const PString & info
    ) { destExtraCallInfo = info; }

    void SetRemotCallWaiting(const unsigned value) { remoteCallWaiting = value; }

    const int GetRemoteCallWaiting() const { return remoteCallWaiting; }

    void SetEnforcedDurationLimit(
      unsigned seconds  
    );
        
    virtual BOOL OnSendFeatureSet(unsigned, H225_FeatureSet &) const;
        
        virtual void OnReceiveFeatureSet(unsigned, const H225_FeatureSet &) const;

#if H323_H460

    virtual H460_FeatureSet * GetFeatureSet();
#endif

    
#if OPAL_H450
    H4507Handler&  getH4507handler(){return *h4507handler;}
#endif

    virtual BOOL OnOpenIncomingMediaChannels();

  protected:
    virtual void InternalEstablishedConnectionCheck();
    BOOL InternalEndSessionCheck(PPER_Stream & strm);
    void SetRemoteVersions(const H225_ProtocolIdentifier & id);
    void MonitorCallStatus();
    PDECLARE_NOTIFIER(PThread, H323Connection, StartOutgoing);
    PDECLARE_NOTIFIER(PThread, H323Connection, NewOutgoingControlChannel);
    PDECLARE_NOTIFIER(PThread, H323Connection, NewIncomingControlChannel);

    H323EndPoint & endpoint;

    int                  remoteCallWaiting; // Number of call's waiting at the remote endpoint
    BOOL                 gatekeeperRouted;
    unsigned             distinctiveRing;
    unsigned             callReference;
    OpalGloballyUniqueID conferenceIdentifier;

    PString            localDestinationAddress;
    PStringList        localAliasNames;
    H323Capabilities   localCapabilities; // Capabilities local system supports
    PString            destExtraCallInfo;
    H323Capabilities   remoteCapabilities; // Capabilities remote system supports
    unsigned           remoteMaxAudioDelayJitter;
    PTimer             roundTripDelayTimer;
    WORD               maxAudioDelayJitter;
    unsigned           uuiesRequested;
    PString            gkAccessTokenOID;
    PBYTEArray         gkAccessTokenData;
    BOOL               addAccessTokenToSetup;
    BOOL               alertDone;

    H323Transport * signallingChannel;
    H323Transport * controlChannel;
    OpalListener  * controlListener;
    BOOL            h245Tunneling;
    H323SignalPDU * h245TunnelRxPDU;
    H323SignalPDU * h245TunnelTxPDU;
    H323SignalPDU * setupPDU;
    H323SignalPDU * alertingPDU;
    H323SignalPDU * connectPDU;
    H323SignalPDU * progressPDU;

    enum ConnectionStates {
      NoConnectionActive,
      AwaitingGatekeeperAdmission,
      AwaitingTransportConnect,
      AwaitingSignalConnect,
      AwaitingLocalAnswer,
      HasExecutedSignalConnect,
      EstablishedConnection,
      ShuttingDownConnection,
      NumConnectionStates
    } connectionState;

    unsigned   h225version;
    unsigned   h245version;
    BOOL       h245versionSet;
    BOOL doH245inSETUP;
    BOOL lastPDUWasH245inSETUP;

    BOOL mustSendDRQ;
    BOOL mediaWaitForConnect;
    BOOL transmitterSidePaused;
    BOOL earlyStart;
#if OPAL_T120
    BOOL startT120;
#endif
#if OPAL_H224
    BOOL startH224;
#endif
    PString    t38ModeChangeCapabilities;
    PSyncPoint digitsWaitFlag;
    BOOL       endSessionNeeded;
    PSyncPoint endSessionReceived;
    PTimer     enforcedDurationLimit;

    // Used as part of a local call hold operation involving MOH
    PChannel * holdMediaChannel;
    BOOL       isConsultationTransfer;

    BOOL     isCallIntrusion;
    unsigned callIntrusionProtectionLevel;

    enum FastStartStates {
      FastStartDisabled,
      FastStartInitiate,
      FastStartResponse,
      FastStartAcknowledged,
      NumFastStartStates
    };
    FastStartStates        fastStartState;
    H323LogicalChannelList fastStartChannels;
    OpalMediaStream      * transmitterMediaStream;

#if PTRACING
    static const char * GetConnectionStatesName(ConnectionStates s);
    friend ostream & operator<<(ostream & o, ConnectionStates s) { return o << GetConnectionStatesName(s); }
    static const char * GetFastStartStateName(FastStartStates s);
    friend ostream & operator<<(ostream & o, FastStartStates s) { return o << GetFastStartStateName(s); }
#endif


    // The following pointers are to protocol procedures, they are pointers to
    // hide their complexity from the H323Connection classes users.
    H245NegMasterSlaveDetermination  * masterSlaveDeterminationProcedure;
    H245NegTerminalCapabilitySet     * capabilityExchangeProcedure;
    H245NegLogicalChannels           * logicalChannels;
    H245NegRequestMode               * requestModeProcedure;
    H245NegRoundTripDelay            * roundTripDelayProcedure;

#if OPAL_H450
    H450xDispatcher                  * h450dispatcher;
    H4502Handler                     * h4502handler;
    H4504Handler                     * h4504handler;
    H4506Handler                     * h4506handler;
    H4507Handler                     * h4507handler;
    H45011Handler                    * h45011handler;
#endif

#ifdef H323_H460
        H460_FeatureSet & features;
#endif

    virtual OpalMediaStream * InternalCreateMediaStream(const OpalMediaFormat & mediaFormat, unsigned sessionID, BOOL isSource);

  private:
    PChannel * SwapHoldMediaChannels(PChannel * newChannel);
};


PDICTIONARY(H323CallIdentityDict, PString, H323Connection);


#endif // __OPAL_H323CON_H

---