ns3::Ipv4MulticastRoute Class Reference
[Ipv4]

A record of an IPv4 multicast route. More...

#include <ipv4-route.h>

Collaboration diagram for ns3::Ipv4MulticastRoute:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 Ipv4MulticastRoute ()
 This constructor does nothing.
 Ipv4MulticastRoute (Ipv4MulticastRoute const &route)
 Copy Constructor.
 Ipv4MulticastRoute (Ipv4MulticastRoute const *route)
 Copy Constructor.
Ipv4Address GetOrigin (void) const
Ipv4Address GetGroup (void) const
uint32_t GetInputInterface (void) const
uint32_t GetNOutputInterfaces (void) const
uint32_t GetOutputInterface (uint32_t n) const
std::vector< uint32_t > GetOutputInterfaces (void) const

Static Public Member Functions

static Ipv4MulticastRoute CreateMulticastRoute (Ipv4Address origin, Ipv4Address group, uint32_t inputInterface, std::vector< uint32_t > outputInterfaces)

Private Member Functions

 Ipv4MulticastRoute (Ipv4Address origin, Ipv4Address group, uint32_t inputInterface, std::vector< uint32_t > outputInterfaces)

Private Attributes

Ipv4Address m_origin
Ipv4Address m_group
uint32_t m_inputInterface
std::vector< uint32_t > m_outputInterfaces

Detailed Description

A record of an IPv4 multicast route.

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


Constructor & Destructor Documentation

ns3::Ipv4MulticastRoute::Ipv4MulticastRoute (  ) 

This constructor does nothing.

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

Referenced by CreateMulticastRoute().

ns3::Ipv4MulticastRoute::Ipv4MulticastRoute ( Ipv4MulticastRoute const &  route  ) 

Copy Constructor.

Parameters:
route The route to copy

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

ns3::Ipv4MulticastRoute::Ipv4MulticastRoute ( Ipv4MulticastRoute const *  route  ) 

Copy Constructor.

Parameters:
route The route to copy

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

ns3::Ipv4MulticastRoute::Ipv4MulticastRoute ( Ipv4Address  origin,
Ipv4Address  group,
uint32_t  inputInterface,
std::vector< uint32_t >  outputInterfaces 
) [private]

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


Member Function Documentation

Ipv4MulticastRoute ns3::Ipv4MulticastRoute::CreateMulticastRoute ( Ipv4Address  origin,
Ipv4Address  group,
uint32_t  inputInterface,
std::vector< uint32_t >  outputInterfaces 
) [static]
Ipv4Address ns3::Ipv4MulticastRoute::GetGroup ( void   )  const
Returns:
The IPv4 address of the multicast group of this route

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

References m_group.

Referenced by ns3::Ipv4StaticRouting::LookupStatic(), and ns3::Ipv4StaticRouting::RemoveMulticastRoute().

uint32_t ns3::Ipv4MulticastRoute::GetInputInterface ( void   )  const
Returns:
The IPv4 address of the input interface of this route

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

References m_inputInterface.

Referenced by ns3::Ipv4StaticRouting::LookupStatic(), and ns3::Ipv4StaticRouting::RemoveMulticastRoute().

uint32_t ns3::Ipv4MulticastRoute::GetNOutputInterfaces ( void   )  const
Returns:
The number of output interfaces of this route

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

References m_outputInterfaces.

Referenced by ns3::Ipv4StaticRouting::RequestIfIndex(), and ns3::Ipv4StaticRouting::RequestRoute().

Ipv4Address ns3::Ipv4MulticastRoute::GetOrigin ( void   )  const
Returns:
The IPv4 address of the source of this route

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

References m_origin.

Referenced by ns3::Ipv4StaticRouting::LookupStatic(), and ns3::Ipv4StaticRouting::RemoveMulticastRoute().

uint32_t ns3::Ipv4MulticastRoute::GetOutputInterface ( uint32_t  n  )  const
Returns:
A specified output interface.

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

References m_outputInterfaces, and NS_ASSERT_MSG.

Referenced by ns3::Ipv4StaticRouting::RequestIfIndex(), and ns3::Ipv4StaticRouting::RequestRoute().

std::vector< uint32_t > ns3::Ipv4MulticastRoute::GetOutputInterfaces ( void   )  const
Returns:
A vector of all of the output interfaces of this route.

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

References m_outputInterfaces.


Member Data Documentation

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

Referenced by GetGroup().

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

Referenced by GetInputInterface().

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

Referenced by GetOrigin().

std::vector<uint32_t> ns3::Ipv4MulticastRoute::m_outputInterfaces [private]

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

Referenced by GetNOutputInterfaces(), GetOutputInterface(), and GetOutputInterfaces().


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:12:02 2009 for NS-3 by  doxygen 1.6.3