NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
ns3::ndn::FibHelper Class Reference

Forwarding Information Base (FIB) helper. More...

#include <ndn-fib-helper.hpp>

Static Public Member Functions

static void AddRoute (Ptr< Node > node, const Name &prefix, shared_ptr< Face > face, int32_t metric)
 Add forwarding entry to FIB. More...
 
static void AddRoute (const std::string &nodeName, const Name &prefix, uint32_t faceId, int32_t metric)
 Add forwarding entry to FIB. More...
 
static void AddRoute (Ptr< Node > node, const Name &prefix, uint32_t faceId, int32_t metric)
 Add forwarding entry to FIB. More...
 
static void AddRoute (Ptr< Node > node, const Name &prefix, Ptr< Node > otherNode, int32_t metric)
 Add forwarding entry to FIB (work only with point-to-point links) More...
 
static void AddRoute (const std::string &nodeName, const Name &prefix, const std::string &otherNodeName, int32_t metric)
 Add forwarding entry to FIB (work only with point-to-point links) More...
 
static void RemoveRoute (Ptr< Node > node, const Name &prefix, shared_ptr< Face > face)
 remove forwarding entry in FIB More...
 
static void RemoveRoute (Ptr< Node > node, const Name &prefix, uint32_t faceId)
 remove forwarding entry in FIB More...
 
static void RemoveRoute (const std::string &nodeName, const Name &prefix, uint32_t faceId)
 remove forwarding entry in FIB More...
 
static void RemoveRoute (Ptr< Node > node, const Name &prefix, Ptr< Node > otherNode)
 remove forwarding entry in FIB (work only with point-to-point links) More...
 
static void RemoveRoute (const std::string &nodeName, const Name &prefix, const std::string &otherNodeName)
 remove forwarding entry in FIB (work only with point-to-point links) More...
 

Detailed Description

Forwarding Information Base (FIB) helper.

The FIB helper interacts with the FIB manager of NFD by sending special Interest commands to the manager in order to add/remove a next hop from FIB entries or add routes to the FIB manually (manual configuration of FIB).

Definition at line 44 of file ndn-fib-helper.hpp.

Member Function Documentation

◆ AddRoute() [1/5]

void ns3::ndn::FibHelper::AddRoute ( Ptr< Node >  node,
const Name prefix,
shared_ptr< Face face,
int32_t  metric 
)
static

Add forwarding entry to FIB.

Parameters
nodeNode
prefixRouting prefix
faceFace
metricRouting metric

Definition at line 85 of file ndn-fib-helper.cpp.

References ndn::tlv::nfd::ControlParameters.

Referenced by AddRoute(), ns3::ndn::ScenarioHelper::addRoutes(), ns3::ndn::GlobalRoutingHelper::CalculateAllPossibleRoutes(), ns3::ndn::GlobalRoutingHelper::CalculateRoutes(), and ns3::ndn::Producer::StartApplication().

◆ AddRoute() [2/5]

void ns3::ndn::FibHelper::AddRoute ( const std::string &  nodeName,
const Name prefix,
uint32_t  faceId,
int32_t  metric 
)
static

Add forwarding entry to FIB.

Parameters
nodeNameNode name
prefixRouting prefix
faceIdFace index
metricRouting metric

Definition at line 112 of file ndn-fib-helper.cpp.

References AddRoute().

◆ AddRoute() [3/5]

void ns3::ndn::FibHelper::AddRoute ( Ptr< Node >  node,
const Name prefix,
uint32_t  faceId,
int32_t  metric 
)
static

Add forwarding entry to FIB.

Parameters
nodeNameNode
prefixRouting prefix
faceIdFace index
metricRouting metric

Definition at line 99 of file ndn-fib-helper.cpp.

References AddRoute().

◆ AddRoute() [4/5]

void ns3::ndn::FibHelper::AddRoute ( Ptr< Node >  node,
const Name prefix,
Ptr< Node >  otherNode,
int32_t  metric 
)
static

Add forwarding entry to FIB (work only with point-to-point links)

Parameters
nodeNode
prefixRouting prefix
otherNodeThe other node, to which interests (will be used to infer face id
metricRouting metric

Definition at line 129 of file ndn-fib-helper.cpp.

References AddRoute().

◆ AddRoute() [5/5]

void ns3::ndn::FibHelper::AddRoute ( const std::string &  nodeName,
const Name prefix,
const std::string &  otherNodeName,
int32_t  metric 
)
static

Add forwarding entry to FIB (work only with point-to-point links)

Parameters
nodeNameNode name (refer to ns3::Names)
prefixRouting prefix
otherNodeThe other node name, to which interests (will be used to infer face id (refer to ns3::Names)
metricRouting metric

Definition at line 160 of file ndn-fib-helper.cpp.

References AddRoute().

◆ RemoveRoute() [1/5]

void ns3::ndn::FibHelper::RemoveRoute ( Ptr< Node >  node,
const Name prefix,
shared_ptr< Face face 
)
static

remove forwarding entry in FIB

Parameters
nodeNode
prefixRouting prefix
faceFace

Definition at line 173 of file ndn-fib-helper.cpp.

References ndn::tlv::nfd::ControlParameters, and ns3::ndn::L3Protocol::getForwarder().

Referenced by RemoveRoute().

◆ RemoveRoute() [2/5]

void ns3::ndn::FibHelper::RemoveRoute ( Ptr< Node >  node,
const Name prefix,
uint32_t  faceId 
)
static

remove forwarding entry in FIB

Parameters
nodeNode
prefixRouting prefix
faceIdFace index

Definition at line 190 of file ndn-fib-helper.cpp.

References RemoveRoute().

◆ RemoveRoute() [3/5]

void ns3::ndn::FibHelper::RemoveRoute ( const std::string &  nodeName,
const Name prefix,
uint32_t  faceId 
)
static

remove forwarding entry in FIB

Parameters
nodeNameNode name
prefixRouting prefix
faceIdFace index

Definition at line 203 of file ndn-fib-helper.cpp.

References RemoveRoute().

◆ RemoveRoute() [4/5]

void ns3::ndn::FibHelper::RemoveRoute ( Ptr< Node >  node,
const Name prefix,
Ptr< Node >  otherNode 
)
static

remove forwarding entry in FIB (work only with point-to-point links)

Parameters
nodeNode
prefixRouting prefix
otherNodeThe other node, to which interests (will be used to infer face id

Definition at line 217 of file ndn-fib-helper.cpp.

References RemoveRoute().

◆ RemoveRoute() [5/5]

void ns3::ndn::FibHelper::RemoveRoute ( const std::string &  nodeName,
const Name prefix,
const std::string &  otherNodeName 
)
static

remove forwarding entry in FIB (work only with point-to-point links)

Parameters
nodeNameNode name
prefixRouting prefix
otherNodeThe other node name, to which interests (will be used to infer face id

Definition at line 248 of file ndn-fib-helper.cpp.

References RemoveRoute().


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