sipcon.h

Go to the documentation of this file.

/*
 * sipcon.h
 *
 * Session Initiation Protocol connection.
 *
 * Open Phone Abstraction Library (OPAL)
 * Formally known as the Open H323 project.
 *
 * Copyright (c) 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 Phone Abstraction Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Contributor(s): ______________________________________.
 */

#ifndef OPAL_SIP_SIPCON_H
#define OPAL_SIP_SIPCON_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal_config.h>

#if OPAL_SIP

#include <rtp/rtpconn.h>
#include <sip/sippdu.h>
#include <sip/handlers.h>
#include <sdp/sdpep.h>


class OpalSIPIMContext;


#define OPAL_OPT_FORWARD_REFER   "Forward-Refer"

#define OPAL_OPT_REFER_SUB       "Refer-Sub"

#define OPAL_OPT_NO_REFER_SUB    "No-Refer-Sub"

#define OPAL_OPT_PRACK_MODE      "PRACK-Mode"

#define OPAL_OPT_INITIAL_OFFER "Initial-Offer"

#define OPAL_OPT_ALLOW_EARLY_REPLACE "Allow-Early-Replace"

#define OPAL_OPT_EXTERNAL_SDP "External-SDP"

#define OPAL_OPT_UNSECURE_SRTP "Unsecure-SRTP"

#define OPAL_OPT_ENABLE_DTLS "Enable-DTLS"


#define SIP_HEADER_PREFIX      "SIP-Header:"
#define SIP_HEADER_REPLACES    SIP_HEADER_PREFIX"Replaces"
#define SIP_HEADER_REFERRED_BY SIP_HEADER_PREFIX"Referred-By"
#define SIP_HEADER_CONTACT     SIP_HEADER_PREFIX"Contact"

#define OPAL_SIP_REFERRED_CONNECTION "Referred-Connection"



class SIPConnection : public OpalSDPConnection, public SIPTransactionOwner
{
    PCLASSINFO(SIPConnection, OpalSDPConnection);
  public:

    struct Init {
      Init(OpalCall & call, SIPEndPoint & endpoint)
        : m_call(call)
        , m_endpoint(endpoint)
        , m_userData(NULL)
        , m_invite(NULL)
        , m_options(0)
        , m_stringOptions(NULL)
        { }

      OpalCall    & m_call;      
      SIPEndPoint & m_endpoint;  
      PString       m_token;     
      SIPURL        m_address;   
      void        * m_userData;  
      SIP_PDU     * m_invite;    
      unsigned m_options;        
      OpalConnection::StringOptions * m_stringOptions;  
    };

    SIPConnection(
      const Init & init         
    );

    ~SIPConnection();

    virtual PString GetPrefixName() const;

    virtual PString GetIdentifier() const;

    virtual void OnApplyStringOptions();

    virtual PBoolean SetUpConnection();

    virtual OpalTransportAddress GetRemoteAddress() const { return m_remoteAddress; }

    virtual PString GetRemoteIdentity() const;

    virtual PString GetDestinationAddress();

    virtual PString GetCalledPartyURL();

    virtual PMultiPartList GetExtraCallInfo() const { return m_multiPartMIME; }

    virtual PString GetLocalPartyURL() const;

    virtual PString GetAlertingType() const;

    virtual bool SetAlertingType(const PString & info);

    virtual PString GetCallInfo() const;

    virtual PString GetSupportedFeatures() const;

    virtual bool TransferConnection(
      const PString & remoteParty   
    );

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

    virtual PBoolean SetConnected();

    virtual OpalMediaFormatList GetMediaFormats() const;

    virtual bool RequireSymmetricMediaStreams() const;

#if OPAL_T38_CAPABILITY

    virtual bool SwitchFaxMediaStreams(
      bool toT38  
    );
#endif

    virtual OpalMediaCryptoSuite::KeyExchangeModes GetMediaCryptoKeyExchangeModes() const;

    virtual OpalMediaStream * CreateMediaStream(
      const OpalMediaFormat & mediaFormat, 
      unsigned sessionID,                  
      PBoolean isSource                        
    );

    virtual OpalMediaStreamPtr OpenMediaStream(
      const OpalMediaFormat & mediaFormat, 
      unsigned sessionID,                  
      bool isSource                        
    );

    virtual void OnClosedMediaStream(
      const OpalMediaStream & stream     
    );

    virtual bool GetMediaTransportAddresses(
      OpalConnection & otherConnection,      
      unsigned sessionId,                    
      const OpalMediaType & mediaType,       
      OpalTransportAddressArray & transports 
    ) const;

    virtual void OnPatchMediaStream(
      PBoolean isSource,        
      OpalMediaPatch & patch    
    );

    virtual void OnPauseMediaStream(
      OpalMediaStream & strm,     
      bool paused                 
    );

    virtual void OnReleased();

    virtual PBoolean ForwardCall(
      const PString & forwardParty   
    );

    virtual SendUserInputModes GetRealSendUserInputMode() const;

    virtual PBoolean SendUserInputString(
      const PString & value                   
    );

    PBoolean SendUserInputTone(char tone, unsigned duration);

    virtual void OnTransactionFailed(
      SIPTransaction & transaction
    );

    virtual void OnReceivedPDU(SIP_PDU & pdu);

    virtual void OnReceivedINVITE(SIP_PDU & pdu);

    virtual void OnReceivedReINVITE(SIP_PDU & pdu);

    virtual void OnReceivedACK(SIP_PDU & pdu);
  
    virtual void OnReceivedOPTIONS(SIP_PDU & pdu);

    virtual void OnReceivedNOTIFY(SIP_PDU & pdu);

    virtual void OnAllowedEventNotify(
      const PString & eventName  
    );

    virtual void OnReceivedREFER(SIP_PDU & pdu);
  
    virtual void OnReceivedINFO(SIP_PDU & pdu);

    virtual void OnReceivedPING(SIP_PDU & pdu);

    virtual void OnReceivedPRACK(SIP_PDU & pdu);

    virtual void OnReceivedBYE(SIP_PDU & pdu);
  
    virtual void OnReceivedCANCEL(SIP_PDU & pdu);
  
    virtual bool OnReceivedResponseToINVITE(
      SIPTransaction & transaction,
      SIP_PDU & response
    );

    virtual void OnReceivedResponse(
      SIPTransaction & transaction,
      SIP_PDU & response
    );

    virtual void OnReceivedTrying(
      SIPTransaction & transaction,
      SIP_PDU & response
    );
  
    virtual void OnReceivedRinging(SIPTransaction & transaction, SIP_PDU & pdu);
  
    virtual void OnReceivedSessionProgress(SIPTransaction & transaction, SIP_PDU & pdu);
  
    virtual PBoolean OnReceivedAuthenticationRequired(
      SIPTransaction & transaction,
      SIP_PDU & response
    );
  
    virtual void OnReceivedRedirection(SIP_PDU & pdu);

    virtual void OnReceivedOK(
      SIPTransaction & transaction,
      SIP_PDU & response
    );
  
    virtual void OnCreatingINVITE(SIPInvite & pdu);

    enum TypeOfINVITE {
      IsNewINVITE,
      IsDuplicateINVITE,
      IsReINVITE,
      IsLoopedINVITE
    };

    TypeOfINVITE CheckINVITE(
      const SIP_PDU & pdu
    ) const;

    bool SendOPTIONS(
      const SIPOptions::Params & params,  
      SIP_PDU * reply = NULL              
    );

    bool SendINFO(
      const SIPInfo::Params & params,  
      SIP_PDU * reply = NULL              
    );

    virtual bool OnReceivedInfoPackage(
      const PString & package,        
      const PMultiPartList & content  
    );

    OpalTransportAddress GetDefaultSDPConnectAddress(WORD port = 0) const;

    SIPEndPoint & GetEndPoint() const { return m_sipEndpoint; }
    SIPAuthentication * GetAuthenticator() const { return m_authentication; }

    enum PRACKMode {
      e_prackDisabled,  
      e_prackSupported, 
      e_prackRequired   
    };
    PRACKMode GetPRACKMode() const { return m_prackMode; }

    virtual unsigned GetAllowedMethods() const;

    bool DoesRemoteAllowMethod(SIP_PDU::Methods method) const { return (m_allowedMethods&(1<<method)) != 0; }

#if OPAL_VIDEO

    virtual PBoolean OnMediaControlXML(SIP_PDU & pdu);
#endif

    virtual bool OnMediaCommand(
      OpalMediaStream & stream,         
      const OpalMediaCommand & command  
    );

    // Overrides from SIPTransactionOwner
    virtual PString GetAuthID() const;


    virtual void OnStartTransaction(SIPTransaction & transaction);
    virtual void OnReceivedMESSAGE(SIP_PDU & pdu);
    virtual void OnReceivedSUBSCRIBE(SIP_PDU & pdu);

    virtual PString GetMediaInterface();
    virtual OpalTransportAddress GetRemoteMediaAddress();


  protected:
    virtual bool GarbageCollection();
    void OnSessionTimeout();
    void OnInviteResponseRetry();
    void OnInviteResponseTimeout();
    void OnInviteCollision();
    void OnDelayedRefer();
    virtual bool AllowMusicOnHold() const;
    virtual bool OnHoldStateChanged(bool placeOnHold);
    virtual void OnMediaStreamOpenFailed(bool rx);

    void OnReceivedAlertingResponse(
      SIPTransaction & transaction,
      SIP_PDU & response
    );
    bool InternalSetConnected(bool transfer);
    virtual bool OnSendAnswer(
      SIP_PDU::StatusCodes response,
      bool transfer
    );
    virtual bool OnReceivedAnswer(
      SIP_PDU & response,
      SIPTransaction * transaction
    );

    bool SendReINVITE(PTRACE_PARAM(const char * msg, ) int operation = 0);
    bool StartPendingReINVITE();

    friend class SIPInvite;
    PDECLARE_WriteConnectCallback(SIPConnection, WriteINVITE);

    virtual bool SendDelayedACK(bool force);
    void OnDelayedAckTimeout();

    virtual PBoolean SendInviteResponse(
      SIP_PDU::StatusCodes code,
      const SDPSessionDescription * sdp = NULL
    );
    virtual void AdjustInviteResponse(
      SIP_PDU & response
    );

    void UpdateRemoteAddresses();

    void NotifyDialogState(
      SIPDialogNotification::States state,
      SIPDialogNotification::Events eventType = SIPDialogNotification::NoEvent,
      unsigned eventCode = 0
    );

    virtual bool InviteConferenceParticipant(const PString & conf, const PString & dest);
    PSafePtr<SIPConnection> GetB2BUA();


    typedef SIPPoolTimer<SIPConnection> PoolTimer;

    // Member variables
    unsigned              m_allowedMethods;
    PStringSet            m_allowedEvents;

    PString               m_forwardParty;
    OpalTransportAddress  m_remoteAddress;
    SIPURL                m_assertedIdentity;
    SIPURL                m_remoteIdentity;
    SIPURL                m_contactAddress;
    SIPURL                m_ciscoRemotePartyID;
    PMultiPartList        m_multiPartMIME;

    SIP_PDU             * m_lastReceivedINVITE;
    SIP_PDU             * m_delayedAckInviteResponse;
    PoolTimer             m_delayedAckTimer;
    PTimeInterval         m_delayedAckTimeout1;
    PTimeInterval         m_delayedAckTimeout2;
    SIP_PDU             * m_delayedAckPDU;
    bool                  m_needReINVITE;
    bool                  m_handlingINVITE;
    bool                  m_resolveMultipleFormatReINVITE;
    bool                  m_symmetricOpenStream;
    OpalGloballyUniqueID  m_dialogNotifyId;
    int                   m_appearanceCode;
    PString               m_alertInfo;
#if OPAL_VIDEO
    bool                  m_canDoVideoFastUpdateINFO;
#endif
    PoolTimer             m_sessionTimer;
    PRACKMode             m_prackMode;
    bool                  m_prackEnabled;
    unsigned              m_prackSequenceNumber;
    std::queue<SIP_PDU>   m_responsePackets;
    PoolTimer             m_responseFailTimer;
    PoolTimer             m_responseRetryTimer;
    unsigned              m_responseRetryCount;
    PoolTimer             m_inviteCollisionTimer;
    PoolTimer             m_delayedReferTimer;
    SIPURL                m_delayedReferTo;
    SIPURL                m_sentReferTo;

    PSafeArray<SIPTransaction> m_forkedInvitations; // Not for re-INVITE
    PSafeArray<SIPTransaction> m_pendingInvitations; // For re-INVITE

    enum {
      ReleaseWithBYE,
      ReleaseWithCANCEL,
      ReleaseWithResponse,
      ReleaseWithNothing,
    } m_releaseMethod;

    enum {
      eNoRemoteRefer,
      eReferStarted,
      eReferNotifyConfirmed
    } m_referOfRemoteState;
    PString m_consultationTransferToken;
    bool ConsultationTransfer(SIPConnection & referee, SIPRefer::ReferSubMode referSubMode, bool useIdentity);

    int SetRemoteMediaFormatsFromPDU(SIP_PDU & pdu);

    std::map<std::string, SIP_PDU *> m_responses;

#if OPAL_HAS_SIPIM
    PSafePtr<OpalSIPIMContext> m_imContext;
#endif

    enum {
      UserInputMethodUnknown,
      ReceivedRFC2833,
      ReceivedINFO
    } m_receivedUserInputMethod;
    void OnUserInputInlineRFC2833(OpalRFC2833Info & info, OpalRFC2833Proto::NotifyState state);


  private:
    P_REMOVE_VIRTUAL_VOID(OnCreatingINVITE(SIP_PDU&));
    P_REMOVE_VIRTUAL_VOID(OnReceivedTrying(SIP_PDU &));
    P_REMOVE_VIRTUAL_VOID(OnMessageReceived(const SIPURL & /*from*/, const SIP_PDU & /*pdu*/));
    P_REMOVE_VIRTUAL_VOID(OnMessageReceived(const SIP_PDU & /*pdu*/));
    P_REMOVE_VIRTUAL(bool,OnReceivedInfoPackage(const PString&,const PString&),false);


  friend class SIPTransaction;
  friend class SIP_RTP_Session;
};


#endif // OPAL_SIP

#endif // OPAL_SIP_SIPCON_H


// End of File ///////////////////////////////////////////////////////////////