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

Class representing global router interface for ndnSIM. More...

#include <ndn-global-router.hpp>

Inheritance diagram for ns3::ndn::GlobalRouter:
Collaboration diagram for ns3::ndn::GlobalRouter:

Public Types

typedef std::tuple< Ptr< GlobalRouter >, shared_ptr< Face >, Ptr< GlobalRouter > > Incidency
 Graph edge. More...
 
typedef std::list< IncidencyIncidencyList
 List of graph edges. More...
 
typedef std::list< shared_ptr< Name > > LocalPrefixList
 List of locally exported prefixes. More...
 

Public Member Functions

 GlobalRouter ()
 Default constructor. More...
 
uint32_t GetId () const
 Get numeric ID of the node (internally assigned) More...
 
Ptr< L3ProtocolGetL3Protocol () const
 Helper function to get smart pointer to ndn::L3Protocol object (basically, self) More...
 
void AddLocalPrefix (shared_ptr< Name > prefix)
 Add new locally exported prefix. More...
 
void AddIncidency (shared_ptr< Face > face, Ptr< GlobalRouter > ndn)
 Add edge to the node. More...
 
IncidencyListGetIncidencies ()
 Get list of edges that are connected to this node. More...
 
const LocalPrefixListGetLocalPrefixes () const
 Get list of locally exported prefixes. More...
 

Static Public Member Functions

static TypeId GetTypeId ()
 Interface ID. More...
 
static void clear ()
 Clear global state. More...
 

Protected Member Functions

virtual void NotifyNewAggregate ()
 Notify when the object is aggregated to another object (e.g., Node) More...
 

Detailed Description

Class representing global router interface for ndnSIM.

Introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 88 bytes (on a 64-bit architecture).

Definition at line 43 of file ndn-global-router.hpp.

Member Typedef Documentation

◆ Incidency

typedef std::tuple<Ptr<GlobalRouter>, shared_ptr<Face>, Ptr<GlobalRouter> > ns3::ndn::GlobalRouter::Incidency

Graph edge.

Definition at line 48 of file ndn-global-router.hpp.

◆ IncidencyList

List of graph edges.

Definition at line 52 of file ndn-global-router.hpp.

◆ LocalPrefixList

typedef std::list<shared_ptr<Name> > ns3::ndn::GlobalRouter::LocalPrefixList

List of locally exported prefixes.

Definition at line 56 of file ndn-global-router.hpp.

Constructor & Destructor Documentation

◆ GlobalRouter()

ns3::ndn::GlobalRouter::GlobalRouter ( )

Default constructor.

Definition at line 40 of file ndn-global-router.cpp.

Member Function Documentation

◆ GetTypeId()

TypeId ns3::ndn::GlobalRouter::GetTypeId ( void  )
static

Interface ID.

Returns
interface ID

Definition at line 34 of file ndn-global-router.cpp.

◆ GetId()

uint32_t ns3::ndn::GlobalRouter::GetId ( ) const

Get numeric ID of the node (internally assigned)

Definition at line 56 of file ndn-global-router.cpp.

◆ GetL3Protocol()

Ptr< L3Protocol > ns3::ndn::GlobalRouter::GetL3Protocol ( ) const

Helper function to get smart pointer to ndn::L3Protocol object (basically, self)

Definition at line 62 of file ndn-global-router.cpp.

◆ AddLocalPrefix()

void ns3::ndn::GlobalRouter::AddLocalPrefix ( shared_ptr< Name prefix)

Add new locally exported prefix.

Parameters
prefixPrefix

Definition at line 68 of file ndn-global-router.cpp.

◆ AddIncidency()

void ns3::ndn::GlobalRouter::AddIncidency ( shared_ptr< Face >  face,
Ptr< GlobalRouter ndn 
)

Add edge to the node.

Parameters
faceFace of the edge
ndnGlobalRouter of another node

Definition at line 74 of file ndn-global-router.cpp.

Referenced by ns3::ndn::GlobalRoutingHelper::Install().

◆ GetIncidencies()

GlobalRouter::IncidencyList & ns3::ndn::GlobalRouter::GetIncidencies ( )

Get list of edges that are connected to this node.

Definition at line 80 of file ndn-global-router.cpp.

◆ GetLocalPrefixes()

const GlobalRouter::LocalPrefixList & ns3::ndn::GlobalRouter::GetLocalPrefixes ( ) const

Get list of locally exported prefixes.

Definition at line 86 of file ndn-global-router.cpp.

◆ clear()

void ns3::ndn::GlobalRouter::clear ( )
static

Clear global state.

Definition at line 92 of file ndn-global-router.cpp.

◆ NotifyNewAggregate()

void ns3::ndn::GlobalRouter::NotifyNewAggregate ( )
protectedvirtual

Notify when the object is aggregated to another object (e.g., Node)

Definition at line 47 of file ndn-global-router.cpp.


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