A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends 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:

Public Member Functions

 RttMeanDeviation (const RttMeanDeviation &)
 
Ptr< RttEstimatorCopy () const
 
void Gain (double g)
 Sets the estimator Gain. More...
 
virtual TypeId GetInstanceTypeId (void) const
 
void Measurement (Time measure)
 Add a new measurement to the estimator. More...
 
void Reset ()
 Resets sthe estimator.
 
Time RetransmitTimeout ()
 Returns the estimated RTO. More...
 
- Public Member Functions inherited from ns3::RttEstimator
 RttEstimator (const RttEstimator &)
 
virtual Time AckSeq (SequenceNumber32 ackSeq)
 Note that a particular ack sequence has been received. More...
 
virtual void ClearSent ()
 Clear all history entries.
 
Time GetCurrentEstimate (void) const
 gets the current RTT estimate. More...
 
Time GetMinRto (void) const
 Get the Minimum RTO. More...
 
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. More...
 
void SetCurrentEstimate (Time estimate)
 Sets the current RTT estimate (forcefully). More...
 
void SetMinRto (Time minRto)
 Sets the Minimum RTO. More...
 
- Public Member Functions inherited from ns3::Object
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
AggregateIterator GetAggregateIterator (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 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
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)
 
- Static Public Member Functions inherited from ns3::RttEstimator
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

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 DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (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--Deviation" RTT estimator, as discussed by Van Jacobson.

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

Doxygen introspection did not find any typical Config paths.

Attributes

  • 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 are defined for this type.

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

Member Function Documentation

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

Sets the estimator Gain.

Parameters
gthe gain, where 0 < g < 1.

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

References NS_ASSERT_MSG, and NS_LOG_FUNCTION.

TypeId ns3::RttMeanDeviation::GetInstanceTypeId ( void  ) const
virtual
Returns
the TypeId associated to the most-derived type of this instance.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Reimplemented from ns3::RttEstimator.

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

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 269 of file rtt-estimator.cc.

References ns3::Time::FromDouble(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Time::ToDouble().

Referenced by RttTestCase::DoRun().

Time ns3::RttMeanDeviation::RetransmitTimeout ( )
virtual

Returns the estimated RTO.

Returns
the estimated RTO.

Implements ns3::RttEstimator.

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

References ns3::Time::FromInteger(), ns3::Time::GetSeconds(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Time::ToInteger().

Referenced by RttTestCase::DoRun().


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