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): ______________________________________.
 *
 * $Revision: 24913 $
 * $Author: rjongbloed $
 * $Date: 2010-11-30 16:22:28 -0600 (Tue, 30 Nov 2010) $
 */

#ifndef OPAL_SIP_SIPCON_H
#define OPAL_SIP_SIPCON_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal/buildopts.h>

#if OPAL_SIP

#include <opal/buildopts.h>
#include <opal/rtpconn.h>
#include <sip/sippdu.h>
#include <sip/handlers.h>

#if OPAL_VIDEO
#include <opal/pcss.h>                  // for OpalPCSSConnection
#include <codec/vidcodec.h>             // for OpalVideoUpdatePicture command
#endif

#if OPAL_HAS_IM
#include <im/rfc4103.h>
#endif

class OpalCall;
class SIPEndPoint;

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

#define OPAL_OPT_SYMMETRIC_HOLD_PRODUCT "Symmetric-Hold-Product"



class SIPConnection : public OpalRTPConnection
{
  PCLASSINFO(SIPConnection, OpalRTPConnection);
  public:

    SIPConnection(
      OpalCall & call,                          
      SIPEndPoint & endpoint,                   
      const PString & token,                    
      const SIPURL & address,                   
      OpalTransport * transport,                
      unsigned int options = 0,                 
      OpalConnection::StringOptions * stringOptions = NULL  
    );

    ~SIPConnection();

    virtual bool IsNetworkConnection() const { return true; }

    virtual PString GetPrefixName() const;

    virtual PString GetIdentifier() const;

    virtual PBoolean SetUpConnection();

    virtual PString GetDestinationAddress();

    virtual PString GetCalledPartyURL();

    virtual PString GetAlertingType() const;

    virtual bool SetAlertingType(const PString & info);

    virtual bool TransferConnection(
      const PString & remoteParty   
    );

    virtual bool HoldConnection();

    virtual bool RetrieveConnection();

    virtual bool IsConnectionOnHold(
      bool fromRemote  
    );

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

    virtual PBoolean SetConnected();

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

    virtual bool CloseMediaStream(
      OpalMediaStream & stream  
    );

    virtual void OnReleased();

    virtual PBoolean ForwardCall(
      const PString & forwardParty   
    );

    virtual SendUserInputModes GetRealSendUserInputMode() const;

    PBoolean SendUserInputTone(char tone, unsigned duration);

    virtual void OnRTPStatistics(
      const RTP_Session & session         
    ) const;

    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 OnReceivedBYE(SIP_PDU & pdu);
  
    virtual void OnReceivedCANCEL(SIP_PDU & pdu);
  
    virtual void 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(SIP_PDU & pdu);
  
    virtual void OnReceivedSessionProgress(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);

    virtual PBoolean SendInviteOK(const SDPSessionDescription & sdp);
        
    virtual PBoolean SendInviteResponse(
      SIP_PDU::StatusCodes code,
      const char * contact = NULL,
      const char * extra = NULL,
      const SDPSessionDescription * sdp = NULL
    );

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

    TypeOfINVITE CheckINVITE(
      const SIP_PDU & pdu
    ) const;

    OpalTransportAddress GetDefaultSDPConnectAddress(WORD port = 0) const;

    OpalTransport & GetTransport() const { return *transport; }
    bool SetTransport(OpalTransport * transport);

    SIPEndPoint & GetEndPoint() const { return endpoint; }
    SIPDialogContext & GetDialog() { return m_dialog; }
    const SIPDialogContext & GetDialog() const { return m_dialog; }
    SIPAuthentication * GetAuthenticator() const { return m_authentication; }

#if OPAL_VIDEO

    virtual PBoolean OnMediaControlXML(SIP_PDU & pdu);
#endif

    virtual void OnMediaCommand(OpalMediaCommand & note, INT extra);

    virtual void OnStartTransaction(SIPTransaction & transaction);

    virtual void OnReceivedMESSAGE(SIP_PDU & pdu);

    P_REMOVE_VIRTUAL_VOID(OnMessageReceived(const SIPURL & /*from*/, const SIP_PDU & /*pdu*/));
    P_REMOVE_VIRTUAL_VOID(OnMessageReceived(const SIP_PDU & /*pdu*/));

#if OPAL_HAS_IM
    virtual bool TransmitExternalIM(
      const OpalMediaFormat & format, 
      RTP_IMFrame & body
    );
#endif

    PString GetLocalPartyURL() const;

  protected:
    PDECLARE_NOTIFIER(PTimer, SIPConnection, OnSessionTimeout);
    PDECLARE_NOTIFIER(PTimer, SIPConnection, OnInviteResponseRetry);
    PDECLARE_NOTIFIER(PTimer, SIPConnection, OnAckTimeout);

    virtual bool OnSendSDP(
      bool isAnswerSDP,
      OpalRTPSessionManager & rtpSessions,
      SDPSessionDescription & sdpOut
    );
    virtual bool OfferSDPMediaDescription(
      const OpalMediaType & mediaType,
      unsigned sessionID,
      OpalRTPSessionManager & rtpSessions,
      SDPSessionDescription & sdpOut,
      bool offerOpenMediaStreamOnly = false
    );
    virtual bool AnswerSDPMediaDescription(
      const SDPSessionDescription & sdpIn,
      unsigned sessionIndex,
      SDPSessionDescription & sdpOut
    );

    virtual void OnReceivedSDP(
      SIP_PDU & pdu
    );
    virtual bool OnReceivedSDPMediaDescription(
      SDPSessionDescription & sdp,
      unsigned sessionId
    );

    virtual OpalMediaSession * SetUpMediaSession(
      const unsigned rtpSessionId,
      const OpalMediaType & mediaType,
      SDPMediaDescription * mediaDescription,
      OpalTransportAddress & localAddress,
      bool & remoteChanged
    );

    bool SendReINVITE(PTRACE_PARAM(const char * msg));
    void StartPendingReINVITE();

    friend class SIPInvite;
    static PBoolean WriteINVITE(OpalTransport & transport, void * param);
    bool WriteINVITE();

    void UpdateRemoteAddresses();

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


    // Member variables
    SIPEndPoint         & endpoint;
    OpalTransport       * transport;
    bool                  deleteTransport;
    PStringList           m_allowedEvents;

    enum HoldState {
      eHoldOff,
      eRetrieveInProgress,

      // Order is important!
      eHoldOn,
      eHoldInProgress
    };
    HoldState             m_holdToRemote;
    bool                  m_holdFromRemote;
    PString               forwardParty;

    SIP_PDU             * originalInvite;
    PTime                 originalInviteTime;
    time_t                m_sdpSessionId;
    unsigned              m_sdpVersion; // Really a sequence number
    bool                  m_needReINVITE;
    bool                  m_handlingINVITE;
    bool                  m_symmetricOpenStream;
    SIPDialogContext      m_dialog;
    OpalGloballyUniqueID  m_dialogNotifyId;
    int                   m_appearanceCode;
    PString               m_alertInfo;
    SIPAuthentication   * m_authentication;
    unsigned              m_authenticatedCseq;
    PTimer                sessionTimer;

    std::map<SIP_PDU::Methods, unsigned> m_lastRxCSeq;

    PTimer                    ackTimer;
    PTimer                    ackRetry;
    unsigned                  ackRetryCount;
    SIP_PDU                   ackPacket;
    bool                      ackReceived;
    bool                      m_referInProgress;
    PSafeList<SIPTransaction> forkedInvitations; // Not for re-INVITE
    PSafeList<SIPTransaction> pendingInvitations; // For re-INVITE
    PSafeList<SIPTransaction> m_pendingTransactions;

#if OPAL_FAX
    bool m_switchedToFaxMode;
#endif

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

    OpalMediaFormatList m_remoteFormatList;
    OpalMediaFormatList m_answerFormatList;
    void SetRemoteMediaFormats(SDPSessionDescription * sdp);

  private:
    P_REMOVE_VIRTUAL_VOID(OnCreatingINVITE(SIP_PDU&));
    P_REMOVE_VIRTUAL_VOID(OnReceivedTrying(SIP_PDU &));

  friend class SIPTransaction;
};


class SIP_RTP_Session : public RTP_UserData
{
  PCLASSINFO(SIP_RTP_Session, RTP_UserData);

    SIP_RTP_Session(
      const SIPConnection & connection  
    );

    virtual void OnTxStatistics(
      const RTP_Session & session   
    ) const;

    virtual void OnRxStatistics(
      const RTP_Session & session   
    ) const;

#if OPAL_VIDEO

    virtual void OnRxIntraFrameRequest(
      const RTP_Session & session   
    ) const;

    virtual void OnTxIntraFrameRequest(
      const RTP_Session & session   
    ) const;
#endif


    virtual void SessionFailing(RTP_Session & /*session*/);

  protected:
    const SIPConnection & connection; 
};


#endif // OPAL_SIP

#endif // OPAL_SIP_SIPCON_H


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

---