trafficshaper.h

Go to the documentation of this file.

// ##########################################################################
// ####                                                                  ####
// ####                      RTP Audio Server Project                    ####
// ####                    ============================                  ####
// ####                                                                  ####
// #### Traffic Shaper                                                   ####
// ####                                                                  ####
// ####           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: trafficshaper.h 1286 2011-12-18 13:43:16Z dreibh $


#ifndef TRAFFICSHAPER_H
#define TRAFFICSHAPER_H


#include "tdsystem.h"
#include "tdsocket.h"
#include "internetaddress.h"
#include "timedthread.h"
#include "trafficclassvalues.h"


#include <set>
#include <deque>
#include <vector>


class TrafficShaper;


class TrafficShaperSingleton : public TimedThread
{
   // ====== Constructor/Destructor =========================================
   public:
   TrafficShaperSingleton();

   ~TrafficShaperSingleton();


   // ====== Add/remove traffic shapers =====================================
   void addTrafficShaper(TrafficShaper* ts);

   void removeTrafficShaper(TrafficShaper* ts);


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


   std::vector<TrafficShaper*> ShaperSet;
   cardinal                    UserCount;
};



class TrafficShaper : public Synchronizable
{
   // ====== Constructor/Destructor =========================================
   public:
   TrafficShaper();

   TrafficShaper(Socket* socket);

   ~TrafficShaper();


   // ====== Initialize =====================================================
   void init(Socket* socket);


   // ====== Set sender socket ==============================================
   inline void setSocket(Socket* socket);


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

   inline void setBandwidth(const card64 bandwidth);

   inline double getBufferDelay() const;

   inline void setBufferDelay(const double bufferDelay);


   // ====== Buffer manipulation ============================================
   void flush();

   bool refreshBuffer(const card8 trafficClass,
                      const bool doRemapping);

   inline cardinal getLastSeqNum();


   // ====== I/O functions ==================================================
    ssize_t sendTo(const void*         buffer,
                   const size_t        length,
                   const cardinal      seqNum,
                   const cardinal      flags,
                   const InternetFlow& receiver,
                   const card8         trafficClass = 0);

    ssize_t send(const void*    buffer,
                 const size_t   length,
                 const cardinal seqNum,
                 const cardinal flags        = 0,
                 const card8    trafficClass = 0);

   ssize_t write(const void*    buffer,
                 const size_t   length,
                 const cardinal seqNum);


   // ====== Private data ===================================================
   private:
   void sendAll();
   ssize_t addPacket(const void*    data,
                     const cardinal bytes,
                     const cardinal seqNum,
                     InternetFlow&  destination,
                     const cardinal flags,
                     const cardinal command);


   enum TrafficShaperCommand {
      TSC_Write  = 0,
      TSC_Send   = 1,
      TSC_SendTo = 2
   };

   struct TrafficShaperPacket {
      card64       SendTimeStamp;
      cardinal     HeaderSize;
      cardinal     PayloadSize;
      cardinal     Flags;
      cardinal     Command;
      InternetFlow Destination;
      char*        Data;
      cardinal     SeqNum;

      inline int operator<(const TrafficShaperPacket& packet) const {
         return(SendTimeStamp < packet.SendTimeStamp);
      }
   };

   friend class TrafficShaperSingleton;


   static TrafficShaperSingleton   Singleton;
   std::deque<TrafficShaperPacket> Queue;
   Socket*                         SenderSocket;
   card64                          SendTimeStamp;
   card64                          Bandwidth;
   double                          BufferDelay;
   integer                         LastError;
   cardinal                        LastSeqNum;
};


#include "trafficshaper.icc"


#endif