epee::net_utils::network_throttle Class Reference

#include <network_throttle-detail.hpp>

Inheritance diagram for epee::net_utils::network_throttle:

Collaboration diagram for epee::net_utils::network_throttle:

Public Member Functions
	network_throttle (const std::string &nameshort, const std::string &name, int window_size=-1)
virtual	~network_throttle ()
virtual void	set_name (const std::string &name)
virtual void	set_target_speed (network_speed_kbps target)
virtual network_speed_kbps	get_target_speed ()
virtual void	handle_trafic_exact (size_t packet_size)
	count the new traffic/packet; the size is exact considering all network costs
virtual void	handle_trafic_tcp (size_t packet_size)
	count the new traffic/packet; the size is as TCP, we will consider MTU etc
virtual void	tick ()
	poke and update timers/history (recalculates, moves the history if needed, checks the real clock etc)
virtual double	get_time_seconds () const
	timer that we use, time in seconds, monotionic
virtual void	calculate_times (size_t packet_size, calculate_times_struct &cts, bool dbg, double force_window) const
	MAIN LOGIC (see base class for info).
virtual network_time_seconds	get_sleep_time_after_tick (size_t packet_size)
	increase the timer if needed, and get the package size
virtual network_time_seconds	get_sleep_time (size_t packet_size) const
	gets the Delay (recommended Delay time) from calc. (not safe: only if time didnt change?) TODO
virtual size_t	get_recommended_size_of_planned_transport () const
	what should be the size (bytes) of next data block to be transported
virtual size_t	get_recommended_size_of_planned_transport_window (double force_window) const
	ditto, but for given windows time frame
virtual double	get_current_speed () const
virtual void	get_stats (uint64_t &total_packets, uint64_t &total_bytes) const

Detailed Description

Definition at line 49 of file network_throttle-detail.hpp.

Constructor & Destructor Documentation

network_throttle()

epee::net_utils::network_throttle::network_throttle	(	const std::string &	nameshort,
		const std::string &	name,
		int	window_size = -1 )

Definition at line 126 of file network_throttle-detail.cpp.

    : m_window_size( (window_size==-1) ? 10 : window_size  ),
      m_history( m_window_size ), m_nameshort(nameshort)
{
    set_name(name);
    m_network_add_cost = 128;
    m_network_minimal_segment = 256;
    m_network_max_segment = 1024*1024;
    m_start_time = 0;
    m_any_packet_yet = false;
    m_slot_size = 1.0; // hard coded in few places
    m_target_speed = 16 * 1024; // other defaults are probably defined in the command-line parsing code when this class is used e.g. as main global throttle
    m_last_sample_time = 0;
    m_history.resize(m_window_size);
    m_total_packets = 0;
    m_total_bytes = 0;
}

Here is the call graph for this function:

~network_throttle()

epee::net_utils::network_throttle::~network_throttle ( )

virtual

Definition at line 119 of file network_throttle-detail.cpp.

{ }

Member Function Documentation

calculate_times()

void epee::net_utils::network_throttle::calculate_times ( size_t packet_size, calculate_times_struct & cts, bool dbg, double force_window ) const

virtual

MAIN LOGIC (see base class for info).

Implements epee::net_utils::i_network_throttle.

Definition at line 249 of file network_throttle-detail.cpp.

{
    const double the_window_size = std::max( (double)m_window_size ,
        ((force_window>0) ? force_window : m_window_size) 
    );
 
    if (!m_any_packet_yet) {
        cts.window=0; cts.average=0; cts.delay=0; 
        cts.recomendetDataSize = m_network_minimal_segment; // should be overrided by caller anyway
        return ; // no packet yet, I can not decide about sleep time
    }
 
    network_time_seconds window_len = (the_window_size-1) * m_slot_size ; // -1 since current slot is not finished
    window_len += (m_last_sample_time - time_to_slot(m_last_sample_time));  // add the time for current slot e.g. 13.7-13 = 0.7
 
    auto time_passed = get_time_seconds() - m_start_time;
    cts.window = std::max( std::min( window_len , time_passed ) , m_slot_size )  ; // window length resulting from size of history but limited by how long ago history was started,
    // also at least slot size (e.g. 1 second) to not be ridiculous
    // window_len e.g. 5.7 because takes into account current slot time
 
    size_t Epast = 0; // summ of traffic till now
    for (auto sample : m_history) Epast += sample.m_size; 
 
    const size_t E = Epast;
    const size_t Enow = Epast + packet_size ; // including the data we're about to send now
 
    const double M = m_target_speed; // max
    const double D1 = (Epast - M*cts.window) / M; // delay - how long to sleep to get back to target speed
    const double D2 = (Enow  - M*cts.window) / M; // delay - how long to sleep to get back to target speed (including current packet)
 
    cts.delay = (D1*0.80 + D2*0.20); // finall sleep depends on both with/without current packet
    //              update_overheat();
    cts.average = Epast/cts.window; // current avg. speed (for info)
 
    if (Epast <= 0) {
        if (cts.delay>=0) cts.delay = 0; // no traffic in history so we will not wait
    }
 
    double Wgood=-1;
    {   // how much data we recommend now to download
        Wgood = the_window_size + 1;
        cts.recomendetDataSize = M*cts.window - E;
    }
 
    if (dbg) {
        std::ostringstream oss; oss << "[";     for (auto sample: m_history) oss << sample.m_size << " ";    oss << "]" << std::ends;
        std::string history_str = oss.str();
        MTRACE((cts.delay > 0 ? "SLEEP" : "")
            << "dbg " << m_name << ": " 
            << "speed is A=" << std::setw(8) <<cts.average<<" vs "
            << "Max=" << std::setw(8) <<M<<" "
            << " so sleep: "
            << "D=" << std::setw(8) <<cts.delay<<" sec "
            << "E="<< std::setw(8) << E << " (Enow="<<std::setw(8)<<Enow<<") "
            << "M=" << std::setw(8) << M <<" W="<< std::setw(8) << cts.window << " "
            << "R=" << std::setw(8) << cts.recomendetDataSize << " Wgood" << std::setw(8) << Wgood << " "
            << "History: " << std::setw(8) << history_str << " "
            << "m_last_sample_time=" << std::setw(8) << m_last_sample_time
        );
 
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_current_speed()

double epee::net_utils::network_throttle::get_current_speed ( ) const

virtual

Definition at line 345 of file network_throttle-detail.cpp.

                                                 {
    unsigned int bytes_transferred = 0;
    if (m_history.size() == 0 || m_slot_size == 0)
        return 0;
        
    auto it = m_history.begin();
    while (it < m_history.end() - 1)
    {
        bytes_transferred += it->m_size;
        it ++;
    }
    
    return bytes_transferred / ((m_history.size() - 1) * m_slot_size);
}

get_recommended_size_of_planned_transport()

size_t epee::net_utils::network_throttle::get_recommended_size_of_planned_transport ( ) const

virtual

what should be the size (bytes) of next data block to be transported

Implements epee::net_utils::i_network_throttle.

Definition at line 334 of file network_throttle-detail.cpp.

                                                                         {
    size_t R1=0,R2=0,R3=0;
    R1 = get_recommended_size_of_planned_transport_window( -1 );
    R2 = get_recommended_size_of_planned_transport_window(m_window_size / 2);
    R3 = get_recommended_size_of_planned_transport_window( 5              );
    auto RM = std::min(R1, std::min(R2,R3));
 
    const double a1=20, a2=10, a3=10, am=10; // weight of the various windows in decisssion // TODO 70 => 20
    return (R1*a1 + R2*a2 + R3*a3 + RM*am) / (a1+a2+a3+am);
}

Here is the call graph for this function:

get_recommended_size_of_planned_transport_window()

size_t epee::net_utils::network_throttle::get_recommended_size_of_planned_transport_window ( double force_window ) const

virtual

ditto, but for given windows time frame

Definition at line 324 of file network_throttle-detail.cpp.

                                                                                                   {
    calculate_times_struct cts = { 0, 0, 0, 0};
    network_throttle::calculate_times(0, cts, true, force_window);
    cts.recomendetDataSize += m_network_add_cost;
    if (cts.recomendetDataSize<0) cts.recomendetDataSize=0;
    if (cts.recomendetDataSize>m_network_max_segment) cts.recomendetDataSize=m_network_max_segment;
    size_t RI = (long int)cts.recomendetDataSize;
    return RI;
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_sleep_time()

network_time_seconds epee::net_utils::network_throttle::get_sleep_time ( size_t packet_size ) const

virtual

gets the Delay (recommended Delay time) from calc. (not safe: only if time didnt change?) TODO

Implements epee::net_utils::i_network_throttle.

Definition at line 240 of file network_throttle-detail.cpp.

{
    double D2=0;
    calculate_times_struct cts = { 0, 0, 0, 0};
    calculate_times(packet_size, cts, true, m_window_size); D2=cts.delay;
    return D2;
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_sleep_time_after_tick()

network_time_seconds epee::net_utils::network_throttle::get_sleep_time_after_tick ( size_t packet_size )

virtual

increase the timer if needed, and get the package size

Implements epee::net_utils::i_network_throttle.

Definition at line 219 of file network_throttle-detail.cpp.

                                                                                   {
    tick();
    return get_sleep_time(packet_size);
}

Here is the call graph for this function:

get_stats()

void epee::net_utils::network_throttle::get_stats ( uint64_t & total_packets, uint64_t & total_bytes ) const

virtual

Implements epee::net_utils::i_network_throttle.

Definition at line 360 of file network_throttle-detail.cpp.

                                                                                     {
    total_packets = m_total_packets;
    total_bytes = m_total_bytes;
}

get_target_speed()

network_speed_kbps epee::net_utils::network_throttle::get_target_speed ( )

virtual

Implements epee::net_utils::i_network_throttle.

Definition at line 155 of file network_throttle-detail.cpp.

{
    return m_target_speed / 1024;
}

get_time_seconds()

double epee::net_utils::network_throttle::get_time_seconds ( ) const

virtual

timer that we use, time in seconds, monotionic

Implements epee::net_utils::i_network_throttle.

Definition at line 312 of file network_throttle-detail.cpp.

                                                {
    #if defined(__APPLE__)
    auto point = std::chrono::system_clock::now();
    #else
    auto point = std::chrono::steady_clock::now();
    #endif
    auto time_from_epoh = point.time_since_epoch();
    auto ms = std::chrono::duration_cast< std::chrono::milliseconds >( time_from_epoh ).count();
    double ms_f = ms;
    return ms_f / 1000.;
}

Here is the caller graph for this function:

handle_trafic_exact()

void epee::net_utils::network_throttle::handle_trafic_exact ( size_t packet_size )

virtual

count the new traffic/packet; the size is exact considering all network costs

Implements epee::net_utils::i_network_throttle.

Definition at line 186 of file network_throttle-detail.cpp.

{
    _handle_trafic_exact(packet_size, packet_size);
}

handle_trafic_tcp()

void epee::net_utils::network_throttle::handle_trafic_tcp ( size_t packet_size )

virtual

count the new traffic/packet; the size is as TCP, we will consider MTU etc

Implements epee::net_utils::i_network_throttle.

Definition at line 212 of file network_throttle-detail.cpp.

{
    size_t all_size = packet_size + m_network_add_cost;
    all_size = std::max( m_network_minimal_segment , all_size);
    _handle_trafic_exact( all_size , packet_size );
}

set_name()

void epee::net_utils::network_throttle::set_name ( const std::string & name )

virtual

Implements epee::net_utils::i_network_throttle.

Definition at line 144 of file network_throttle-detail.cpp.

{
    m_name = name;
}

Here is the caller graph for this function:

set_target_speed()

void epee::net_utils::network_throttle::set_target_speed ( network_speed_kbps target )

virtual

Implements epee::net_utils::i_network_throttle.

Definition at line 149 of file network_throttle-detail.cpp.

{
    m_target_speed = target * 1024;
    MINFO("Setting LIMIT: " << target << " kbps");
}

tick()

void epee::net_utils::network_throttle::tick ( )

virtual

poke and update timers/history (recalculates, moves the history if needed, checks the real clock etc)

Implements epee::net_utils::i_network_throttle.

Definition at line 160 of file network_throttle-detail.cpp.

{
    double time_now = get_time_seconds();
    if (!m_any_packet_yet) m_start_time = time_now; // starting now
 
    network_time_seconds current_sample_time_slot = time_to_slot( time_now ); // T=13.7 --> 13  (for 1-second smallwindow)
    network_time_seconds last_sample_time_slot = time_to_slot( m_last_sample_time );
 
    // moving to next position, and filling gaps
    // !! during this loop the m_last_sample_time and last_sample_time_slot mean the variable moved in +1
    // TODO optimize when moving few slots at once
    while ( (!m_any_packet_yet) || (last_sample_time_slot < current_sample_time_slot))
    {
        _dbg3("Moving counter buffer by 1 second " << last_sample_time_slot << " < " << current_sample_time_slot << " (last time " << m_last_sample_time<<")");
        // rotate buffer 
        m_history.push_front(packet_info());
        if (! m_any_packet_yet) 
        {
            m_last_sample_time = time_now;  
        }
        m_last_sample_time += 1;    last_sample_time_slot = time_to_slot( m_last_sample_time ); // increase and recalculate time, time slot
        m_any_packet_yet=true;
    }
    m_last_sample_time = time_now; // the real exact last time
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• /home/abuild/rpmbuild/BUILD/electroneum-5.1.3.1-build/electroneum-5.1.3.1/contrib/epee/include/net/network_throttle-detail.hpp
• /home/abuild/rpmbuild/BUILD/electroneum-5.1.3.1-build/electroneum-5.1.3.1/contrib/epee/src/network_throttle-detail.cpp