RTCPConnection.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 _RTCPConnection_h
#define _RTCPConnection_h

#include "rtcp/RtcpConfig.h"

//  Includes
#include "NetworkChannel.h"
#include "RTCPSource.h"
#include "RTCPRender.h"
#include "RTCPTimer.h"
#include "IRTCPSession.h"


class CRTCPConnection : public CBaseClass,
                              // Inherits CBaseClass implementation
                        public CRTCPTimer,
                              // Inherit CTimer Class implementation
                        public IRTCPConnection,
                              // Interface exposed for RTCP Connection Control
                        public IRTCPNotify
                              // Interface exposed for RTCP Notifications
 {

//  Public Methods
public:

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

    ~CRTCPConnection(void);


    bool Initialize(void);


    void GetDispatchInterfaces(INetDispatch         **ppiNetDispatch,
                               IRTPDispatch         **ppiRTPDispatch,
                               ISetSenderStatistics **piSenderStats);

    unsigned long GetRemoteSSRC(void);
    bool isRemoteSSRCValid(void);


    IRTCPRender * GetRenderInterface(void);

    void GenerateRTCPReports(unsigned char *puchByeReason = NULL,
                             ssrc_t aulCSRC[] = NULL,
                             unsigned long ulCSRCs = 0);


    bool StopRenderer(void);


    bool Terminate(void);


    unsigned long GetEventInterest(void);

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

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


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


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


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

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

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


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


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

    void LocalSSRCCollision(IRTCPConnection    *piRTCPConnection=NULL,
                            IRTCPSession       *piRTCPSession=NULL) {};


    void RemoteSSRCCollision(IRTCPConnection    *piRTCPConnection=NULL,
                             IRTCPSession       *piRTCPSession=NULL) {};

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


DECLARE_IBASE_M


private:        // Private Data Members

#ifdef PINGTEL_OSSOCKET

    bool StartRenderer(OsSocket& rRtcpSocket);
#else
    bool StartRenderer(INetworkRender *piNetworkRender);
#endif



      unsigned long m_ulSSRC;

    INetworkRender *m_piRTCPNetworkRender;

      IRTCPNotify * m_piRTCPNotify;

      ISDESReport *m_piSDESReport;

      unsigned long m_ulEventInterest;



      CRTCPRender *m_poRTCPRender;


      CRTCPSource *m_poRTCPSource;


};

inline unsigned long CRTCPConnection::GetRemoteSSRC(void) { return ((m_poRTCPRender) ?  (m_poRTCPRender->GetRemoteSSRC()) : 0); }
inline bool CRTCPConnection::isRemoteSSRCValid(void) { return ((m_poRTCPRender) ?  (m_poRTCPRender->isRemoteSSRCValid()) : 0); }

inline unsigned long CRTCPConnection::GetEventInterest(void)
{

    return(m_ulEventInterest);
}

#endif