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

Helper class that adds ns3::Ipv6ListRouting objects. More...

#include "ipv6-list-routing-helper.h"

+ Inheritance diagram for ns3::Ipv6ListRoutingHelper:
+ Collaboration diagram for ns3::Ipv6ListRoutingHelper:

Public Member Functions

 Ipv6ListRoutingHelper ()
 Construct an Ipv6 Ipv6ListRoutingHelper which is used to make life easier for people wanting to configure routing using Ipv6. More...
 
 Ipv6ListRoutingHelper (const Ipv6ListRoutingHelper &o)
 Construct an Ipv6ListRoutingHelper from another previously initialized instance (Copy Constructor). More...
 
virtual ~Ipv6ListRoutingHelper ()
 Destroy an Ipv6 Ipv6ListRoutingHelper. More...
 
void Add (const Ipv6RoutingHelper &routing, int16_t priority)
 
Ipv6ListRoutingHelperCopy (void) const
 
virtual Ptr< Ipv6RoutingProtocolCreate (Ptr< Node > node) const
 
- Public Member Functions inherited from ns3::Ipv6RoutingHelper
virtual ~Ipv6RoutingHelper ()
 Destroy an Ipv6 Ipv6RoutingHelper. More...
 

Private Member Functions

Ipv6ListRoutingHelperoperator= (const Ipv6ListRoutingHelper &o)
 Assignment operator declared private and not implemented to disallow assignment and prevent the compiler from happily inserting its own. More...
 

Private Attributes

std::list< std::pair< const Ipv6RoutingHelper *, int16_t > > m_list
 Container for pairs of Ipv6RoutingHelper pointer / priority. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::Ipv6RoutingHelper
template<class T >
static Ptr< T > GetRouting (Ptr< Ipv6RoutingProtocol > protocol)
 Request a specified routing protocol <T> from Ipv6RoutingProtocol protocol. More...
 
static void PrintNeighborCacheAllAt (Time printTime, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
 prints the neighbor cache of all nodes at a particular time. More...
 
static void PrintNeighborCacheAllEvery (Time printInterval, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
 prints the neighbor cache of all nodes at regular intervals specified by user. More...
 
static void PrintNeighborCacheAt (Time printTime, Ptr< Node > node, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
 prints the neighbor cache of a node at a particular time. More...
 
static void PrintNeighborCacheEvery (Time printInterval, Ptr< Node > node, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
 prints the neighbor cache of a node at regular intervals specified by user. More...
 
static void PrintRoutingTableAllAt (Time printTime, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
 prints the routing tables of all nodes at a particular time. More...
 
static void PrintRoutingTableAllEvery (Time printInterval, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
 prints the routing tables of all nodes at regular intervals specified by user. More...
 
static void PrintRoutingTableAt (Time printTime, Ptr< Node > node, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
 prints the routing tables of a node at a particular time. More...
 
static void PrintRoutingTableEvery (Time printInterval, Ptr< Node > node, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
 prints the routing tables of a node at regular intervals specified by user. More...
 

Detailed Description

Helper class that adds ns3::Ipv6ListRouting objects.

This class is expected to be used in conjunction with ns3::InternetStackHelper::SetRoutingHelper

Definition at line 39 of file ipv6-list-routing-helper.h.

Constructor & Destructor Documentation

◆ Ipv6ListRoutingHelper() [1/2]

ns3::Ipv6ListRoutingHelper::Ipv6ListRoutingHelper ( )

Construct an Ipv6 Ipv6ListRoutingHelper which is used to make life easier for people wanting to configure routing using Ipv6.

Definition at line 28 of file ipv6-list-routing-helper.cc.

Referenced by Copy().

+ Here is the caller graph for this function:

◆ ~Ipv6ListRoutingHelper()

ns3::Ipv6ListRoutingHelper::~Ipv6ListRoutingHelper ( )
virtual

Destroy an Ipv6 Ipv6ListRoutingHelper.

Definition at line 32 of file ipv6-list-routing-helper.cc.

References list, and m_list.

◆ Ipv6ListRoutingHelper() [2/2]

ns3::Ipv6ListRoutingHelper::Ipv6ListRoutingHelper ( const Ipv6ListRoutingHelper o)

Construct an Ipv6ListRoutingHelper from another previously initialized instance (Copy Constructor).

Parameters
oobject to be copied

Definition at line 40 of file ipv6-list-routing-helper.cc.

References m_list.

Member Function Documentation

◆ Add()

void ns3::Ipv6ListRoutingHelper::Add ( const Ipv6RoutingHelper routing,
int16_t  priority 
)
Parameters
routinga routing helper
prioritythe priority of the associated helper

Store in the internal list a reference to the input routing helper and associated priority. These helpers will be used later by the ns3::Ipv6ListRoutingHelper::Create method to create an ns3::Ipv6ListRouting object and add in it routing protocols created with the helpers.

Definition at line 56 of file ipv6-list-routing-helper.cc.

References ns3::Ipv6RoutingHelper::Copy(), and m_list.

+ Here is the call graph for this function:

◆ Copy()

Ipv6ListRoutingHelper * ns3::Ipv6ListRoutingHelper::Copy ( void  ) const
virtual
Returns
pointer to clone of this Ipv6ListRoutingHelper

This method is mainly for internal use by the other helpers; clients are expected to free the dynamic memory allocated by this method

Implements ns3::Ipv6RoutingHelper.

Definition at line 50 of file ipv6-list-routing-helper.cc.

References Ipv6ListRoutingHelper().

+ Here is the call graph for this function:

◆ Create()

Ptr< Ipv6RoutingProtocol > ns3::Ipv6ListRoutingHelper::Create ( Ptr< Node node) const
virtual
Parameters
nodethe node on which the routing protocol will run
Returns
a newly-created routing protocol

This method will be called by ns3::InternetStackHelper::Install

Implements ns3::Ipv6RoutingHelper.

Definition at line 61 of file ipv6-list-routing-helper.cc.

References list, and m_list.

◆ operator=()

Ipv6ListRoutingHelper& ns3::Ipv6ListRoutingHelper::operator= ( const Ipv6ListRoutingHelper o)
private

Assignment operator declared private and not implemented to disallow assignment and prevent the compiler from happily inserting its own.

Parameters
oobject to copy from
Returns
a reference to the new object

Member Data Documentation

◆ m_list

std::list<std::pair<const Ipv6RoutingHelper *,int16_t> > ns3::Ipv6ListRoutingHelper::m_list
private

Container for pairs of Ipv6RoutingHelper pointer / priority.

Definition at line 98 of file ipv6-list-routing-helper.h.

Referenced by Add(), Create(), Ipv6ListRoutingHelper(), and ~Ipv6ListRoutingHelper().


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