NS-3 based Named Data Networking (NDN) simulator
ndnSIM: NDN, CCN, CCNx, content centric networks
API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
ns3::ndn::GlobalRoutingHelper Class Reference

Helper for GlobalRouter interface. More...

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

Public Member Functions

void Install (Ptr< Node > node)
 Install GlobalRouter interface on a node. More...
 
void Install (const NodeContainer &nodes)
 Install GlobalRouter interface on nodes. More...
 
void InstallAll ()
 Install GlobalRouter interface on all nodes.
 
void AddOrigin (const std::string &prefix, Ptr< Node > node)
 Add `prefix' as origin on `node'. More...
 
void AddOrigins (const std::string &prefix, const NodeContainer &nodes)
 Add `prefix' as origin on all `nodes'. More...
 
void AddOrigin (const std::string &prefix, const std::string &nodeName)
 Add `prefix' as origin on node `nodeName'. More...
 
void AddOriginsForAll ()
 Add origin to each node based on the node's name (using Names class)
 

Static Public Member Functions

static void CalculateRoutes (bool invalidatedRoutes=true)
 Calculate for every node shortest path trees and install routes to all prefix origins. More...
 
static void CalculateAllPossibleRoutes (bool invalidatedRoutes=true)
 Calculate all possible next-hop independent alternative routes. More...
 

Detailed Description

Helper for GlobalRouter interface.

Definition at line 38 of file ndn-global-routing-helper.h.

Member Function Documentation

void ns3::ndn::GlobalRoutingHelper::AddOrigin ( const std::string &  prefix,
Ptr< Node >  node 
)

Add `prefix' as origin on `node'.

Parameters
prefixPrefix that is originated by node, e.g., node is a producer for this prefix
nodePointer to a node

Definition at line 191 of file ndn-global-routing-helper.cc.

void ns3::ndn::GlobalRoutingHelper::AddOrigin ( const std::string &  prefix,
const std::string &  nodeName 
)

Add `prefix' as origin on node `nodeName'.

Parameters
prefixPrefix that is originated by node, e.g., node is a producer for this prefix
nodeNameName of the node that is associated with Ptr<Node> using ns3::Names

Definition at line 213 of file ndn-global-routing-helper.cc.

void ns3::ndn::GlobalRoutingHelper::AddOrigins ( const std::string &  prefix,
const NodeContainer &  nodes 
)

Add `prefix' as origin on all `nodes'.

Parameters
prefixPrefix that is originated by nodes
nodesNodeContainer

Definition at line 202 of file ndn-global-routing-helper.cc.

void ns3::ndn::GlobalRoutingHelper::CalculateAllPossibleRoutes ( bool  invalidatedRoutes = true)
static

Calculate all possible next-hop independent alternative routes.

Parameters
invalidatedRoutesflag indicating whether existing routes should be invalidated or keps as is

Refer to the implementation for more details.

Note that this method is highly experimental and should be used with caution (very time consuming).

Implementation of route calculation is heavily based on Boost Graph Library See http://www.boost.org/doc/libs/1_49_0/libs/graph/doc/table_of_contents.html for more details

Definition at line 330 of file ndn-global-routing-helper.cc.

References ns3::ndn::Fib::InvalidateAll(), and ns3::ndn::Limits::SetLimits().

void ns3::ndn::GlobalRoutingHelper::CalculateRoutes ( bool  invalidatedRoutes = true)
static

Calculate for every node shortest path trees and install routes to all prefix origins.

Parameters
invalidatedRoutesflag indicating whether existing routes should be invalidated or keps as is

Implementation of route calculation is heavily based on Boost Graph Library See http://www.boost.org/doc/libs/1_49_0/libs/graph/doc/table_of_contents.html for more details

Definition at line 237 of file ndn-global-routing-helper.cc.

References ns3::ndn::Fib::InvalidateAll(), and ns3::ndn::Limits::SetLimits().

void ns3::ndn::GlobalRoutingHelper::Install ( Ptr< Node >  node)

Install GlobalRouter interface on a node.

Note that GlobalRouter will also be installed on all connected nodes and channels

Parameters
nodeNode to install GlobalRouter interface

Definition at line 66 of file ndn-global-routing-helper.cc.

References ns3::ndn::GlobalRouter::AddIncidency().

void ns3::ndn::GlobalRoutingHelper::Install ( const NodeContainer &  nodes)

Install GlobalRouter interface on nodes.

Note that GlobalRouter will also be installed on all connected nodes and channels

Parameters
nodesNodeContainer to install GlobalRouter interface

Definition at line 173 of file ndn-global-routing-helper.cc.


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