A Discrete-Event Network Simulator
API
ns3::Ipv6PmtuCache Class Reference

This class implements the Path MTU cache, as defined by RFC 1981. More...

#include "ipv6-pmtu-cache.h"

+ Inheritance diagram for ns3::Ipv6PmtuCache:
+ Collaboration diagram for ns3::Ipv6PmtuCache:

Public Member Functions

 Ipv6PmtuCache ()
 Constructor. More...
 
 ~Ipv6PmtuCache ()
 Destructor. More...
 
virtual void DoDispose ()
 Dispose object. More...
 
uint32_t GetPmtu (Ipv6Address dst)
 Gets the known Path MTU for the specific destination. More...
 
Time GetPmtuValidityTime () const
 Gets the Path MTU validity time. More...
 
void SetPmtu (Ipv6Address dst, uint32_t pmtu)
 Sets the Path MTU for the specific destination. More...
 
bool SetPmtuValidityTime (Time validity)
 Sets the Path MTU validity time (minimum is 5 minutes) More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default 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 operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId ()
 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::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Types

typedef std::map< Ipv6Address, EventId >::iterator pathMtuTimerIter
 Container of the IPv6 PMTU data (Ipv6 destination address and expiration event). More...
 

Private Member Functions

void ClearPmtu (Ipv6Address dst)
 Clears the Path MTU for the specific destination. More...
 

Private Attributes

std::map< Ipv6Address, uint32_tm_pathMtu
 Path MTU table. More...
 
std::map< Ipv6Address, EventIdm_pathMtuTimer
 Path MTU Expiration table. More...
 
Time m_validityTime
 Path MTU entry validity time. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

This class implements the Path MTU cache, as defined by RFC 1981.

Introspection did not find any typical Config paths.

The Path MTU is stored according to the destination address, and it is cleared upon expiration (default validity time is 10 minutes).

The "infinite lifetime" PMTU entry type is not implemented, since it is useful only in an very limited number of cases. See the RFC for further details.


Attributes

  • CacheExpiryTime: Validity time for a Path MTU entry. Default is 10 minutes, minimum is 5 minutes.
    • Set with class: ns3::TimeValue
    • Underlying type: Time +3e+11ns:+9.22337e+18ns
    • Initial value: +6e+11ns
    • Flags: constructwriteread

No TraceSources are defined for this type.
Size of this type is 136 bytes (on a 64-bit architecture).

Definition at line 47 of file ipv6-pmtu-cache.h.

Member Typedef Documentation

◆ pathMtuTimerIter

typedef std::map<Ipv6Address,EventId>::iterator ns3::Ipv6PmtuCache::pathMtuTimerIter
private

Container of the IPv6 PMTU data (Ipv6 destination address and expiration event).

Definition at line 115 of file ipv6-pmtu-cache.h.

Constructor & Destructor Documentation

◆ Ipv6PmtuCache()

ns3::Ipv6PmtuCache::Ipv6PmtuCache ( )

Constructor.

Definition at line 45 of file ipv6-pmtu-cache.cc.

◆ ~Ipv6PmtuCache()

ns3::Ipv6PmtuCache::~Ipv6PmtuCache ( )

Destructor.

Definition at line 49 of file ipv6-pmtu-cache.cc.

Member Function Documentation

◆ ClearPmtu()

void ns3::Ipv6PmtuCache::ClearPmtu ( Ipv6Address  dst)
private

Clears the Path MTU for the specific destination.

Parameters
dstthe destination

Definition at line 108 of file ipv6-pmtu-cache.cc.

References m_pathMtu, m_pathMtuTimer, and NS_LOG_FUNCTION.

Referenced by SetPmtu().

+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::Ipv6PmtuCache::DoDispose ( void  )
virtual

Dispose object.

Reimplemented from ns3::Object.

Definition at line 53 of file ipv6-pmtu-cache.cc.

References m_pathMtu, and m_pathMtuTimer.

◆ GetPmtu()

uint32_t ns3::Ipv6PmtuCache::GetPmtu ( Ipv6Address  dst)

Gets the known Path MTU for the specific destination.

Parameters
dstthe destination
Returns
the Path MTU (zero if unknown)

Definition at line 63 of file ipv6-pmtu-cache.cc.

References m_pathMtu, and NS_LOG_FUNCTION.

◆ GetPmtuValidityTime()

Time ns3::Ipv6PmtuCache::GetPmtuValidityTime ( ) const

Gets the Path MTU validity time.

Returns
the Path MTU validity time

Definition at line 88 of file ipv6-pmtu-cache.cc.

References m_validityTime, and NS_LOG_FUNCTION.

◆ GetTypeId()

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

Get the type ID.

Returns
type ID

Definition at line 31 of file ipv6-pmtu-cache.cc.

References m_validityTime, ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetPmtu()

void ns3::Ipv6PmtuCache::SetPmtu ( Ipv6Address  dst,
uint32_t  pmtu 
)

Sets the Path MTU for the specific destination.

Parameters
dstthe destination
pmtuthe Path MTU

Definition at line 74 of file ipv6-pmtu-cache.cc.

References ClearPmtu(), m_pathMtu, m_pathMtuTimer, m_validityTime, NS_LOG_FUNCTION, and ns3::Simulator::Schedule().

+ Here is the call graph for this function:

◆ SetPmtuValidityTime()

bool ns3::Ipv6PmtuCache::SetPmtuValidityTime ( Time  validity)

Sets the Path MTU validity time (minimum is 5 minutes)

Parameters
validitythe Path MTU validity time
Returns
true if the change was successful

Definition at line 94 of file ipv6-pmtu-cache.cc.

References m_validityTime, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Seconds().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_pathMtu

std::map<Ipv6Address, uint32_t> ns3::Ipv6PmtuCache::m_pathMtu
private

Path MTU table.

Definition at line 110 of file ipv6-pmtu-cache.h.

Referenced by ClearPmtu(), DoDispose(), GetPmtu(), and SetPmtu().

◆ m_pathMtuTimer

std::map<Ipv6Address, EventId> ns3::Ipv6PmtuCache::m_pathMtuTimer
private

Path MTU Expiration table.

Definition at line 120 of file ipv6-pmtu-cache.h.

Referenced by ClearPmtu(), DoDispose(), and SetPmtu().

◆ m_validityTime

Time ns3::Ipv6PmtuCache::m_validityTime
private

Path MTU entry validity time.

Definition at line 125 of file ipv6-pmtu-cache.h.

Referenced by GetPmtuValidityTime(), GetTypeId(), SetPmtu(), and SetPmtuValidityTime().


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