A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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
uint32_t GetOutputTtl (uint32_t oif) NS_DEPRECATED
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 ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const

Static Public Attributes

static const uint32_t MAX_INTERFACES = 16
static const uint32_t MAX_TTL = 255

Private Attributes

Ipv4Address m_group
Ipv4Address m_origin
uint32_t m_parent
std::map< uint32_t, uint32_t > m_ttls

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SimpleRefCount< Ipv4MulticastRoute >
static void Cleanup (void)

Detailed Description

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

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

Constructor & Destructor Documentation

ns3::Ipv4MulticastRoute::Ipv4MulticastRoute ( )

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

References m_ttls.

Member Function Documentation

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

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

References m_group.

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

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

References m_origin.

uint32_t ns3::Ipv4MulticastRoute::GetOutputTtl ( uint32_t  oif)
Parameters
oifoutgoing interface
Returns
TTL for this route

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

References m_ttls, and MAX_TTL.

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

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

References m_ttls.

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

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

References m_parent.

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

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

References visualizer.higcontainer::group, and m_group.

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

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

References m_origin.

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

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

References m_ttls, and MAX_TTL.

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

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

References m_parent.

Member Data Documentation

Ipv4Address ns3::Ipv4MulticastRoute::m_group
private

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

Referenced by GetGroup(), and SetGroup().

Ipv4Address ns3::Ipv4MulticastRoute::m_origin
private

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

Referenced by GetOrigin(), and SetOrigin().

uint32_t ns3::Ipv4MulticastRoute::m_parent
private

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

Referenced by GetParent(), and SetParent().

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

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

Referenced by GetOutputTtl(), GetOutputTtlMap(), Ipv4MulticastRoute(), and SetOutputTtl().

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

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

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

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

Referenced by GetOutputTtl(), ns3::Ipv4StaticRouting::LookupStatic(), and SetOutputTtl().


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