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

Base class for all RTT Estimators. More...

#include <rtt-estimator.h>

+ Inheritance diagram for ns3::RttEstimator:
+ Collaboration diagram for ns3::RttEstimator:

Public Member Functions

 RttEstimator ()
 
 RttEstimator (const RttEstimator &r)
 Copy constructor. More...
 
virtual ~RttEstimator ()
 
virtual Time AckSeq (SequenceNumber32 ackSeq)
 Note that a particular ack sequence has been received. More...
 
virtual void ClearSent ()
 Clear all history entries. More...
 
virtual Ptr< RttEstimatorCopy () const =0
 Copy object. More...
 
Time GetCurrentEstimate (void) const
 gets the current RTT estimate. More...
 
virtual TypeId GetInstanceTypeId (void) const
 
Time GetMinRto (void) const
 Get the Minimum RTO. More...
 
virtual void IncreaseMultiplier ()
 Increase the estimation multiplier up to MaxMultiplier. More...
 
virtual void Measurement (Time t)=0
 Add a new measurement to the estimator. More...
 
virtual void Reset ()
 Resets the estimation to its initial state. More...
 
virtual void ResetMultiplier ()
 Resets the estimation multiplier to 1. More...
 
virtual Time RetransmitTimeout ()=0
 Returns the estimated RTO. More...
 
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
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
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)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Attributes

Time m_currentEstimatedRtt
 Current estimate. More...
 
Time m_minRto
 minimum value of the timeout More...
 
uint16_t m_multiplier
 RTO Multiplier. More...
 
uint32_t m_nSamples
 Number of samples. More...
 

Private Attributes

RttHistory_t m_history
 List of sent packet. More...
 
Time m_initialEstimatedRtt
 Initial RTT estimation. More...
 
uint16_t m_maxMultiplier
 Maximum RTO Multiplier. More...
 
SequenceNumber32 m_next
 Next expected sequence to be sent. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

Base class for all RTT Estimators.

Doxygen introspection did not find any typical Config paths.


Attributes

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

No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::RttEstimator::RttEstimator ( )

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

References ns3::ObjectBase::ConstructSelf(), ns3::Time::GetSeconds(), m_currentEstimatedRtt, m_initialEstimatedRtt, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

ns3::RttEstimator::RttEstimator ( const RttEstimator r)

Copy constructor.

Parameters
rthe object to copy

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

References NS_LOG_FUNCTION.

ns3::RttEstimator::~RttEstimator ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

Time ns3::RttEstimator::AckSeq ( SequenceNumber32  ackSeq)
virtual

Note that a particular ack sequence has been received.

Parameters
ackSeqthe ack sequence number.
Returns
The measured RTT for this ack.

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

References ns3::RttHistory::count, m_history, Measurement(), ns3::Simulator::Now(), NS_LOG_FUNCTION, ResetMultiplier(), ns3::RttHistory::retx, ns3::RttHistory::seq, and ns3::RttHistory::time.

+ Here is the call graph for this function:

void ns3::RttEstimator::ClearSent ( )
virtual

Clear all history entries.

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

References m_history, m_next, and NS_LOG_FUNCTION.

virtual Ptr<RttEstimator> ns3::RttEstimator::Copy ( ) const
pure virtual

Copy object.

Returns
a copy of itself

Implemented in ns3::RttMeanDeviation.

Time ns3::RttEstimator::GetCurrentEstimate ( void  ) const

gets the current RTT estimate.

Returns
The current RTT estimate.

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

References m_currentEstimatedRtt.

Referenced by RttTestCase::DoRun().

+ Here is the caller graph for this function:

TypeId ns3::RttEstimator::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::Object.

Reimplemented in ns3::RttMeanDeviation.

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

References GetTypeId().

+ Here is the call graph for this function:

Time ns3::RttEstimator::GetMinRto ( void  ) const

Get the Minimum RTO.

Returns
The minimum RTO returned by the estimator.

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

References m_minRto.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

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

Get the type ID.

Returns
the object TypeId

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

References GetMinRto(), m_initialEstimatedRtt, m_maxMultiplier, ns3::MakeTimeChecker(), SetMinRto(), and ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::RttEstimator::IncreaseMultiplier ( )
virtual

Increase the estimation multiplier up to MaxMultiplier.

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

References m_maxMultiplier, m_multiplier, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

virtual void ns3::RttEstimator::Measurement ( Time  t)
pure virtual

Add a new measurement to the estimator.

Pure virtual function.

Parameters
tthe new RTT measure.

Implemented in ns3::RttMeanDeviation.

Referenced by AckSeq().

+ Here is the caller graph for this function:

void ns3::RttEstimator::Reset ( void  )
virtual

Resets the estimation to its initial state.

Reimplemented in ns3::RttMeanDeviation.

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

References m_currentEstimatedRtt, m_history, m_initialEstimatedRtt, m_next, m_nSamples, NS_LOG_FUNCTION, and ResetMultiplier().

Referenced by ns3::RttMeanDeviation::Reset().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::RttEstimator::ResetMultiplier ( )
virtual

Resets the estimation multiplier to 1.

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

References m_multiplier, and NS_LOG_FUNCTION.

Referenced by AckSeq(), and Reset().

+ Here is the caller graph for this function:

virtual Time ns3::RttEstimator::RetransmitTimeout ( )
pure virtual

Returns the estimated RTO.

Pure virtual function.

Returns
the estimated RTO.

Implemented in ns3::RttMeanDeviation.

void ns3::RttEstimator::SentSeq ( SequenceNumber32  seq,
uint32_t  size 
)
virtual

Note that a particular sequence has been sent.

Parameters
seqthe packet sequence number.
sizethe packet size.

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

References m_history, m_next, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

void ns3::RttEstimator::SetCurrentEstimate ( Time  estimate)

Sets the current RTT estimate (forcefully).

Parameters
estimateThe current RTT estimate.

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

References m_currentEstimatedRtt, and NS_LOG_FUNCTION.

void ns3::RttEstimator::SetMinRto ( Time  minRto)

Sets the Minimum RTO.

Parameters
minRtoThe minimum RTO returned by the estimator.

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

References m_minRto, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

Member Data Documentation

Time ns3::RttEstimator::m_currentEstimatedRtt
protected
RttHistory_t ns3::RttEstimator::m_history
private

List of sent packet.

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

Referenced by AckSeq(), ClearSent(), Reset(), and SentSeq().

Time ns3::RttEstimator::m_initialEstimatedRtt
private

Initial RTT estimation.

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

Referenced by GetTypeId(), Reset(), and RttEstimator().

uint16_t ns3::RttEstimator::m_maxMultiplier
private

Maximum RTO Multiplier.

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

Referenced by GetTypeId(), and IncreaseMultiplier().

Time ns3::RttEstimator::m_minRto
protected

minimum value of the timeout

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

Referenced by GetMinRto(), ns3::RttMeanDeviation::RetransmitTimeout(), and SetMinRto().

uint16_t ns3::RttEstimator::m_multiplier
protected

RTO Multiplier.

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

Referenced by IncreaseMultiplier(), ResetMultiplier(), and ns3::RttMeanDeviation::RetransmitTimeout().

SequenceNumber32 ns3::RttEstimator::m_next
private

Next expected sequence to be sent.

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

Referenced by ClearSent(), Reset(), and SentSeq().

uint32_t ns3::RttEstimator::m_nSamples
protected

Number of samples.

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

Referenced by ns3::RttMeanDeviation::Measurement(), and Reset().


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