gkserver.h

Go to the documentation of this file.

/*
 * gkserver.h
 *
 * H225 Registration Admission and Security 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.
 *
 * This code was based on original code from OpenGate of Egoboo Ltd. thanks
 * to Ashley Unitt for his efforts.
 *
 * Contributor(s): ______________________________________.
 */

#ifndef OPAL_H323_GKSERVER_H
#define OPAL_H323_GKSERVER_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal_config.h>

#if OPAL_H323

#include <ptlib/safecoll.h>
#include <opal/guid.h>
#include <h323/h225ras.h>
#include <h323/transaddr.h>
#include <h323/h235auth.h>
#include <h323/h323pdu.h>
#include <h323/h323trans.h>


class PASN_Sequence;
class PASN_Choice;

class H225_AliasAddress;
class H225_EndpointIdentifier;
class H225_GatekeeperIdentifier;
class H225_ArrayOf_TransportAddress;
class H225_GatekeeperIdentifier;
class H225_EndpointIdentifier;
class H225_InfoRequestResponse_perCallInfo_subtype;
class H225_RasUsageInformation;

class H323RegisteredEndPoint;
class H323GatekeeperListener;
class H323GatekeeperServer;
class H323RasPDU;

#if OPAL_H501
class H323PeerElement;
#endif

class H323GatekeeperRequest : public H323Transaction
{
    PCLASSINFO(H323GatekeeperRequest, H323Transaction);
  public:
    H323GatekeeperRequest(
      H323GatekeeperListener & rasChannel,
      const H323RasPDU & pdu
    );

    virtual H323TransactionPDU * CreateRIP(
      unsigned sequenceNumber,
      unsigned delay
    ) const;

    virtual PBoolean WritePDU(
      H323TransactionPDU & pdu
    );
    virtual bool CheckCryptoTokens();
    bool CheckGatekeeperIdentifier();
    bool GetRegisteredEndPoint();

    virtual PString GetGatekeeperIdentifier() const = 0;
    virtual unsigned GetGatekeeperRejectTag() const = 0;
    virtual PString GetEndpointIdentifier() const = 0;
    virtual unsigned GetRegisteredEndPointRejectTag() const = 0;

    H323GatekeeperListener & GetRasChannel() const { return m_rasChannel; }

    PSafePtr<H323RegisteredEndPoint> m_endpoint;

  protected:
    H323GatekeeperListener & m_rasChannel;
};


class H323GatekeeperGRQ : public H323GatekeeperRequest
{
    PCLASSINFO(H323GatekeeperGRQ, H323GatekeeperRequest);
  public:
    H323GatekeeperGRQ(
      H323GatekeeperListener & listener,
      const H323RasPDU & pdu
    );

#if PTRACING
    virtual const char * GetName() const;
#endif
    virtual PString GetGatekeeperIdentifier() const;
    virtual unsigned GetGatekeeperRejectTag() const;
    virtual PString GetEndpointIdentifier() const;
    virtual unsigned GetRegisteredEndPointRejectTag() const;
    virtual void PrepareConfirm();
    virtual H235Authenticator::ValidationResult ValidatePDU() const;
    virtual unsigned GetSecurityRejectTag() const;
    virtual void SetRejectReason(
      unsigned reasonCode
    );

    H225_GatekeeperRequest & grq;
    H225_GatekeeperConfirm & gcf;
    H225_GatekeeperReject  & grj;

  protected:
    virtual Response OnHandlePDU();
};


class H323GatekeeperRRQ : public H323GatekeeperRequest
{
    PCLASSINFO(H323GatekeeperRRQ, H323GatekeeperRequest);
  public:
    H323GatekeeperRRQ(
      H323GatekeeperListener & listener,
      const H323RasPDU & pdu
    );

#if PTRACING
    virtual const char * GetName() const;
#endif
    virtual PString GetGatekeeperIdentifier() const;
    virtual unsigned GetGatekeeperRejectTag() const;
    virtual PString GetEndpointIdentifier() const;
    virtual unsigned GetRegisteredEndPointRejectTag() const;
    virtual H235Authenticator::ValidationResult ValidatePDU() const;
    virtual unsigned GetSecurityRejectTag() const;
    virtual void SetRejectReason(
      unsigned reasonCode
    );

    H225_RegistrationRequest & rrq;
    H225_RegistrationConfirm & rcf;
    H225_RegistrationReject  & rrj;

  protected:
    virtual Response OnHandlePDU();
};


class H323GatekeeperURQ : public H323GatekeeperRequest
{
    PCLASSINFO(H323GatekeeperURQ, H323GatekeeperRequest);
  public:
    H323GatekeeperURQ(
      H323GatekeeperListener & listener,
      const H323RasPDU & pdu
    );

#if PTRACING
    virtual const char * GetName() const;
#endif
    virtual PString GetGatekeeperIdentifier() const;
    virtual unsigned GetGatekeeperRejectTag() const;
    virtual PString GetEndpointIdentifier() const;
    virtual unsigned GetRegisteredEndPointRejectTag() const;
    virtual H235Authenticator::ValidationResult ValidatePDU() const;
    virtual unsigned GetSecurityRejectTag() const;
    virtual void SetRejectReason(
      unsigned reasonCode
    );

    H225_UnregistrationRequest & urq;
    H225_UnregistrationConfirm & ucf;
    H225_UnregistrationReject  & urj;

  protected:
    virtual Response OnHandlePDU();
};


class H323GatekeeperARQ : public H323GatekeeperRequest
{
    PCLASSINFO(H323GatekeeperARQ, H323GatekeeperRequest);
  public:
    H323GatekeeperARQ(
      H323GatekeeperListener & listener,
      const H323RasPDU & pdu
    );

#if PTRACING
    virtual const char * GetName() const;
#endif
    virtual PString GetGatekeeperIdentifier() const;
    virtual unsigned GetGatekeeperRejectTag() const;
    virtual PString GetEndpointIdentifier() const;
    virtual unsigned GetRegisteredEndPointRejectTag() const;
    virtual H235Authenticator::ValidationResult ValidatePDU() const;
    virtual unsigned GetSecurityRejectTag() const;
    virtual void SetRejectReason(
      unsigned reasonCode
    );

    H225_AdmissionRequest & arq;
    H225_AdmissionConfirm & acf;
    H225_AdmissionReject  & arj;

    PString alternateSecurityID;

  protected:
    virtual Response OnHandlePDU();
};


class H323GatekeeperDRQ : public H323GatekeeperRequest
{
    PCLASSINFO(H323GatekeeperDRQ, H323GatekeeperRequest);
  public:
    H323GatekeeperDRQ(
      H323GatekeeperListener & listener,
      const H323RasPDU & pdu
    );

#if PTRACING
    virtual const char * GetName() const;
#endif
    virtual PString GetGatekeeperIdentifier() const;
    virtual unsigned GetGatekeeperRejectTag() const;
    virtual PString GetEndpointIdentifier() const;
    virtual unsigned GetRegisteredEndPointRejectTag() const;
    virtual H235Authenticator::ValidationResult ValidatePDU() const;
    virtual unsigned GetSecurityRejectTag() const;
    virtual void SetRejectReason(
      unsigned reasonCode
    );

    H225_DisengageRequest & drq;
    H225_DisengageConfirm & dcf;
    H225_DisengageReject  & drj;

  protected:
    virtual Response OnHandlePDU();
};


class H323GatekeeperBRQ : public H323GatekeeperRequest
{
    PCLASSINFO(H323GatekeeperBRQ, H323GatekeeperRequest);
  public:
    H323GatekeeperBRQ(
      H323GatekeeperListener & listener,
      const H323RasPDU & pdu
    );

#if PTRACING
    virtual const char * GetName() const;
#endif
    virtual PString GetGatekeeperIdentifier() const;
    virtual unsigned GetGatekeeperRejectTag() const;
    virtual PString GetEndpointIdentifier() const;
    virtual unsigned GetRegisteredEndPointRejectTag() const;
    virtual H235Authenticator::ValidationResult ValidatePDU() const;
    virtual unsigned GetSecurityRejectTag() const;
    virtual void SetRejectReason(
      unsigned reasonCode
    );

    H225_BandwidthRequest & brq;
    H225_BandwidthConfirm & bcf;
    H225_BandwidthReject  & brj;

  protected:
    virtual Response OnHandlePDU();
};


class H323GatekeeperLRQ : public H323GatekeeperRequest
{
    PCLASSINFO(H323GatekeeperLRQ, H323GatekeeperRequest);
  public:
    H323GatekeeperLRQ(
      H323GatekeeperListener & listener,
      const H323RasPDU & pdu
    );

#if PTRACING
    virtual const char * GetName() const;
#endif
    virtual PString GetGatekeeperIdentifier() const;
    virtual unsigned GetGatekeeperRejectTag() const;
    virtual PString GetEndpointIdentifier() const;
    virtual unsigned GetRegisteredEndPointRejectTag() const;
    virtual H235Authenticator::ValidationResult ValidatePDU() const;
    virtual unsigned GetSecurityRejectTag() const;
    virtual void SetRejectReason(
      unsigned reasonCode
    );

    H225_LocationRequest & lrq;
    H225_LocationConfirm & lcf;
    H225_LocationReject  & lrj;

  protected:
    virtual Response OnHandlePDU();
};


class H323GatekeeperIRR : public H323GatekeeperRequest
{
    PCLASSINFO(H323GatekeeperIRR, H323GatekeeperRequest);
  public:
    H323GatekeeperIRR(
      H323GatekeeperListener & listener,
      const H323RasPDU & pdu
    );

#if PTRACING
    virtual const char * GetName() const;
#endif
    virtual PString GetGatekeeperIdentifier() const;
    virtual unsigned GetGatekeeperRejectTag() const;
    virtual PString GetEndpointIdentifier() const;
    virtual unsigned GetRegisteredEndPointRejectTag() const;
    virtual H235Authenticator::ValidationResult ValidatePDU() const;
    virtual unsigned GetSecurityRejectTag() const;
    virtual void SetRejectReason(
      unsigned reasonCode
    );

    H225_InfoRequestResponse & irr;
    H225_InfoRequestAck      & iack;
    H225_InfoRequestNak      & inak;

  protected:
    virtual Response OnHandlePDU();
};


class H323GatekeeperCall : public PSafeObject
{
    PCLASSINFO(H323GatekeeperCall, PSafeObject);
  public:
    enum Direction {
      AnsweringCall,
      OriginatingCall,
      UnknownDirection
    };

    H323GatekeeperCall(
      H323GatekeeperServer & server,               
      const OpalGloballyUniqueID & callIdentifier, 
      Direction direction                          
    );

    ~H323GatekeeperCall();

    Comparison Compare(
      const PObject & obj  
    ) const;

    void PrintOn(
      ostream & strm    
    ) const;

    virtual H323GatekeeperRequest::Response OnAdmission(
      H323GatekeeperARQ & request
    );

    virtual PBoolean Disengage(
      int reason = -1   
    );

    virtual H323GatekeeperRequest::Response OnDisengage(
      H323GatekeeperDRQ & request
    );

    virtual H323GatekeeperRequest::Response OnBandwidth(
      H323GatekeeperBRQ & request
    );

    virtual H323GatekeeperRequest::Response OnInfoResponse(
      H323GatekeeperIRR & request,
      H225_InfoRequestResponse_perCallInfo_subtype & call
    );

    virtual void OnAlerting();

    virtual void OnConnected();

    virtual PBoolean OnHeartbeat();

    virtual PString GetCallCreditAmount() const;

    virtual PBoolean GetCallCreditMode() const;

    virtual unsigned GetDurationLimit() const;

    virtual PBoolean SendCallCreditServiceControl();

    bool AddCallCreditServiceControl(
      H225_ArrayOf_ServiceControlSession & serviceControl
    ) const;

    virtual PBoolean SendServiceControlSession(
      const H323ServiceControlSession & session
    );

    virtual PBoolean TranslateAliasAddress(
      const H225_AliasAddress & alias,
      H225_ArrayOf_AliasAddress & aliases,
      H323TransportAddress & address,
      PBoolean & isGkRouted
    );


    H323GatekeeperServer & GetGatekeeper() const { return m_gatekeeper; }
    H323RegisteredEndPoint & GetEndPoint() const { return *PAssertNULL(m_endpoint); }
    bool IsAnsweringCall() const { return m_direction == AnsweringCall; }
    unsigned GetCallReference() const { return m_callReference; }
    const OpalGloballyUniqueID & GetCallIdentifier() const { return m_callIdentifier; }
    const OpalGloballyUniqueID & GetConferenceIdentifier() const { return m_conferenceIdentifier; }
    const PString & GetSourceNumber() const { return m_srcNumber; }
    const PStringArray & GetSourceAliases() const { return m_srcAliases; }
    const H323TransportAddress & GetSourceHost() const { return m_srcHost; }
    PString GetSourceAddress() const;
    const PString & GetDestinationNumber() const { return m_dstNumber; }
    const PStringArray & GetDestinationAliases() const { return m_dstAliases; }
    const H323TransportAddress & GetDestinationHost() const { return m_dstHost; }
    PString GetDestinationAddress() const;
    unsigned GetBandwidthUsed() const { return m_bandwidthUsed; }
    bool SetBandwidthUsed(unsigned bandwidth);
    const PTime & GetLastInfoResponseTime() const { return m_lastInfoResponse; }
    const PTime & GetCallStartTime() const { return m_callStartTime; }
    const PTime & GetAlertingTime() const { return m_alertingTime; }
    const PTime & GetConnectedTime() const { return m_connectedTime; }
    const PTime & GetCallEndTime() const { return m_callEndTime; }
    H323Connection::CallEndReason GetCallEndReason() const { return m_callEndReason; }

  protected:
    void SetUsageInfo(const H225_RasUsageInformation & usage);

    H323GatekeeperServer   & m_gatekeeper;
    H323RegisteredEndPoint * m_endpoint;
    H323GatekeeperListener * m_rasChannel;

    Direction            m_direction;
    unsigned             m_callReference;
    OpalGloballyUniqueID m_callIdentifier;
    OpalGloballyUniqueID m_conferenceIdentifier;
    PString              m_srcNumber;
    PStringArray         m_srcAliases;
    H323TransportAddress m_srcHost;
    PString              m_dstNumber;
    PStringArray         m_dstAliases;
    H323TransportAddress m_dstHost;
    unsigned             m_bandwidthUsed;
    unsigned             m_infoResponseRate;
    PTime                m_lastInfoResponse;

    bool                          m_drqReceived;
    PTime                         m_callStartTime;
    PTime                         m_alertingTime;
    PTime                         m_connectedTime;
    PTime                         m_callEndTime;
    H323Connection::CallEndReason m_callEndReason;
};


class H323RegisteredEndPoint : public PSafeObject
{
    PCLASSINFO(H323RegisteredEndPoint, PSafeObject);
  public:
    H323RegisteredEndPoint(
      H323GatekeeperServer & server, 
      const PString & id             
    );

    Comparison Compare(
      const PObject & obj  
    ) const;

    void PrintOn(
      ostream & strm    
    ) const;

    virtual void AddCall(
      H323GatekeeperCall * call
    );

    virtual PBoolean RemoveCall(
      H323GatekeeperCall * call
    );

    PINDEX GetCallCount() const { return m_activeCalls.GetSize(); }

    H323GatekeeperCall & GetCall(
      PINDEX idx
    ) { return m_activeCalls[idx]; }

    virtual H323GatekeeperRequest::Response OnRegistration(
      H323GatekeeperRRQ & request
    );

    virtual H323GatekeeperRequest::Response OnFullRegistration(
      H323GatekeeperRRQ & request
    );

    virtual H323GatekeeperRequest::Response OnSecureRegistration(
      H323GatekeeperRRQ & request
    );

    virtual H323GatekeeperRequest::Response OnUnregistration(
      H323GatekeeperURQ & request
    );

    virtual PBoolean Unregister(
      int reason = -1   
    );

    virtual H323GatekeeperRequest::Response OnInfoResponse(
      H323GatekeeperIRR & request
    );

    virtual PBoolean OnTimeToLive();

    virtual PString GetCallCreditAmount() const;

    virtual PBoolean GetCallCreditMode() const;

    virtual PBoolean SendServiceControlSession(
      const H323ServiceControlSession & session
    );

    virtual PBoolean AddServiceControlSession(
      const H323ServiceControlSession & session,
      H225_ArrayOf_ServiceControlSession & serviceControl
    );

    virtual PBoolean SetPassword(
      const PString & password,
      const PString & username = PString::Empty()
    );

    const PString & GetIdentifier() const { return m_identifier; }

    const OpalGloballyUniqueID & GetDescriptorID() const { return m_descriptorID; }

    H323GatekeeperServer & GetGatekeeper() const { return m_gatekeeper; }

    const H323TransportAddressArray & GetRASAddresses() const { return m_rasAddresses; }

    PINDEX GetRASAddressCount() const { return m_rasAddresses.GetSize(); }

    H323TransportAddress GetRASAddress(
      PINDEX idx
    ) const { return m_rasAddresses[idx]; }

    const H323TransportAddressArray & GetSignalAddresses() const { return m_signalAddresses; }

    PINDEX GetSignalAddressCount() const { return m_signalAddresses.GetSize(); }

    H323TransportAddress GetSignalAddress(
      PINDEX idx
    ) const { return m_signalAddresses[idx]; }

    const PStringArray & GetAliases() const { return m_aliases; }

    bool ContainsAlias(
      const PString & alias
      ) { return m_aliases.GetStringsIndex(alias) != P_MAX_INDEX; }

    PINDEX GetAliasCount() const { return m_aliases.GetSize(); }

    PString GetAlias(
      PINDEX idx
    ) const { if (idx < m_aliases.GetSize()) return m_aliases[idx]; return PString::Empty(); }

    void RemoveAlias(
      const PString & alias
    );

    virtual const H235Authenticators & GetAuthenticators() const { return m_authenticators; }

    PINDEX GetPrefixCount() const { return m_voicePrefixes.GetSize(); }

    PString GetPrefix(
      PINDEX idx
    ) const { return m_voicePrefixes[idx]; }

    PCaselessString GetApplicationInfo() const { return m_productInfo.AsString(); }

    const OpalProductInfo & GetProductInfo() const { return m_productInfo; }

    unsigned GetProtocolVersion() const { return m_protocolVersion; }

    bool IsBehindNAT() const { return m_isBehindNAT; }

    bool CanDisplayAmountString() const { return m_canDisplayAmountString; }

    bool CanEnforceDurationLimit() const { return m_canEnforceDurationLimit; }

    bool CanReceiveRIP() const;

    bool GetH225Version() const { return m_h225Version; }

    const PTime & GetCreationTime() const { return m_creationTime; }

      virtual PBoolean OnSendDescriptorForEndpoint(
        H225_ArrayOf_AliasAddress & aliases,          
        H225_EndpointType & terminalType,             
        H225_ArrayOf_AliasAddress & transportAddresses  
      );


  protected:
    H323GatekeeperServer    & m_gatekeeper;
    H323GatekeeperListener  * m_rasChannel;

    PString                   m_identifier;
    OpalGloballyUniqueID      m_descriptorID;
    H323TransportAddressArray m_rasAddresses;
    H323TransportAddressArray m_signalAddresses;
    PStringArray              m_aliases;
    PStringArray              m_voicePrefixes;
    OpalProductInfo           m_productInfo;
    unsigned                  m_protocolVersion;
    bool                      m_isBehindNAT;
    bool                      m_canDisplayAmountString;
    bool                      m_canEnforceDurationLimit;
    unsigned                  m_h225Version;
    unsigned                  m_timeToLive;
    H235Authenticators        m_authenticators;

    PTime m_creationTime;
    PTime m_lastRegistration;
    PTime m_lastInfoResponse;

    PSortedList<H323GatekeeperCall> m_activeCalls;
    POrdinalDictionary<PString>     m_serviceControlSessions;
};


class H323GatekeeperListener : public H225_RAS
{
    PCLASSINFO(H323GatekeeperListener, H225_RAS);
  public:
    H323GatekeeperListener(
      H323EndPoint & endpoint,               
      H323GatekeeperServer & server,         
      const PString & gatekeeperIdentifier,  
      H323Transport * transport = NULL       
    );

    ~H323GatekeeperListener();

    void PrintOn(
      ostream & strm    
    ) const;

    virtual PBoolean UnregistrationRequest(
      const H323RegisteredEndPoint & ep,
      unsigned reason
    );

    virtual PBoolean DisengageRequest(
      const H323GatekeeperCall & call,
      unsigned reason
    );

    virtual PBoolean InfoRequest(
      H323RegisteredEndPoint & ep,
      H323GatekeeperCall * call = NULL
    );

    virtual PBoolean ServiceControlIndication(
      H323RegisteredEndPoint & ep,
      const H323ServiceControlSession & session,
      H323GatekeeperCall * call = NULL
    );

    virtual H323GatekeeperRequest::Response OnDiscovery(
      H323GatekeeperGRQ & request
    );

    virtual H323GatekeeperRequest::Response OnRegistration(
      H323GatekeeperRRQ & request
    );

    virtual H323GatekeeperRequest::Response OnUnregistration(
      H323GatekeeperURQ & request
    );

    virtual H323GatekeeperRequest::Response OnAdmission(
      H323GatekeeperARQ & request
    );

    virtual H323GatekeeperRequest::Response OnDisengage(
      H323GatekeeperDRQ & request
    );

    virtual H323GatekeeperRequest::Response OnBandwidth(
      H323GatekeeperBRQ & request
    );

    virtual H323GatekeeperRequest::Response OnLocation(
      H323GatekeeperLRQ & request
    );

    virtual H323GatekeeperRequest::Response OnInfoResponse(
      H323GatekeeperIRR & request
    );

    virtual PBoolean OnReceiveGatekeeperRequest(const H323RasPDU &, const H225_GatekeeperRequest &);
    virtual PBoolean OnReceiveRegistrationRequest(const H323RasPDU &, const H225_RegistrationRequest &);
    virtual PBoolean OnReceiveUnregistrationRequest(const H323RasPDU &, const H225_UnregistrationRequest &);
    virtual PBoolean OnReceiveUnregistrationConfirm(const H225_UnregistrationConfirm &);
    virtual PBoolean OnReceiveUnregistrationReject(const H225_UnregistrationReject &);
    virtual PBoolean OnReceiveAdmissionRequest(const H323RasPDU &, const H225_AdmissionRequest &);
    virtual PBoolean OnReceiveBandwidthRequest(const H323RasPDU &, const H225_BandwidthRequest &);
    virtual PBoolean OnReceiveBandwidthConfirm(const H225_BandwidthConfirm &);
    virtual PBoolean OnReceiveBandwidthReject(const H225_BandwidthReject &);
    virtual PBoolean OnReceiveDisengageRequest(const H323RasPDU &, const H225_DisengageRequest &);
    virtual PBoolean OnReceiveDisengageConfirm(const H225_DisengageConfirm &);
    virtual PBoolean OnReceiveDisengageReject(const H225_DisengageReject &);
    virtual PBoolean OnReceiveLocationRequest(const H323RasPDU &, const H225_LocationRequest &);
    virtual PBoolean OnReceiveInfoRequestResponse(const H323RasPDU &, const H225_InfoRequestResponse &);
    virtual PBoolean OnReceiveResourcesAvailableConfirm(const H225_ResourcesAvailableConfirm &);
#if OPAL_H460
    virtual PBoolean OnSendFeatureSet(H460_MessageType pduType, H225_FeatureSet & features) const;
    virtual void OnReceiveFeatureSet(H460_MessageType pduType, const H225_FeatureSet & features) const;
#endif


    H323GatekeeperServer & GetGatekeeper() const { return m_gatekeeper; }


  protected:
    H323GatekeeperServer & m_gatekeeper;
};


class H323GatekeeperServer : public H323TransactionServer
{
    PCLASSINFO(H323GatekeeperServer, H323TransactionServer);
  public:
    H323GatekeeperServer(
      H323EndPoint & endpoint
    );

    ~H323GatekeeperServer();

    WORD GetDefaultUdpPort() { return H225_RAS::DefaultRasUdpPort; }

    virtual H323Transactor * CreateListener(
      H323Transport * transport  
    );


    virtual H323GatekeeperRequest::Response OnDiscovery(
      H323GatekeeperGRQ & request
    );

    virtual H323GatekeeperRequest::Response OnRegistration(
      H323GatekeeperRRQ & request
    );

    virtual H323GatekeeperRequest::Response OnUnregistration(
      H323GatekeeperURQ & request
    );

    virtual H323GatekeeperRequest::Response OnInfoResponse(
      H323GatekeeperIRR & request
    );

    virtual void AddEndPoint(
      H323RegisteredEndPoint * ep
    );

    virtual PBoolean RemoveEndPoint(
      H323RegisteredEndPoint * ep
    );

    virtual H323RegisteredEndPoint * CreateRegisteredEndPoint(
      H323GatekeeperRequest & request
    );

    virtual PString CreateEndPointIdentifier();

    virtual PSafePtr<H323RegisteredEndPoint> FindEndPointByIdentifier(
      const PString & identifier,
      PSafetyMode mode = PSafeReference
    );

    virtual PSafePtr<H323RegisteredEndPoint> FindEndPointBySignalAddresses(
      const H225_ArrayOf_TransportAddress & addresses,
      PSafetyMode mode = PSafeReference
    );

    virtual PSafePtr<H323RegisteredEndPoint> FindEndPointBySignalAddress(
      const H323TransportAddress & address,
      PSafetyMode mode = PSafeReference
    );

    virtual PSafePtr<H323RegisteredEndPoint> FindEndPointByAliasAddress(
      const H225_AliasAddress & alias,
      PSafetyMode mode = PSafeReadWrite
    );

    virtual PSafePtr<H323RegisteredEndPoint> FindEndPointByAliasString(
      const PString & alias,
      PSafetyMode mode = PSafeReference
    );

    virtual PSafePtr<H323RegisteredEndPoint> FindEndPointByPartialAlias(
      const PString & alias,
      PSafetyMode mode = PSafeReference
    );

    virtual PSafePtr<H323RegisteredEndPoint> FindEndPointByPrefixString(
      const PString & prefix,
      PSafetyMode mode = PSafeReference
    );

    PSafePtr<H323RegisteredEndPoint> GetFirstEndPoint(
      PSafetyMode mode = PSafeReference
    ) { return PSafePtr<H323RegisteredEndPoint>(m_byIdentifier, mode); }

    PSafePtr<H323RegisteredEndPoint> FindDestinationEndPoint(
      const OpalGloballyUniqueID & id, 
      H323GatekeeperCall::Direction direction
    );
    
    virtual H323GatekeeperRequest::Response OnAdmission(
      H323GatekeeperARQ & request
    );

    virtual H323GatekeeperRequest::Response OnDisengage(
      H323GatekeeperDRQ & request
    );

    virtual H323GatekeeperRequest::Response OnBandwidth(
      H323GatekeeperBRQ & request
    );

    virtual H323GatekeeperCall * CreateCall(
      const OpalGloballyUniqueID & callIdentifier,
      H323GatekeeperCall::Direction direction
    );

    virtual void AddCall(H323GatekeeperCall *) 
    { }

    virtual void RemoveCall(
      H323GatekeeperCall * call
    );

    virtual PSafePtr<H323GatekeeperCall> FindCall(
      const PString & description,
      PSafetyMode mode = PSafeReference
    );

    virtual PSafePtr<H323GatekeeperCall> FindCall(
      const OpalGloballyUniqueID & callIdentifier,
      PBoolean answeringCall,
      PSafetyMode mode = PSafeReference
    );

    virtual PSafePtr<H323GatekeeperCall> FindCall(
      const OpalGloballyUniqueID & callIdentifier,
      H323GatekeeperCall::Direction direction,
      PSafetyMode mode = PSafeReference
    );

    PSafePtr<H323GatekeeperCall> GetFirstCall(
      PSafetyMode mode = PSafeReference
    ) { return PSafePtr<H323GatekeeperCall>(m_activeCalls, mode); }

    virtual H323GatekeeperRequest::Response OnLocation(
      H323GatekeeperLRQ & request
    );

    virtual PBoolean TranslateAliasAddress(
      const H225_AliasAddress & alias,
      H225_ArrayOf_AliasAddress & aliases,
      H323TransportAddress & address,
      PBoolean & isGkRouted,
      H323GatekeeperCall * call
    );

    virtual PBoolean TranslateAliasAddressToSignalAddress(
      const H225_AliasAddress & alias,
      H323TransportAddress & address
    );

    virtual PBoolean CheckSignalAddressPolicy(
      const H323RegisteredEndPoint & ep,
      const H225_AdmissionRequest & arq,
      const H323TransportAddress & address
    );

    virtual PBoolean CheckAliasAddressPolicy(
      const H323RegisteredEndPoint & ep,
      const H225_AdmissionRequest & arq,
      const H225_AliasAddress & alias
    );

    virtual PBoolean CheckAliasStringPolicy(
      const H323RegisteredEndPoint & ep,
      const H225_AdmissionRequest & arq,
      const PString & alias
    );

    virtual unsigned AllocateBandwidth(
      unsigned newBandwidth,
      unsigned oldBandwidth = 0
    );

    virtual PBoolean GetAdmissionRequestAuthentication(
      H323GatekeeperARQ & info,           
      H235Authenticators & authenticators 
    );

    virtual PBoolean GetUsersPassword(
      const PString & alias,
      PString & password,
      H323RegisteredEndPoint & registeredEndpoint
    ) const;
    virtual PBoolean GetUsersPassword(
      const PString & alias,
      PString & password
    ) const;
    virtual void SetUsersPassword(
      const PString & alias,
      const PString & password
    );
    virtual void ClearPasswords() { m_passwords.RemoveAll(); }

#if OPAL_H501

    H323PeerElement * GetPeerElement() const { return m_peerElement; }

    void SetPeerElement(
      H323PeerElement * newPeerElement
    );

    void CreatePeerElement(
      const H323TransportAddress & h501Interface
    );

    bool OpenPeerElement(
      const H323TransportAddress & remotePeer,
      bool append = false,
      bool keepTrying = true
    );
#endif

    const PString & GetGatekeeperIdentifier() const { return m_gatekeeperIdentifier; }

    void SetGatekeeperIdentifier(
      const PString & id,
      bool adjustListeners = true
    );

    unsigned GetAvailableBandwidth() const { return m_totalBandwidth; }

    void SetAvailableBandwidth(unsigned bps100) { m_totalBandwidth = bps100; }

    unsigned GetUsedBandwidth() const { return m_usedBandwidth; }

    unsigned GetDefaultBandwidth() const { return m_defaultBandwidth; }
    void SetDefaultBandwidth(unsigned bw) { m_defaultBandwidth = bw; }

    unsigned GetMaximumBandwidth() const { return m_maximumBandwidth; }
    void SetMaximumBandwidth(unsigned bw) { m_maximumBandwidth = bw; }

    unsigned GetTimeToLive() const { return m_defaultTimeToLive; }

    void SetTimeToLive(unsigned seconds) { m_defaultTimeToLive = seconds; }

    unsigned GetInfoResponseRate() const { return m_defaultInfoResponseRate; }

    void SetInfoResponseRate(unsigned seconds) { m_defaultInfoResponseRate = seconds; }

    bool GetOverwriteOnSameSignalAddress() const { return m_overwriteOnSameSignalAddress; }
    void SetOverwriteOnSameSignalAddress(bool v) { m_overwriteOnSameSignalAddress = v; }

    unsigned GetMinAliasToAllocate() const { return m_minAliasToAllocate; }
    void SetMinAliasToAllocate(unsigned v) { m_minAliasToAllocate = v; }

    unsigned GetMaxAliasToAllocate() const { return m_maxAliasToAllocate; }
    void SetMaxAliasToAllocate(unsigned v) { m_maxAliasToAllocate = v; }

    bool GetCanHaveDuplicateAlias() const { return m_canHaveDuplicateAlias; }
    void SetCanHaveDuplicateAlias(bool v) { m_canHaveDuplicateAlias = v; }

    bool GetCanHaveDuplicatePrefix() const { return m_canHaveDuplicatePrefix; }
    void SetCanHaveDuplicatePrefix(bool v) { m_canHaveDuplicatePrefix = v; }

    bool GetCanOnlyCallRegisteredEP() const { return m_canOnlyCallRegisteredEP; }
    void SetCanOnlyCallRegisteredEP(bool v) { m_canOnlyCallRegisteredEP = v; }

    bool GetCanOnlyAnswerRegisteredEP() const { return m_canOnlyAnswerRegisteredEP; }
    void SetCanOnlyAnswerRegisteredEP(bool v) { m_canOnlyAnswerRegisteredEP = v; }

    bool GetAnswerCallPreGrantedARQ() const { return m_answerCallPreGrantedARQ; }
    void SetAnswerCallPreGrantedARQ(bool v) { m_answerCallPreGrantedARQ = v; }

    bool GetMakeCallPreGrantedARQ() const { return m_makeCallPreGrantedARQ; }
    void SetMakeCallPreGrantedARQ(bool v) { m_makeCallPreGrantedARQ = v; }

    bool GetAliasCanBeHostName() const { return m_aliasCanBeHostName; }
    void SetAliasCanBeHostName(bool v) { m_aliasCanBeHostName = v; }

    bool GetDisengageOnHearbeatFail() const { return m_disengageOnHearbeatFail; }
    void SetDisengageOnHearbeatFail(bool v) { m_disengageOnHearbeatFail = v; }

    bool IsGatekeeperRouted() const { return m_isGatekeeperRouted; }
    void SetGatekeeperRouted(bool is) { m_isGatekeeperRouted = is; }

    bool IsRequiredH235() const { return m_requireH235; }
    void SetRequiredH235(bool req) { m_requireH235 = req; }

    unsigned GetActiveRegistrations() const { return m_byIdentifier.GetSize(); }

    unsigned GetPeakRegistrations() const { return m_peakRegistrations; }

    unsigned GetTotalRegistrations() const { return m_totalRegistrations; }

    unsigned GetRejectedRegistrations() const { return m_rejectedRegistrations; }

    unsigned GetActiveCalls() const { return m_activeCalls.GetSize(); }

    unsigned GetPeakCalls() const { return m_peakCalls; }

    unsigned GetTotalCalls() const { return m_totalCalls; }

    unsigned GetRejectedCalls() const { return m_rejectedCalls; }

    // Remove an alias from the server database.
    void RemoveAlias(
      H323RegisteredEndPoint & ep,
      const PString & alias
    );

    // called when an endpoint needs to send a descriptor to the H.501 peer element
    virtual PBoolean OnSendDescriptorForEndpoint(
      H323RegisteredEndPoint & /*ep*/,                    
      H225_ArrayOf_AliasAddress & /*aliases*/,            
      H225_EndpointType & /*terminalType*/,               
      H225_ArrayOf_AliasAddress & /*transportAddresses*/  
    )
    { return true; } 

    virtual PBoolean AllowDuplicateAlias(const H225_ArrayOf_AliasAddress & /*aliases*/)
    { return m_canHaveDuplicateAlias; }

    virtual PString AllocateAlias(H225_RegistrationRequest & rrq);

#if OPAL_H460
    virtual PBoolean OnSendFeatureSet(H460_MessageType pduType, H225_FeatureSet & features) const;
    virtual void OnReceiveFeatureSet(H460_MessageType pduType, const H225_FeatureSet & features) const;
#endif

  protected:

    PDECLARE_NOTIFIER(PThread, H323GatekeeperServer, MonitorMain);

    // Configuration & policy variables
    PString  m_gatekeeperIdentifier;
    unsigned m_totalBandwidth;
    unsigned m_usedBandwidth;
    unsigned m_defaultBandwidth;
    unsigned m_maximumBandwidth;
    unsigned m_defaultTimeToLive;
    unsigned m_defaultInfoResponseRate;
    bool     m_overwriteOnSameSignalAddress;
    unsigned m_minAliasToAllocate; // Zero is no allocation RRJ
    unsigned m_maxAliasToAllocate;
    unsigned m_aliasToAllocate;
    bool     m_canHaveDuplicateAlias;
    bool     m_canHaveDuplicatePrefix;
    bool     m_canOnlyCallRegisteredEP;
    bool     m_canOnlyAnswerRegisteredEP;
    bool     m_answerCallPreGrantedARQ;
    bool     m_makeCallPreGrantedARQ;
    bool     m_isGatekeeperRouted;
    bool     m_aliasCanBeHostName;
    bool     m_requireH235;
    bool     m_disengageOnHearbeatFail;

    PStringToString m_passwords;

    // Dynamic variables
    time_t      m_identifierBase;
    unsigned    m_nextIdentifier;
    PThread   * m_monitorThread;
    PSyncPoint  m_monitorExit;

    PLIST(ListenerList, H323GatekeeperListener);
    ListenerList m_listeners;

#if OPAL_H501
    H323PeerElement * m_peerElement;
#endif

    PSafeDictionary<H225_AliasAddress, H323RegisteredEndPoint> m_discoveredEndpoints;

    PSafeDictionary<PString, H323RegisteredEndPoint> m_byIdentifier;

    class StringMap : public PString {
        PCLASSINFO(StringMap, PString);
      public:
        StringMap(const PString & from, const PString & id)
          : PString(from), identifier(id) { }
        PString identifier;
    };
    PSortedStringList m_byAddress;
    PSortedStringList m_byAlias;
    PSortedStringList m_byVoicePrefix;

    PSafeSortedList<H323GatekeeperCall> m_activeCalls;

    PINDEX         m_peakRegistrations;
    PINDEX         m_totalRegistrations;
    atomic<unsigned> m_rejectedRegistrations;
    PINDEX         m_peakCalls;
    PINDEX         m_totalCalls;
    atomic<unsigned> m_rejectedCalls;

  friend class H323GatekeeperRRQ;
  friend class H323GatekeeperARQ;

  P_REMOVE_VIRTUAL(H323RegisteredEndPoint *,CreateRegisteredEndPoint(H323GatekeeperRRQ &),0);
};


#endif // OPAL_H323

#endif // OPAL_H323_GKSERVER_H