h323pdu.h

Go to the documentation of this file.

/*
 * h323pdu.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): ______________________________________.
 *
 * $Revision: 30945 $
 * $Author: rjongbloed $
 * $Date: 2013-11-22 13:25:05 +1100 (Fri, 22 Nov 2013) $
 */

#ifndef OPAL_H323_H323PDU_H
#define OPAL_H323_H323PDU_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal_config.h>

#if OPAL_H323

#include <ptlib/sockets.h>
#include <h323/h323con.h>
#include <h323/transaddr.h>
#include <h323/q931.h>
#include <h323/h235auth.h>
#include <h323/h323trans.h>
#include <rtp/rtp.h>
#include <asn/h225.h>
#include <asn/h245.h>


class H323Connection;
class H323TransportAddress;
class H225_RAS;
class OpalGloballyUniqueID;


#define H225_PROTOCOL_VERSION 6
#define H245_PROTOCOL_VERSION 13



class H323SignalPDU : public H225_H323_UserInformation
{
  PCLASSINFO(H323SignalPDU, H225_H323_UserInformation);

  public:
    H323SignalPDU();

    H225_Setup_UUIE & BuildSetup(
      const H323Connection & connection,    
      const H323TransportAddress & destAddr 
    );

    H225_CallProceeding_UUIE & BuildCallProceeding(
      const H323Connection & connection    
    );

    H225_Connect_UUIE & BuildConnect(
      const H323Connection & connection    
    );

    H225_Alerting_UUIE & BuildAlerting(
      const H323Connection & connection    
    );

    H225_Information_UUIE & BuildInformation(
      const H323Connection & connection    
    );

    H225_ReleaseComplete_UUIE & BuildReleaseComplete(
      const H323Connection & connection    
    );

    H225_Facility_UUIE * BuildFacility(
      const H323Connection & connection,  
      bool empty,                         
      unsigned reason = H225_FacilityReason::e_undefinedReason 
    );

    H225_Facility_UUIE & BuildFacility(
      const OpalGloballyUniqueID & callId
    );

    H225_Progress_UUIE & BuildProgress(
      const H323Connection & connection    
    );

    H225_Status_UUIE & BuildStatus(
      const H323Connection & connection    
    );

    H225_StatusInquiry_UUIE & BuildStatusInquiry(
      const H323Connection & connection    
    );

    H225_SetupAcknowledge_UUIE & BuildSetupAcknowledge(
      const H323Connection & connection    
    );

    H225_Notify_UUIE & BuildNotify(
      const H323Connection & connection    
    );


    void PrintOn(
      ostream & strm
    ) const;

    PBoolean Read(
      H323Transport & transport   
    );

    PBoolean Write(
      H323Transport & transport   
    );

    const Q931 & GetQ931() const { return q931pdu; }

    Q931 & GetQ931() { return q931pdu; }

    void SetQ931(const Q931 & _q931pdu) { q931pdu = _q931pdu; }

    void BuildQ931();

    PString GetSourceAliases(
      const H323Transport * transport = NULL  
    ) const;

    PString GetDestinationAlias(
      PBoolean firstAliasOnly = false   
    ) const;

    PBoolean GetSourceE164(
      PString & number    
    ) const;

    PBoolean GetDestinationE164(
      PString & number    
    ) const;

    unsigned GetDistinctiveRing() const;

    void SetQ931Fields(
      const H323Connection & connection,
      bool insertPartyNumbers = false
    );

  protected:
    // Even though we generally deal with the H323 protocol (H225) it is
    // actually contained within a field of the Q931 protocol.
    Q931 q931pdu;
};



class H323ControlPDU : public H245_MultimediaSystemControlMessage
{
  PCLASSINFO(H323ControlPDU, H245_MultimediaSystemControlMessage);

  public:
    H245_RequestMessage    & Build(H245_RequestMessage   ::Choices request);
    H245_ResponseMessage   & Build(H245_ResponseMessage  ::Choices response);
    H245_CommandMessage    & Build(H245_CommandMessage   ::Choices command);
    H245_IndicationMessage & Build(H245_IndicationMessage::Choices indication);

    H245_MasterSlaveDetermination & BuildMasterSlaveDetermination(
      unsigned terminalType,
      unsigned statusDeterminationNumber
    );
    H245_MasterSlaveDeterminationAck & BuildMasterSlaveDeterminationAck(
      PBoolean isMaster
    );
    H245_MasterSlaveDeterminationReject & BuildMasterSlaveDeterminationReject(
      unsigned cause
    );

    H245_TerminalCapabilitySet & BuildTerminalCapabilitySet(
      const H323Connection & connection,
      unsigned sequenceNumber,
      PBoolean empty
    );
    H245_TerminalCapabilitySetAck & BuildTerminalCapabilitySetAck(
      unsigned sequenceNumber
    );
    H245_TerminalCapabilitySetReject & BuildTerminalCapabilitySetReject(
      unsigned sequenceNumber,
      unsigned cause
    );

    H245_OpenLogicalChannel & BuildOpenLogicalChannel(
      unsigned forwardLogicalChannelNumber
    );
    H245_RequestChannelClose & BuildRequestChannelClose(
      unsigned channelNumber,
      unsigned reason
    );
    H245_CloseLogicalChannel & BuildCloseLogicalChannel(
      unsigned channelNumber
    );
    H245_OpenLogicalChannelAck & BuildOpenLogicalChannelAck(
      unsigned channelNumber
    );
    H245_OpenLogicalChannelReject & BuildOpenLogicalChannelReject(
      unsigned channelNumber,
      unsigned cause
    );
    H245_OpenLogicalChannelConfirm & BuildOpenLogicalChannelConfirm(
      unsigned channelNumber
    );
    H245_CloseLogicalChannelAck & BuildCloseLogicalChannelAck(
      unsigned channelNumber
    );
    H245_RequestChannelCloseAck & BuildRequestChannelCloseAck(
      unsigned channelNumber
    );
    H245_RequestChannelCloseReject & BuildRequestChannelCloseReject(
      unsigned channelNumber
    );
    H245_RequestChannelCloseRelease & BuildRequestChannelCloseRelease(
      unsigned channelNumber
    );

    H245_RequestMode & BuildRequestMode(
      unsigned sequenceNumber
    );
    H245_RequestModeAck & BuildRequestModeAck(
      unsigned sequenceNumber,
      unsigned response
    );
    H245_RequestModeReject & BuildRequestModeReject(
      unsigned sequenceNumber,
      unsigned cause
    );

    H245_RoundTripDelayRequest & BuildRoundTripDelayRequest(
      unsigned sequenceNumber
    );
    H245_RoundTripDelayResponse & BuildRoundTripDelayResponse(
      unsigned sequenceNumber
    );

    H245_UserInputIndication & BuildUserInputIndication(
      const PString & value
    );
    H245_UserInputIndication & BuildUserInputIndication(
      char tone,               
      unsigned duration,       
      unsigned logicalChannel, 
      unsigned rtpTimestamp    
    );

    H245_MiscellaneousCommand & BuildMiscellaneousCommand(
      unsigned channelNumber,
      unsigned type
    );
    
    H245_FlowControlCommand & BuildFlowControlCommand(
      unsigned channelNumber, 
      unsigned maxBitRate
    );

    H245_MiscellaneousIndication & BuildMiscellaneousIndication(
      unsigned channelNumber,
      unsigned type
    );

    H245_GenericMessage & BuildGenericRequest(
      const PString & identifier,
      unsigned subMsgId
    );
    H245_GenericMessage & BuildGenericResponse(
      const PString & identifier,
      unsigned subMsgId
    );
    H245_GenericMessage & BuildGenericCommand(
      const PString & identifier,
      unsigned subMsgId
    );
    H245_GenericMessage & BuildGenericIndication(
      const PString & identifier,
      unsigned subMsgId
    );

    H245_FunctionNotUnderstood & BuildFunctionNotUnderstood(
      const H323ControlPDU & pdu
    );

    H245_EndSessionCommand & BuildEndSessionCommand(
      unsigned reason
    );
};



class H323RasPDU : public H225_RasMessage, public H323TransactionPDU
{
  PCLASSINFO(H323RasPDU, H225_RasMessage);

  public:
    H323RasPDU();
    H323RasPDU(
      const H235Authenticators & authenticators
    );

    // overrides from PObject
    virtual PObject * Clone() const;

    // overrides from H323TransactionPDU
    virtual PASN_Object & GetPDU();
    virtual PASN_Choice & GetChoice();
    virtual const PASN_Object & GetPDU() const;
    virtual const PASN_Choice & GetChoice() const;
    virtual unsigned GetSequenceNumber() const;
    virtual unsigned GetRequestInProgressDelay() const;
#if PTRACING
    virtual const char * GetProtocolName() const;
#endif
    virtual H323TransactionPDU * ClonePDU() const;
    virtual void DeletePDU();

    PDECLARE_WriteConnectCallback(H323RasPDU, WriteGRQ);

    // new functions
    H225_GatekeeperRequest       & BuildGatekeeperRequest(unsigned seqNum);
    H225_GatekeeperConfirm       & BuildGatekeeperConfirm(unsigned seqNum);
    H225_GatekeeperReject        & BuildGatekeeperReject(unsigned seqNum, unsigned reason = H225_GatekeeperRejectReason::e_undefinedReason);
    H225_RegistrationRequest     & BuildRegistrationRequest(unsigned seqNum);
    H225_RegistrationConfirm     & BuildRegistrationConfirm(unsigned seqNum);
    H225_RegistrationReject      & BuildRegistrationReject(unsigned seqNum, unsigned reason = H225_RegistrationRejectReason::e_undefinedReason);
    H225_UnregistrationRequest   & BuildUnregistrationRequest(unsigned seqNum);
    H225_UnregistrationConfirm   & BuildUnregistrationConfirm(unsigned seqNum);
    H225_UnregistrationReject    & BuildUnregistrationReject(unsigned seqNum, unsigned reason = H225_UnregRejectReason::e_undefinedReason);
    H225_LocationRequest         & BuildLocationRequest(unsigned seqNum);
    H225_LocationConfirm         & BuildLocationConfirm(unsigned seqNum);
    H225_LocationReject          & BuildLocationReject(unsigned seqNum, unsigned reason = H225_LocationRejectReason::e_undefinedReason);
    H225_AdmissionRequest        & BuildAdmissionRequest(unsigned seqNum);
    H225_AdmissionConfirm        & BuildAdmissionConfirm(unsigned seqNum);
    H225_AdmissionReject         & BuildAdmissionReject(unsigned seqNum, unsigned reason = H225_AdmissionRejectReason::e_undefinedReason);
    H225_DisengageRequest        & BuildDisengageRequest(unsigned seqNum);
    H225_DisengageConfirm        & BuildDisengageConfirm(unsigned seqNum);
    H225_DisengageReject         & BuildDisengageReject(unsigned seqNum, unsigned reason = H225_DisengageRejectReason::e_securityDenial);
    H225_BandwidthRequest        & BuildBandwidthRequest(unsigned seqNum);
    H225_BandwidthConfirm        & BuildBandwidthConfirm(unsigned seqNum, unsigned bandwidth = 0);
    H225_BandwidthReject         & BuildBandwidthReject(unsigned seqNum, unsigned reason = H225_BandRejectReason::e_undefinedReason);
    H225_InfoRequest             & BuildInfoRequest(unsigned seqNum, unsigned callRef = 0, const OpalGloballyUniqueID * id = NULL);
    H225_InfoRequestResponse     & BuildInfoRequestResponse(unsigned seqNum);
    H225_InfoRequestAck          & BuildInfoRequestAck(unsigned seqNum);
    H225_InfoRequestNak          & BuildInfoRequestNak(unsigned seqNum, unsigned reason = H225_InfoRequestNakReason::e_undefinedReason);
    H225_ServiceControlIndication& BuildServiceControlIndication(unsigned seqNum, const OpalGloballyUniqueID * id = NULL);
    H225_ServiceControlResponse  & BuildServiceControlResponse(unsigned seqNum);
    H225_UnknownMessageResponse  & BuildUnknownMessageResponse(unsigned seqNum);
    H225_RequestInProgress       & BuildRequestInProgress(unsigned seqNum, unsigned delay);
};



void H323SetAliasAddresses(const H323TransportAddressArray & addresses, H225_ArrayOf_AliasAddress & aliases);
void H323SetAliasAddresses(const PStringArray & names, H225_ArrayOf_AliasAddress & aliases, int tag = -1);
void H323SetAliasAddresses(const PStringList & names, H225_ArrayOf_AliasAddress & aliases, int tag = -1);
void H323SetAliasAddress(const H323TransportAddress & address, H225_AliasAddress & alias);
void H323SetAliasAddress(const PString & name, H225_AliasAddress & alias, int tag = -1);
PStringArray H323GetAliasAddressStrings(const H225_ArrayOf_AliasAddress & aliases);
PString H323GetAliasAddressString(const H225_AliasAddress & alias);
PString H323GetAliasAddressE164(const H225_AliasAddress & alias);
PString H323GetAliasAddressE164(const H225_ArrayOf_AliasAddress & aliases);

H323Connection::CallEndReason H323TranslateToCallEndReason(
  Q931::CauseValues cause,
  unsigned reason
);
Q931::CauseValues H323TranslateFromCallEndReason(
  H323Connection::CallEndReason callEndReason,
  H225_ReleaseCompleteReason & releaseCompleteReason
);

void H323GetApplicationInfo(OpalProductInfo & info, const H225_VendorIdentifier & vendor);

bool H323SetRTPPacketization(
  H245_ArrayOf_RTPPayloadType & rtpPacketizations,
  const PStringSet & mediaPacketizations
);
bool H323SetRTPPacketization(
  H245_RTPPayloadType & rtpPacketization,
  const OpalMediaFormat & mediaFormat,
  RTP_DataFrame::PayloadTypes payloadType
);
bool H323SetRTPPacketization(
  H245_RTPPayloadType & rtpPacketization,
  const PString & mediaPacketizationString,
  RTP_DataFrame::PayloadTypes payloadType
);
PString H323GetRTPPacketization(
  const H245_RTPPayloadType & rtpPacketization
);

PString H323GetCapabilityIdentifier(
  const H245_CapabilityIdentifier & capId
);
bool H323SetCapabilityIdentifier(
  const PString & str,
  H245_CapabilityIdentifier & capId
);

const H245_ParameterValue * H323GetGenericParameter(
  const H245_ArrayOf_GenericParameter & params,
  unsigned ordinal
);
bool H323GetGenericParameterBoolean(
  const H245_ArrayOf_GenericParameter & params,
  unsigned ordinal
);
unsigned H323GetGenericParameterInteger(
  const H245_ArrayOf_GenericParameter & params,
  unsigned ordinal,
  unsigned defValue = 0,
  H245_ParameterValue::Choices subType = H245_ParameterValue::e_unsignedMin
);
bool H323GetGenericParameterObject(
  const H245_ArrayOf_GenericParameter & params,
  unsigned ordinal,
  PASN_Object & object
);
H245_ParameterValue & H323AddGenericParameter(
  H245_ArrayOf_GenericParameter & params,
  unsigned ordinal,
  H245_ParameterValue::Choices tag
);
template <class CLS> CLS & H323AddGenericParameterAs(
  H245_ArrayOf_GenericParameter & params,
  unsigned ordinal,
  H245_ParameterValue::Choices tag
) { return (CLS &)H323AddGenericParameter(params, ordinal, tag); }
void H323AddGenericParameterBoolean(
  H245_ArrayOf_GenericParameter & params,
  unsigned ordinal,
  bool value
);
void H323AddGenericParameterInteger(
  H245_ArrayOf_GenericParameter & params,
  unsigned ordinal,
  unsigned value,
  H245_ParameterValue::Choices subType
);
void H323AddGenericParameterString(
  H245_ArrayOf_GenericParameter & params,
  unsigned ordinal,
  const PString & value
);
void H323AddGenericParameterOctets(
  H245_ArrayOf_GenericParameter & params,
  unsigned ordinal,
  const PBYTEArray & value
);
void H323AddGenericParameterObject(
  H245_ArrayOf_GenericParameter & params,
  unsigned ordinal,
  const PASN_Object & object
);

#if PTRACING
void H323TraceDumpPDU(
  const char * proto,
  PBoolean writing,
  const PBYTEArray & rawData,
  const PASN_Object & pdu,
  const PASN_Choice & tag1,
  unsigned seqNum
);
#else
#define H323TraceDumpPDU(proto, writing, rawData, pdu, tag1, seqNum)
#endif


#endif // OPAL_H323

#endif // OPAL_H323_H323PDU_H