A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::RttMeanDeviation Class Reference

The "Mean–Deviation" RTT estimator, as discussed by Van Jacobson. More...

#include <rtt-estimator.h>

+ Inheritance diagram for ns3::RttMeanDeviation:
+ Collaboration diagram for ns3::RttMeanDeviation:

Public Member Functions

 RttMeanDeviation ()
 RttMeanDeviation (const RttMeanDeviation &)
Ptr< RttEstimatorCopy () const
void Gain (double g)
 Sets the estimator Gain.
void Measurement (Time measure)
 Add a new measurement to the estimator.
void Reset ()
 Resets sthe estimator.
Time RetransmitTimeout ()
 Returns the estimated RTO.
- Public Member Functions inherited from ns3::RttEstimator
 RttEstimator ()
 RttEstimator (const RttEstimator &)
virtual ~RttEstimator ()
virtual Time AckSeq (SequenceNumber32 ackSeq)
 Note that a particular ack sequence has been received.
virtual void ClearSent ()
 Clear all history entries.
Time GetCurrentEstimate (void) const
 gets the current RTT estimate.
Time GetMinRto (void) const
 Get the Minimum RTO.
virtual void IncreaseMultiplier ()
 Increase the estimation multiplier up to MaxMultiplier.
virtual void ResetMultiplier ()
 Resets the estimation multiplier to 1.
virtual void SentSeq (SequenceNumber32 seq, uint32_t size)
 Note that a particular sequence has been sent.
void SetCurrentEstimate (Time estimate)
 Sets the current RTT estimate (forcefully).
void SetMinRto (Time minRto)
 Sets the Minimum RTO.
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~Object ()
void AggregateObject (Ptr< Object > other)
void Dispose (void)
AggregateIterator GetAggregateIterator (void) const
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::RttMeanDeviation.

Private Attributes

double m_gain
Time m_variance

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
virtual void DoDispose (void)
virtual void DoStart (void)
virtual void NotifyNewAggregate (void)
- Protected Attributes inherited from ns3::RttEstimator
Time m_currentEstimatedRtt
Time m_minRto
uint16_t m_multiplier
uint32_t m_nSamples

Detailed Description

The "Mean&ndash;Deviation" RTT estimator, as discussed by Van Jacobson.

This class implements the "Mean&ndash;Deviation" RTT estimator, as discussed by Van Jacobson and Michael J. Karels, in "Congestion Avoidance and Control", SIGCOMM 88, Appendix A

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

Constructor & Destructor Documentation

ns3::RttMeanDeviation::RttMeanDeviation ( )

Definition at line 245 of file rtt-estimator.cc.

References NS_LOG_FUNCTION.

ns3::RttMeanDeviation::RttMeanDeviation ( const RttMeanDeviation c)

Definition at line 251 of file rtt-estimator.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

Ptr< RttEstimator > ns3::RttMeanDeviation::Copy ( void  ) const
virtual

Implements ns3::RttEstimator.

Definition at line 295 of file rtt-estimator.cc.

References NS_LOG_FUNCTION.

void ns3::RttMeanDeviation::Gain ( double  g)

Sets the estimator Gain.

Parameters
gthe gain, where 0 < g < 1.

Definition at line 308 of file rtt-estimator.cc.

References m_gain, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

TypeId ns3::RttMeanDeviation::GetTypeId ( void  )
static

This method returns the TypeId associated to ns3::RttMeanDeviation.

Attributes defined for this type:

  • Gain: Gain used in estimating the RTT, must be 0 < Gain < 1
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.1
    • Flags: construct write read

Attributes defined in parent class ns3::RttEstimator:

  • MaxMultiplier: Maximum RTO Multiplier
  • InitialEstimation: Initial RTT estimation
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +1000000000.0ns
    • Flags: construct write read
  • MinRTO: Minimum retransmit timeout value
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +200000000.0ns
    • Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::RttEstimator.

Definition at line 231 of file rtt-estimator.cc.

References m_gain, and ns3::TypeId::SetParent().

Referenced by ns3::TcpL4Protocol::GetTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::RttMeanDeviation::Measurement ( Time  measure)
virtual

Add a new measurement to the estimator.

Parameters
measurethe new RTT measure.

Implements ns3::RttEstimator.

Definition at line 257 of file rtt-estimator.cc.

References ns3::Abs(), ns3::Time::FromDouble(), ns3::RttEstimator::m_currentEstimatedRtt, m_gain, ns3::RttEstimator::m_nSamples, m_variance, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Time::S, and ns3::Time::ToDouble().

+ Here is the call graph for this function:

void ns3::RttMeanDeviation::Reset ( void  )
virtual

Resets sthe estimator.

Reimplemented from ns3::RttEstimator.

Definition at line 301 of file rtt-estimator.cc.

References m_variance, NS_LOG_FUNCTION, and ns3::Seconds().

+ Here is the call graph for this function:

Time ns3::RttMeanDeviation::RetransmitTimeout ( )
virtual

Returns the estimated RTO.

Returns
the estimated RTO.

Implements ns3::RttEstimator.

Definition at line 279 of file rtt-estimator.cc.

References ns3::Time::FromInteger(), ns3::Time::GetSeconds(), ns3::RttEstimator::m_currentEstimatedRtt, ns3::RttEstimator::m_minRto, ns3::RttEstimator::m_multiplier, m_variance, ns3::Time::MS, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Time::ToInteger().

+ Here is the call graph for this function:

Member Data Documentation

double ns3::RttMeanDeviation::m_gain
private

Definition at line 196 of file rtt-estimator.h.

Referenced by Gain(), GetTypeId(), and Measurement().

Time ns3::RttMeanDeviation::m_variance
private

Definition at line 197 of file rtt-estimator.h.

Referenced by Measurement(), Reset(), and RetransmitTimeout().


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