RTCPSession.h

Go to the documentation of this file.

//
// Copyright (C) 2006-2013 SIPez LLC.  All rights reserved.
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$


//  Border Guard
#ifndef _RTCPSession_h
#define _RTCPSession_h

#include "rtcp/RtcpConfig.h"

//  Includes
#include "TLinkedList.h"
#include "RTCPConnection.h"
#include "IRTCPRender.h"
#include "INetworkRender.h"
#include "IRTCPSession.h"
#include "IRTCPNotify.h"


class CRTCPSession:
           public CBaseClass,   // Inherits CBaseClass implementation
           public CTLinkedList<CRTCPConnection *>,
                                // Inherit Connection Linked List Services
           public IRTCPSession, // Interface exposed for RTCP Session Control
           public IRTCPNotify   // Interface exposed for RTCP Notifications
 {

//  Public Methods
public:

    CRTCPSession(unsigned long ulSSRC,
                 IRTCPNotify *piRTCPNotify,
                 ISDESReport *piSDESReport);

    ~CRTCPSession(void);



    IRTCPConnection *CreateRTCPConnection(void);


    bool TerminateRTCPConnection(IRTCPConnection *piRTCPConnection);

    void TerminateAllConnections(void);

    void ReassignSSRC(unsigned long ulSSRC, unsigned char *puchReason=NULL);

    void ForwardSDESReport(IGetSrcDescription *piGetSrcDescription,
                           IRTCPConnection  *piRTCPConnection);


    void ForwardByeReport(IGetByeInfo      *piGetByeInfo,
                          IRTCPConnection  *piRTCPConnection);

    void CheckLocalSSRCCollisions(void);

    void CheckRemoteSSRCCollisions(IRTCPConnection *piRTCPConnection);

    void SetMixerMode(MIXER_MODE_ET etMixerMode);

    MIXER_MODE_ET GetMixerMode(void);

    unsigned long GetSessionID(void);

    ssrc_t GetSSRC(int, int, int);

    unsigned long GetEventInterest(void);


    IRTCPConnection *GetFirstConnection(void);

    IRTCPConnection *GetNextConnection(void);


    IRTCPConnection *CheckConnection(IRTCPConnection *);


    void NewSDES(IGetSrcDescription *piGetSrcDescription,
                 IRTCPConnection    *piRTCPConnection,
                 IRTCPSession       *piRTCPSession=NULL);

    void UpdatedSDES(IGetSrcDescription *piGetSrcDescription,
                     unsigned long       ulChangeMask,
                     IRTCPConnection    *piRTCPConnection,
                     IRTCPSession       *piRTCPSession=NULL);


    void SenderReportReceived(IGetSenderStatistics *piGetSenderStatistics,
                              IRTCPConnection    *piRTCPConnection,
                              IRTCPSession       *piRTCPSession=NULL);


  void ReceiverReportReceived(IGetReceiverStatistics *piGetReceiverStatistics,
                                IRTCPConnection        *piRTCPConnection,
                                IRTCPSession           *piRTCPSession=NULL);


    void ByeReportReceived(IGetByeInfo *piGetByeInfo,
                           IRTCPConnection    *piRTCPConnection,
                           IRTCPSession       *piRTCPSession=NULL);

    void SDESReportSent(IGetSrcDescription *piGetSrcDescription,
                        IRTCPConnection    *piRTCPConnection,
                        IRTCPSession       *piRTCPSession=NULL);

    void SenderReportSent(IGetSenderStatistics *piGetSenderStatistics,
                          IRTCPConnection    *piRTCPConnection,
                          IRTCPSession       *piRTCPSession=NULL);


    void ReceiverReportSent(IGetReceiverStatistics *piGetReceiverStatistics,
                            IRTCPConnection        *piRTCPConnection,
                            IRTCPSession           *piRTCPSession=NULL);


    void ByeReportSent(IGetByeInfo      *piGetByeInfo,
                       IRTCPConnection  *piRTCPConnection,
                       IRTCPSession     *piRTCPSession=NULL);

    void RTCPReportingAlarm(IRTCPConnection *piRTCPConnection,
                            IRTCPSession *piRTCPSession=NULL);


    void RTCPConnectionStopped(IRTCPConnection     *piRTCPConnection,
                                 IRTCPSession        *piRTCPSession=NULL);



DECLARE_IBASE_M

private:        // Private Member Functions

    void ResetAllConnections(unsigned char *puchReason);


private:        // Private Data Members


      ssrc_t m_ulSSRC;

      unsigned long m_ulSessionID;

      unsigned long m_ulEventInterest;

      MIXER_MODE_ET m_etMixerMode;

      IRTCPNotify * m_piRTCPNotify;

      ISDESReport *m_piSDESReport;

};


inline unsigned long CRTCPSession::GetEventInterest(void)
{

    return(m_ulEventInterest);
}

inline IRTCPConnection
             *CRTCPSession::CheckConnection(IRTCPConnection *piRTCPConnection)
{
    // Attempt to retrieve the connection from the collection
    CRTCPConnection *poRTCPConnection =
                           GetEntry((CRTCPConnection *)piRTCPConnection);

    // See whether the Render object is still active
    if(poRTCPConnection)
    {
        IRTCPRender *piRtcpRender = poRTCPConnection->GetRenderInterface();
        if(piRtcpRender)
        {
            piRtcpRender->Release(ADD_RELEASE_CALL_ARGS(__LINE__));
            return((IRTCPConnection *)poRTCPConnection);
        }
    }

    return(NULL);

}


inline void CRTCPSession::SetMixerMode(MIXER_MODE_ET etMixerMode)
{

//  Set the mixer attribute for this session
    m_etMixerMode = etMixerMode;

}

inline MIXER_MODE_ET CRTCPSession::GetMixerMode(void)
{

//  return the mixer attribute for this session
    return(m_etMixerMode);
}

inline unsigned long CRTCPSession::GetSessionID(void)
{

    return(m_ulSessionID);

}

#endif