rtcpabstractserver.h

Go to the documentation of this file.

// ##########################################################################
// ####                                                                  ####
// ####                      RTP Audio Server Project                    ####
// ####                    ============================                  ####
// ####                                                                  ####
// #### RTCP Abstract Server Implementation                              ####
// ####                                                                  ####
// ####           Copyright (C) 1999-2012 by Thomas Dreibholz            ####
// ####                                                                  ####
// #### Contact:                                                         ####
// ####    EMail: dreibh@iem.uni-due.de                                  ####
// ####    WWW:   https://www.nntb.no/~dreibh/rtpaudio                ####
// ####                                                                  ####
// #### ---------------------------------------------------------------- ####
// ####                                                                  ####
// #### This program is free software: you can redistribute it and/or    ####
// #### modify it under the terms of the GNU General Public License as   ####
// #### published by the Free Software Foundation, either version 3 of   ####
// #### the License, or (at your option) any later version.              ####
// ####                                                                  ####
// #### This program is distributed in the hope that it will be useful,  ####
// #### but WITHOUT ANY WARRANTY; without even the implied warranty of   ####
// #### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    ####
// #### GNU General Public License for more details.                     ####
// ####                                                                  ####
// #### You should have received a copy of the GNU General Public        ####
// #### License along with this program.  If not, see                    ####
// #### <http://www.gnu.org/licenses/>.                                  ####
// ####                                                                  ####
// ##########################################################################
// $Id: rtcpabstractserver.h 1286 2011-12-18 13:43:16Z dreibh $


#ifndef RTCPABSTRACTSERVER_H
#define RTCPABSTRACTSERVER_H


#include "tdsystem.h"
#include "timedthread.h"
#include "rtcppacket.h"
#include "internetflow.h"
#include "sourcestateinfo.h"

#include <map>


class RTCPAbstractServer : public TimedThread
{
   // ====== Definitions ====================================================
   public:
   struct Client {
      card32       SSRC;
      InternetFlow ClientAddress;
      card64       TimeStamp;
      card64       Timeout;
      void*        UserData;
   };


   // ====== Constructor/Destructor =========================================
   RTCPAbstractServer();

   ~RTCPAbstractServer();


   // ====== Virtual functions ==============================================
   virtual void* newClient(Client* client, const char* cname) = 0;


   enum DeleteReason {
      DeleteReason_UserBye  = 0,
      DeleteReason_Timeout  = 1,
      DeleteReason_Shutdown = 2,
      DeleteReason_Error    = 3,
   };

   virtual void deleteClient(Client*            client,
                             const DeleteReason reason) = 0;

   virtual bool checkClient(Client* client) = 0;

   virtual void appMessage(Client*        client,
                           const char*    name,
                           void*          data,
                           const cardinal dataLength) = 0;

   virtual void sdesMessage(Client*        client,
                            const card8    type,
                            char*          data,
                            const cardinal length) = 0;

   virtual void receiverReport(Client*                   client,
                               RTCPReceptionReportBlock* report,
                               const cardinal            layer) = 0;


   virtual void outOfMemoryWarning();


   inline cardinal getMembers();


   // ====== Settings =======================================================
   inline card64 getDefaultTimeout() const;

   inline void setDefaultTimeout(const card64 timeout);


   // ====== stop() reimplementation ========================================
   void* stop();


   // ====== RTCP packet handlers ===========================================
   private:
   friend class RTCPReceiver;

   void receivedSenderReport(const InternetFlow        flow,
                             const card32              source,
                             RTCPReceptionReportBlock* report,
                             const cardinal            layer);
   void receivedReceiverReport(const InternetFlow        flow,
                               const card32              source,
                               RTCPReceptionReportBlock* report,
                               const cardinal            layer);
   void receivedSourceDescription(const InternetFlow flow,
                                  const card32       source,
                                  const card8        type,
                                  char*              data,
                                  const card8        length);
   void receivedApp(const InternetFlow flow,
                    const card32       source,
                    const char*        name,
                    void*              data,
                    const card32       dataLength);
   void receivedBye(const InternetFlow flow,
                    const card32       source,
                    const DeleteReason reason);

   Client* findClient(const card32 source, const InternetFlow flow);


   // ====== Private data ===================================================
   private:
   void timerEvent();


   card64                                DefaultTimeout;
   std::multimap<const cardinal,Client*> ClientSet;
};


#include "rtcpabstractserver.icc"


#endif