roundtriptimepinger.h

Go to the documentation of this file.

// ##########################################################################
// ####                                                                  ####
// ####                      RTP Audio Server Project                    ####
// ####                    ============================                  ####
// ####                                                                  ####
// #### Round Trip Time Pinger                                           ####
// ####                                                                  ####
// ####           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: roundtriptimepinger.h 1316 2011-12-23 11:36:11Z dreibh $


#ifndef ROUNDTRIPTIMEPINGER_H
#define ROUNDTRIPTIMEPINGER_H


#include "tdsystem.h"
#include "tdsocket.h"
#include "internetaddress.h"
#include "timedthread.h"
#include "rtppacket.h"
#include "pingerhost.h"
#include "randomizer.h"


#include <set>
#include <algorithm>
#include <fstream>

#include <netinet/ip.h>
#include <netinet/ip_icmp.h>
#include <netinet/icmp6.h>
#include <sys/time.h>


class RoundTripTimePinger : public TimedThread
{
   // ====== Constructor ===================================================
   public:
   RoundTripTimePinger(Socket*      ping4socket,
                       Socket*      ping6socket,
                       const card64 delay = 1000000);

   ~RoundTripTimePinger();


   // ====== Status functions ===============================================
   inline bool ready() const;

   inline cardinal getHosts();


   inline double getAlpha();

   inline void setAlpha(const double alpha);


   inline card64 getMaxPingDelay();

   inline void setMaxPingDelay(const card64 delay);


   cardinal getRoundTripTime(const InternetAddress& address,
                             const card8            trafficClass = 0x00);


   // ====== Adding/removing hosts ==========================================
   bool addHost(const InternetAddress& address,
                const card8            trafficClass = 0x00);

   void removeHost(const InternetAddress& address,
                   const card8            trafficClass = 0x00);

   // ====== GNUplot output generator =======================================
   void activateLogger(std::ostream* scriptStream,
                       std::ostream* dataStream,
                       const char*   dataName);

   void deactivateLogger();

   inline bool isLogging() const;

   void writeGPHeader(std::ostream&       os,
                      const char*    dataName,
                      const cardinal lineStyle = 1);

   void writeGPData(std::ostream& os);


   // ====== Output operator ================================================
   friend std::ostream& operator<<(std::ostream& os, RoundTripTimePinger& pinger);


   // ====== Constants ======================================================
   static const cardinal MaxRoundTripTime = 180000000;

   static const double UnreachableFactor = 2.0;

   static const card64 MinUnreachableAsumption = 2500000;


   // ====== Private data ===================================================
   private:
   void timerEvent();
   void calculateRoundTripTime(const InternetAddress& address,
                               const card8            trafficClass,
                               const card64           sendTime,
                               const card64           arrivalTime);
   card16 calculateChecksum(const card16*  addr,
                            const cardinal length,
                            card16         csum);
   card64 sendPing4(const InternetAddress& destination,
                    const card8            trafficClass,
                    const card16           sequenceNumber);
   card64 sendPing6(const InternetAddress& destination,
                    const card8            trafficClass,
                    const card16           sequenceNumber);
   bool receiveEcho4();
   bool receiveEcho6();
   void checkUnreachable(PingerHost& host);


   struct Ping4Packet
   {
      icmp   Header;
      card64 TimeStamp;
   };

   struct Ping6Packet
   {
      icmp6_hdr Header;
      card64    TimeStamp;
   };


   Socket*                   Ping4Socket;
   Socket*                   Ping6Socket;
   double                    RoundTripTimeAlpha;
   std::multiset<PingerHost> HostSet;
   card64                    GPHeaderTimeStamp;
   bool                      Ready;
   bool                      Logger;
   std::ostream*             LoggerScriptStream;
   std::ostream*             LoggerDataStream;
   card64                    MaxPingDelay;
   Randomizer                Random;
};


#include "roundtriptimepinger.icc"


#endif