BandwidthMonitor.h

Go to the documentation of this file.

#ifndef _MADARA_BANDWIDTH_MONITOR_H
#define _MADARA_BANDWIDTH_MONITOR_H

#include <deque>
#include <time.h>

#include "madara/LockType.h"
#include "madara/utility/stdint.h"
#include "ace/Guard_T.h"
#include "ace/Recursive_Thread_Mutex.h"
#include "madara/MADARA_export.h"

namespace madara
{
  namespace transport
  {
    typedef  std::pair <time_t, uint64_t>   BandwidthRecord;
    typedef  std::deque <BandwidthRecord>  BandwidthMessages;

    class MADARA_Export BandwidthMonitor
    {
    public:
      BandwidthMonitor (time_t window_in_secs = 10);
      
      BandwidthMonitor (const BandwidthMonitor & rhs);

      virtual ~BandwidthMonitor ();

      void operator= (const BandwidthMonitor & rhs);
      
      void add (uint64_t size);

      void add (time_t timestamp, uint64_t size);

      bool is_bandwidth_violated (int64_t limit);

      void set_window (time_t window_in_secs);

      uint64_t get_utilization (void);
      
      uint64_t get_bytes_per_second (void);

      void clear (void);

      void print_utilization (void);

      size_t get_number_of_messages (void);

    protected:
      time_t update_utilization (void);

      mutable MADARA_LOCK_TYPE mutex_;

      BandwidthMessages  messages_;

      uint64_t utilization_;

      time_t window_;
    };
  }
}

#include "BandwidthMonitor.inl"

#endif   // _MADARA_BANDWIDTH_MONITOR_H