rate_limiting.hpp

Go to the documentation of this file.

#pragma once
#include <stdint.h>

#include <memory>

#include <fc/time.hpp>

namespace fc 
{
  namespace detail
  {
    class rate_limiting_group_impl;
  }

  class tcp_socket;

  class rate_limiting_group 
  {
  public:
    rate_limiting_group(uint32_t upload_bytes_per_second, uint32_t download_bytes_per_second, uint32_t burstiness_in_seconds = 1);
    ~rate_limiting_group();

    void set_upload_limit(uint32_t upload_bytes_per_second);
    uint32_t get_upload_limit() const;

    void set_download_limit(uint32_t download_bytes_per_second);
    uint32_t get_download_limit() const;

    uint32_t get_actual_upload_rate() const;
    uint32_t get_actual_download_rate() const;
    void set_actual_rate_time_constant(microseconds time_constant);

    void add_tcp_socket(tcp_socket* tcp_socket_to_limit);
    void remove_tcp_socket(tcp_socket* tcp_socket_to_stop_limiting);
  private:
    std::unique_ptr<detail::rate_limiting_group_impl> my;
  };
  typedef std::shared_ptr<rate_limiting_group> rate_limiting_group_ptr;

} // namesapce fc