NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
ndn::util::RttEstimatorWithStats Class Reference

RTT/RTO estimator that also maintains min/max/average RTT statistics. More...

#include <rtt-estimator.hpp>

Inheritance diagram for ndn::util::RttEstimatorWithStats:
Collaboration diagram for ndn::util::RttEstimatorWithStats:

Public Member Functions

void addMeasurement (time::nanoseconds rtt, size_t nExpectedSamples=1)
 Records a new RTT measurement. More...
time::nanoseconds getMinRtt () const
 Returns the minimum RTT observed. More...
time::nanoseconds getMaxRtt () const
 Returns the maximum RTT observed. More...
time::nanoseconds getAvgRtt () const
 Returns the average RTT. More...
 RttEstimator (shared_ptr< const Options > options=nullptr)
 Constructor. More...
bool hasSamples () const
time::nanoseconds getEstimatedRto () const
 Returns the estimated RTO value. More...
time::nanoseconds getSmoothedRtt () const
 Returns the smoothed RTT value (SRTT). More...
time::nanoseconds getRttVariation () const
 Returns the RTT variation (RTTVAR). More...
void backoffRto ()
 Backoff RTO by a factor of Options::rtoBackoffMultiplier. More...

Detailed Description

RTT/RTO estimator that also maintains min/max/average RTT statistics.

Definition at line 126 of file rtt-estimator.hpp.

Member Function Documentation

◆ addMeasurement()

void ndn::util::RttEstimatorWithStats::addMeasurement ( time::nanoseconds  rtt,
size_t  nExpectedSamples = 1 

Records a new RTT measurement.

rttthe sampled RTT
nExpectedSamplesnumber of expected samples, must be greater than 0. It should be set to the current number of in-flight Interests. Please refer to Appendix G of RFC 7323 for details.
Do not call this function with RTT samples from retransmitted Interests (per Karn's algorithm).

Definition at line 74 of file rtt-estimator.cpp.

References ndn::util::RttEstimator::addMeasurement().

◆ getMinRtt()

time::nanoseconds ndn::util::RttEstimatorWithStats::getMinRtt ( ) const

Returns the minimum RTT observed.

Definition at line 153 of file rtt-estimator.hpp.

◆ getMaxRtt()

time::nanoseconds ndn::util::RttEstimatorWithStats::getMaxRtt ( ) const

Returns the maximum RTT observed.

Definition at line 162 of file rtt-estimator.hpp.

◆ getAvgRtt()

time::nanoseconds ndn::util::RttEstimatorWithStats::getAvgRtt ( ) const

Returns the average RTT.

Definition at line 171 of file rtt-estimator.hpp.

◆ RttEstimator()



optionsoptions for the estimator; if nullptr, a default set of options is used

Definition at line 60 of file rtt-estimator.cpp.

◆ hasSamples()

bool ndn::util::RttEstimator::hasSamples

Definition at line 74 of file rtt-estimator.hpp.

◆ getEstimatedRto()

time::nanoseconds ndn::util::RttEstimator::getEstimatedRto

Returns the estimated RTO value.

Definition at line 83 of file rtt-estimator.hpp.

◆ getSmoothedRtt()

time::nanoseconds ndn::util::RttEstimator::getSmoothedRtt

Returns the smoothed RTT value (SRTT).

hasSamples() == true

Definition at line 93 of file rtt-estimator.hpp.

◆ getRttVariation()

time::nanoseconds ndn::util::RttEstimator::getRttVariation

Returns the RTT variation (RTTVAR).

hasSamples() == true

Definition at line 103 of file rtt-estimator.hpp.

◆ backoffRto()

void ndn::util::RttEstimator::backoffRto

Backoff RTO by a factor of Options::rtoBackoffMultiplier.

Definition at line 112 of file rtt-estimator.cpp.

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