rtt-estimator.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (C) 2016-2024, Arizona Board of Regents.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 *
 * @author Shuo Yang
 * @author Weiwei Liu
 * @author Chavoosh Ghasemi
 * @author Davide Pesavento
 */
 
#ifndef NDN_CXX_UTIL_RTT_ESTIMATOR_HPP
#define NDN_CXX_UTIL_RTT_ESTIMATOR_HPP
 
#include "ndn-cxx/util/time.hpp"
 
#include <memory>
 
namespace ndn::util {
 
class RttEstimator
{
public:
  struct Options
  {
    double alpha = 0.125; 
    double beta = 0.25; 
    time::nanoseconds initialRto = 1_s; 
    time::nanoseconds minRto = 200_ms; 
    time::nanoseconds maxRto = 1_min; 
    int k = 4; 
    int rtoBackoffMultiplier = 2; 
  };
 
  explicit
  RttEstimator(std::shared_ptr<const Options> options = nullptr);
 
  void
  addMeasurement(time::nanoseconds rtt, size_t nExpectedSamples = 1);
 
  bool
  hasSamples() const
  {
    return m_sRtt != -1_ns;
  }
 
  time::nanoseconds
  getEstimatedRto() const
  {
    return m_rto;
  }
 
  time::nanoseconds
  getSmoothedRtt() const
  {
    return m_sRtt;
  }
 
  time::nanoseconds
  getRttVariation() const
  {
    return m_rttVar;
  }
 
  void
  backoffRto();
 
protected:
  std::shared_ptr<const Options> m_options;
 
private:
  time::nanoseconds m_sRtt{-1};   
  time::nanoseconds m_rttVar{-1}; 
  time::nanoseconds m_rto;        
};
 
class RttEstimatorWithStats : private RttEstimator
{
public:
  using RttEstimator::Options;
  using RttEstimator::RttEstimator;
 
  using RttEstimator::hasSamples;
  using RttEstimator::getEstimatedRto;
  using RttEstimator::getSmoothedRtt;
  using RttEstimator::getRttVariation;
  using RttEstimator::backoffRto;
 
  void
  addMeasurement(time::nanoseconds rtt, size_t nExpectedSamples = 1);
 
  time::nanoseconds
  getMinRtt() const
  {
    return m_rttMin;
  }
 
  time::nanoseconds
  getMaxRtt() const
  {
    return m_rttMax;
  }
 
  time::nanoseconds
  getAvgRtt() const
  {
    return m_rttAvg;
  }
 
private:
  time::nanoseconds m_rttMin = time::nanoseconds::max();
  time::nanoseconds m_rttMax = time::nanoseconds::min();
  time::nanoseconds m_rttAvg = 0_ns;
  int64_t m_nRttSamples = 0;
};
 
} // namespace ndn::util
 
#endif // NDN_CXX_UTIL_RTT_ESTIMATOR_HPP