trafficshaper.h

Go to the documentation of this file.

// ##########################################################################
// ####                                                                  ####
// ####                    Master Thesis Implementation                  ####
// ####  Management of Layered Variable Bitrate Multimedia Streams over  ####
// ####                  DiffServ with A Priori Knowledge                ####
// ####                                                                  ####
// #### ================================================================ ####
// ####                                                                  ####
// ####                                                                  ####
// #### Traffic Shaper                                                   ####
// ####                                                                  ####
// #### Version 1.00  --  February 19, 2001                              ####
// ####                                                                  ####
// #### Copyright (C) 2000/2001 Thomas Dreibholz                         ####
// #### University of Bonn, Department of Computer Science IV            ####
// #### EMail: dreibh@iem.uni-due.de                                     ####
// #### WWW:   https://www.uni-due.de/~be0001/diplom/index.html          ####
// ####                                                                  ####
// ##########################################################################


#ifndef TRAFFICSHAPER_H
#define TRAFFICSHAPER_H


#include "system.h"
#include "socket.h"
#include "internetaddress.h"
#include "timedthread.h"
#include "trafficclassvalues.h"


#include <deque.h>
#include <vector.h>


namespace Coral {


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();


   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() const;


   // ====== 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;
   deque<TrafficShaperPacket>    Queue;
   Socket*                       SenderSocket;
   card64                        SendTimeStamp;
   card64                        Bandwidth;
   double                        BufferDelay;
   integer                       LastError;
   cardinal                      LastSeqNum;
};


}


#include "trafficshaper.icc"


#endif