ns-3
ns3::Ipv4GlobalRoutingHelper Class Reference

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

#include <ipv4-global-routing-helper.h>

Inheritance diagram for ns3::Ipv4GlobalRoutingHelper:
Collaboration diagram for ns3::Ipv4GlobalRoutingHelper:

List of all members.

Public Member Functions

 Ipv4GlobalRoutingHelper ()
 Construct a GlobalRoutingHelper to make life easier for managing global routing tasks.
 Ipv4GlobalRoutingHelper (const Ipv4GlobalRoutingHelper &)
 Construct a GlobalRoutingHelper from another previously initialized instance (Copy Constructor).
Ipv4GlobalRoutingHelperCopy (void) const
 virtual constructor
virtual Ptr< Ipv4RoutingProtocolCreate (Ptr< Node > node) const
- Public Member Functions inherited from ns3::Ipv4RoutingHelper
void PrintRoutingTableAllAt (Time printTime, Ptr< OutputStreamWrapper > stream) const
 prints the routing tables of all nodes at a particular time.
void PrintRoutingTableAllEvery (Time printInterval, Ptr< OutputStreamWrapper > stream) const
 prints the routing tables of all nodes at regular intervals specified by user.
void PrintRoutingTableAt (Time printTime, Ptr< Node > node, Ptr< OutputStreamWrapper > stream) const
 prints the routing tables of a node at a particular time.
void PrintRoutingTableEvery (Time printInterval, Ptr< Node > node, Ptr< OutputStreamWrapper > stream) const
 prints the routing tables of a node at regular intervals specified by user.

Static Public Member Functions

static void PopulateRoutingTables (void)
 Build a routing database and initialize the routing tables of the nodes in the simulation. Makes all nodes in the simulation into routers.
static void RecomputeRoutingTables (void)
 Remove all routes that were previously installed in a prior call to either PopulateRoutingTables() or RecomputeRoutingTables(), and add a new set of routes.

Detailed Description

Helper class that adds ns3::Ipv4GlobalRouting objects.


Member Function Documentation

Ipv4GlobalRoutingHelper * ns3::Ipv4GlobalRoutingHelper::Copy ( void  ) const
virtual

virtual constructor

Returns:
pointer to clone of this Ipv4RoutingHelper

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::Ipv4RoutingHelper.

References Ipv4GlobalRoutingHelper().

Ptr< Ipv4RoutingProtocol > ns3::Ipv4GlobalRoutingHelper::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::Ipv4RoutingHelper.

References ns3::Object::AggregateObject(), ns3::Node::GetId(), and NS_LOG_LOGIC.

void ns3::Ipv4GlobalRoutingHelper::PopulateRoutingTables ( void  )
static

Build a routing database and initialize the routing tables of the nodes in the simulation. Makes all nodes in the simulation into routers.

All this function does is call the functions BuildGlobalRoutingDatabase () and InitializeRoutes ().

References ns3::GlobalRouteManager::BuildGlobalRoutingDatabase(), and ns3::GlobalRouteManager::InitializeRoutes().

void ns3::Ipv4GlobalRoutingHelper::RecomputeRoutingTables ( void  )
static

Remove all routes that were previously installed in a prior call to either PopulateRoutingTables() or RecomputeRoutingTables(), and add a new set of routes.

This method does not change the set of nodes over which GlobalRouting is being used, but it will dynamically update its representation of the global topology before recomputing routes. Users must first call PopulateRoutingTables() and then may subsequently call RecomputeRoutingTables() at any later time in the simulation.

References ns3::GlobalRouteManager::BuildGlobalRoutingDatabase(), ns3::GlobalRouteManager::DeleteGlobalRoutes(), and ns3::GlobalRouteManager::InitializeRoutes().


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