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

Ipv4 multicast route cache entry (similar to Linux struct mfc_cache) More...

#include "ipv4-route.h"

+ Inheritance diagram for ns3::Ipv4MulticastRoute:
+ Collaboration diagram for ns3::Ipv4MulticastRoute:

Public Member Functions

 Ipv4MulticastRoute ()
 
Ipv4Address GetGroup (void) const
 
Ipv4Address GetOrigin (void) const
 
std::map< uint32_t, uint32_t > GetOutputTtlMap () const
 
uint32_t GetParent (void) const
 
void SetGroup (const Ipv4Address group)
 
void SetOrigin (const Ipv4Address origin)
 
void SetOutputTtl (uint32_t oif, uint32_t ttl)
 
void SetParent (uint32_t iif)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Ipv4MulticastRoute >
 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...
 

Static Public Attributes

static const uint32_t MAX_INTERFACES = 16
 Maximum number of multicast interfaces on a router. More...
 
static const uint32_t MAX_TTL = 255
 Maximum time-to-live (TTL) More...
 

Private Attributes

Ipv4Address m_group
 Group. More...
 
Ipv4Address m_origin
 Source of packet. More...
 
uint32_t m_parent
 Source interface. More...
 
std::map< uint32_t, uint32_t > m_ttls
 Time to Live container. More...
 

Detailed Description

Ipv4 multicast route cache entry (similar to Linux struct mfc_cache)

Definition at line 114 of file ipv4-route.h.

Constructor & Destructor Documentation

ns3::Ipv4MulticastRoute::Ipv4MulticastRoute ( )

Definition at line 96 of file ipv4-route.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

Ipv4Address ns3::Ipv4MulticastRoute::GetGroup ( void  ) const
Returns
Ipv4Address of the multicast group

Definition at line 110 of file ipv4-route.cc.

References NS_LOG_FUNCTION.

Ipv4Address ns3::Ipv4MulticastRoute::GetOrigin ( void  ) const
Returns
Ipv4Address of the origin address

Definition at line 124 of file ipv4-route.cc.

References NS_LOG_FUNCTION.

std::map< uint32_t, uint32_t > ns3::Ipv4MulticastRoute::GetOutputTtlMap ( ) const
Returns
map of output interface Ids and TTLs for this route

Definition at line 165 of file ipv4-route.cc.

References NS_LOG_FUNCTION.

uint32_t ns3::Ipv4MulticastRoute::GetParent ( void  ) const
Returns
Parent (input interface) for this route

Definition at line 138 of file ipv4-route.cc.

References NS_LOG_FUNCTION.

void ns3::Ipv4MulticastRoute::SetGroup ( const Ipv4Address  group)
Parameters
groupIpv4Address of the multicast group

Definition at line 103 of file ipv4-route.cc.

References visualizer.higcontainer::group, and NS_LOG_FUNCTION.

void ns3::Ipv4MulticastRoute::SetOrigin ( const Ipv4Address  origin)
Parameters
originIpv4Address of the origin address

Definition at line 117 of file ipv4-route.cc.

References NS_LOG_FUNCTION.

void ns3::Ipv4MulticastRoute::SetOutputTtl ( uint32_t  oif,
uint32_t  ttl 
)
Parameters
oifOutgoing interface index
ttltime-to-live for this route

Definition at line 145 of file ipv4-route.cc.

References NS_LOG_FUNCTION.

void ns3::Ipv4MulticastRoute::SetParent ( uint32_t  iif)
Parameters
iifParent (input interface) for this route

Definition at line 131 of file ipv4-route.cc.

References NS_LOG_FUNCTION.

Member Data Documentation

Ipv4Address ns3::Ipv4MulticastRoute::m_group
private

Group.

Definition at line 161 of file ipv4-route.h.

Ipv4Address ns3::Ipv4MulticastRoute::m_origin
private

Source of packet.

Definition at line 162 of file ipv4-route.h.

uint32_t ns3::Ipv4MulticastRoute::m_parent
private

Source interface.

Definition at line 163 of file ipv4-route.h.

std::map<uint32_t, uint32_t> ns3::Ipv4MulticastRoute::m_ttls
private

Time to Live container.

Definition at line 164 of file ipv4-route.h.

const uint32_t ns3::Ipv4MulticastRoute::MAX_INTERFACES = 16
static

Maximum number of multicast interfaces on a router.

Definition at line 157 of file ipv4-route.h.

const uint32_t ns3::Ipv4MulticastRoute::MAX_TTL = 255
static

Maximum time-to-live (TTL)

Definition at line 158 of file ipv4-route.h.

Referenced by ns3::Ipv4StaticRouting::LookupStatic().


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