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

Namespaces

 cs
 Namespace for ContentStore operations.
 
 lp
 
 time
 

Classes

class  App
 Base class that all NDN applications should be derived from. More...
 
class  AppDelayTracer
 Tracer to obtain application-level delays. More...
 
class  AppHelper
 A helper to make it easier to instantiate an ns3::ndn::App applications on a set of nodes. More...
 
class  AppLinkService
 Implementation of LinkService for ndnSIM application. More...
 
class  BlockHeader
 
class  Consumer
 NDN application for sending out Interest packets. More...
 
class  ConsumerBatches
 Ndn application for sending out Interest packets in batches. More...
 
class  ConsumerCbr
 Ndn application for sending out Interest packets at a "constant" rate (Poisson process) More...
 
class  ConsumerPcon
 NDN consumer application with more advanced congestion control options. More...
 
class  ConsumerWindow
 Ndn application for sending out Interest packets (window-based) More...
 
class  ConsumerZipfMandelbrot
 NDN app requesting contents following Zipf-Mandelbrot Distbituion. More...
 
class  ContentStore
 Base class for NDN content store. More...
 
class  CsTracer
 NDN tracer for cache performance (hits and misses) More...
 
class  FaceContainer
 A pool for Ndn faces. More...
 
class  FactoryCallbackApp
 An application that can be created using the supplied callback. More...
 
class  FibHelper
 Forwarding Information Base (FIB) helper. More...
 
class  GlobalRouter
 Class representing global router interface for ndnSIM. More...
 
class  GlobalRoutingHelper
 Helper for GlobalRouter interface. More...
 
class  IgnoreSections
 
class  L3Protocol
 Implementation network-layer of NDN stack. More...
 
class  L3RateTracer
 NDN network-layer rate tracer. More...
 
class  L3Tracer
 Base class for network-layer (incoming/outgoing Interests and Data) tracing of NDN stack. More...
 
class  LinkControlHelper
 Helper class to control the up or down statuss of an NDN link connecting two specific nodes. More...
 
class  NameChecker
 
class  NameValue
 
class  NetDeviceTransport
 ndnSIM-specific transport More...
 
class  NetworkRegionTableHelper
 Network Region Table Helper. More...
 
class  Ns3BufferIteratorSource
 
class  Ns3PacketTag
 
class  NullTransport
 Null transport (does nothing, just fulfills requirements of the interface) More...
 
class  Producer
 A simple Interest-sink applia simple Interest-sink application. More...
 
class  RttEstimator
 Base class for all RTT Estimators. More...
 
class  RttHistory
 Helper class to store RTT measurements. More...
 
class  RttMeanDeviation
 The modified version of "Mean--Deviation" RTT estimator, as discussed by Van Jacobson that better suits NDN communication model. More...
 
class  ScenarioHelper
 Helper class to simplify writing basic simulation scenarios. More...
 
class  StackHelper
 Helper class to install NDN stack and configure its parameters. More...
 
class  StrategyChoiceHelper
 NFD Strategy Choice Helper (FIB) helper. More...
 

Typedefs

typedef std::deque< RttHistoryRttHistory_t
 

Enumerations

enum  CcAlgorithm { AIMD, BIC, CUBIC }
 

Functions

 NS_OBJECT_ENSURE_REGISTERED (ContentStore)
 
std::ostream & operator<< (std::ostream &os, const ContentStore &cs)
 
template<typename T1 >
Ptr< const AttributeAccessor > MakeNameAccessor (T1 a1)
 
template<typename T1 , typename T2 >
Ptr< const AttributeAccessor > MakeNameAccessor (T1 a1, T2 a2)
 
Ptr< const AttributeChecker > MakeNameChecker (void)
 
 NS_OBJECT_ENSURE_REGISTERED (GlobalRouter)
 
bool operator== (const GlobalRouter::Incidency &a, const GlobalRouter::Incidency &b)
 
bool operator!= (const GlobalRouter::Incidency &a, const GlobalRouter::Incidency &b)
 
 NS_OBJECT_ENSURE_REGISTERED (L3Protocol)
 
std::string constructFaceUri (Ptr< NetDevice > netDevice)
 
 NS_OBJECT_ENSURE_REGISTERED (RttEstimator)
 
 NS_OBJECT_ENSURE_REGISTERED (RttMeanDeviation)
 
std::ostream & operator<< (std::ostream &os, const CsTracer &tracer)
 Helper to dump the trace to an output stream. More...
 
std::ostream & operator<< (std::ostream &os, const L3Tracer &tracer)
 Helper to dump the trace to an output stream. More...
 
 NS_OBJECT_ENSURE_REGISTERED (App)
 
 NS_OBJECT_ENSURE_REGISTERED (ConsumerBatches)
 
 NS_OBJECT_ENSURE_REGISTERED (ConsumerCbr)
 
 NS_OBJECT_ENSURE_REGISTERED (ConsumerPcon)
 
 NS_OBJECT_ENSURE_REGISTERED (ConsumerWindow)
 
 NS_OBJECT_ENSURE_REGISTERED (ConsumerZipfMandelbrot)
 
 NS_OBJECT_ENSURE_REGISTERED (Consumer)
 
 NS_OBJECT_ENSURE_REGISTERED (Producer)
 

Variables

 Name
 
ndn FibHelper
 
ndn NetworkRegionTableHelper
 
ndn StrategyChoiceHelper
 
static std::list< std::tuple< shared_ptr< std::ostream >, std::list< Ptr< AppDelayTracer > > > > g_tracers
 
static std::list< std::tuple< shared_ptr< std::ostream >, std::list< Ptr< CsTracer > > > > g_tracers
 
static std::list< std::tuple< shared_ptr< std::ostream >, std::list< Ptr< L3RateTracer > > > > g_tracers
 
const double alpha = 0.8
 

Typedef Documentation

◆ RttHistory_t

typedef std::deque<RttHistory> ns3::ndn::RttHistory_t

Definition at line 54 of file ndn-rtt-estimator.hpp.

Enumeration Type Documentation

◆ CcAlgorithm

Enumerator
AIMD 
BIC 
CUBIC 

Definition at line 30 of file ndn-consumer-pcon.hpp.

Function Documentation

◆ NS_OBJECT_ENSURE_REGISTERED() [1/13]

ns3::ndn::NS_OBJECT_ENSURE_REGISTERED ( ContentStore  )

◆ operator<<() [1/3]

std::ostream& ns3::ndn::operator<< ( std::ostream &  os,
const ContentStore cs 
)
inline

Definition at line 193 of file ndn-content-store.hpp.

References ns3::ndn::ContentStore::Print().

◆ MakeNameAccessor() [1/2]

template<typename T1 >
Ptr<const AttributeAccessor> ns3::ndn::MakeNameAccessor ( T1  a1)

Definition at line 49 of file ndn-common.hpp.

Referenced by ns3::ndn::Producer::GetTypeId(), and ns3::ndn::Consumer::GetTypeId().

◆ MakeNameAccessor() [2/2]

template<typename T1 , typename T2 >
Ptr<const AttributeAccessor> ns3::ndn::MakeNameAccessor ( T1  a1,
T2  a2 
)

Definition at line 49 of file ndn-common.hpp.

◆ MakeNameChecker()

Ptr<const AttributeChecker> ns3::ndn::MakeNameChecker ( void  )

◆ NS_OBJECT_ENSURE_REGISTERED() [2/13]

ns3::ndn::NS_OBJECT_ENSURE_REGISTERED ( GlobalRouter  )

◆ operator==()

bool ns3::ndn::operator== ( const GlobalRouter::Incidency a,
const GlobalRouter::Incidency b 
)
inline

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

◆ operator!=()

bool ns3::ndn::operator!= ( const GlobalRouter::Incidency a,
const GlobalRouter::Incidency b 
)
inline

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

◆ NS_OBJECT_ENSURE_REGISTERED() [3/13]

ns3::ndn::NS_OBJECT_ENSURE_REGISTERED ( L3Protocol  )

◆ constructFaceUri()

std::string ns3::ndn::constructFaceUri ( Ptr< NetDevice >  netDevice)

Definition at line 256 of file ndn-stack-helper.cpp.

◆ NS_OBJECT_ENSURE_REGISTERED() [4/13]

ns3::ndn::NS_OBJECT_ENSURE_REGISTERED ( RttEstimator  )

◆ NS_OBJECT_ENSURE_REGISTERED() [5/13]

ns3::ndn::NS_OBJECT_ENSURE_REGISTERED ( RttMeanDeviation  )

◆ operator<<() [2/3]

std::ostream& ns3::ndn::operator<< ( std::ostream &  os,
const CsTracer tracer 
)
inline

Helper to dump the trace to an output stream.

Definition at line 206 of file ndn-cs-tracer.hpp.

References ns3::ndn::CsTracer::Print(), and ns3::ndn::CsTracer::PrintHeader().

◆ operator<<() [3/3]

std::ostream& ns3::ndn::operator<< ( std::ostream &  os,
const L3Tracer tracer 
)
inline

Helper to dump the trace to an output stream.

Definition at line 141 of file ndn-l3-tracer.hpp.

References ns3::ndn::L3Tracer::Print(), and ns3::ndn::L3Tracer::PrintHeader().

◆ NS_OBJECT_ENSURE_REGISTERED() [6/13]

ns3::ndn::NS_OBJECT_ENSURE_REGISTERED ( App  )

◆ NS_OBJECT_ENSURE_REGISTERED() [7/13]

ns3::ndn::NS_OBJECT_ENSURE_REGISTERED ( ConsumerBatches  )

◆ NS_OBJECT_ENSURE_REGISTERED() [8/13]

ns3::ndn::NS_OBJECT_ENSURE_REGISTERED ( ConsumerCbr  )

◆ NS_OBJECT_ENSURE_REGISTERED() [9/13]

ns3::ndn::NS_OBJECT_ENSURE_REGISTERED ( ConsumerPcon  )

◆ NS_OBJECT_ENSURE_REGISTERED() [10/13]

ns3::ndn::NS_OBJECT_ENSURE_REGISTERED ( ConsumerWindow  )

◆ NS_OBJECT_ENSURE_REGISTERED() [11/13]

ns3::ndn::NS_OBJECT_ENSURE_REGISTERED ( ConsumerZipfMandelbrot  )

◆ NS_OBJECT_ENSURE_REGISTERED() [12/13]

ns3::ndn::NS_OBJECT_ENSURE_REGISTERED ( Consumer  )

◆ NS_OBJECT_ENSURE_REGISTERED() [13/13]

ns3::ndn::NS_OBJECT_ENSURE_REGISTERED ( Producer  )

Variable Documentation

◆ Name

◆ FibHelper

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

◆ NetworkRegionTableHelper

◆ StrategyChoiceHelper

◆ g_tracers [1/3]

◆ g_tracers [2/3]

std::list<std::tuple<shared_ptr<std::ostream>, std::list<Ptr<CsTracer> > > > ns3::ndn::g_tracers
static

Definition at line 42 of file ndn-cs-tracer.cpp.

◆ g_tracers [3/3]

std::list<std::tuple<shared_ptr<std::ostream>, std::list<Ptr<L3RateTracer> > > > ns3::ndn::g_tracers
static

Definition at line 41 of file ndn-l3-rate-tracer.cpp.

◆ alpha

const double ns3::ndn::alpha = 0.8

Definition at line 238 of file ndn-l3-rate-tracer.cpp.