src/main/ratemeasurer.h

   1 /***************************************************************************
   2  *                                                                         *
   3  *   Copyright (C) 2006 David Brodsky                                      *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or         *
   6  *   modify it under the terms of the GNU General Public License as        *
   7  *   published by the Free Software Foundation and appearing               *
   8  *   in the file LICENSE.GPL included in the packaging of this file.       *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      *
  13  *   General Public License for more details.                              *
  14  *                                                                         *
  15  ***************************************************************************/
  16
  17 #ifndef _main_ratemeasurer_h
  18 #define _main_ratemeasurer_h
  19
  20 namespace Tairent
  21 {
  22
  23 namespace Main
  24 {
  25
  26 /** \brief Class for measuring transfer rates.
  27  */
  28 class RateMeasurer
  29 {
  30         public:
  31                 /** Constructs a RateMeasurer object.
  32                  *
  33                  * \param p Period for measuring.
  34                  */
  35                 RateMeasurer(double p);
  36
  37                 /** Destroys the object.
  38                  */
  39                 ~RateMeasurer();
  40
  41                 /** Returns current measred rate.
  42                  */
  43                 double getRate();
  44
  45                 /** Updates the rate with number of trasnferred bytes.
  46                  */
  47                 void update(unsigned int amount);
  48
  49         private:
  50                 /** Time of the last update.
  51                  */
  52                 double lastTime;
  53
  54                 /** Counting period.
  55                  */
  56                 double period;
  57
  58                 /** Current rate.
  59                  */
  60                 double rate;
  61
  62                 /** Period's start time.
  63                  */
  64                 double startTime;
  65 };
  66
  67 }; // namespace Main
  68
  69 }; // namespace Tairent
  70
  71 #endif
  72
  73 // vim: ai sw=4 ts=4 noet fdm=marker