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

Tracer to obtain application-level delays. More...

#include <ndn-app-delay-tracer.hpp>

Inheritance diagram for ns3::ndn::AppDelayTracer:
Collaboration diagram for ns3::ndn::AppDelayTracer:

Public Member Functions

 AppDelayTracer (shared_ptr< std::ostream > os, Ptr< Node > node)
 Trace constructor that attaches to all applications on the node using node's pointer. More...
 
 AppDelayTracer (shared_ptr< std::ostream > os, const std::string &node)
 Trace constructor that attaches to all applications on the node using node's name. More...
 
 ~AppDelayTracer ()
 Destructor. More...
 
void PrintHeader (std::ostream &os) const
 Print head of the trace (e.g., for post-processing) More...
 

Static Public Member Functions

static void InstallAll (const std::string &file)
 Helper method to install tracers on all simulation nodes. More...
 
static void Install (const NodeContainer &nodes, const std::string &file)
 Helper method to install tracers on the selected simulation nodes. More...
 
static void Install (Ptr< Node > node, const std::string &file)
 Helper method to install tracers on a specific simulation node. More...
 
static Ptr< AppDelayTracerInstall (Ptr< Node > node, shared_ptr< std::ostream > outputStream)
 Helper method to install tracers on a specific simulation node. More...
 
static void Destroy ()
 Explicit request to remove all statically created tracers. More...
 

Detailed Description

Tracer to obtain application-level delays.

Definition at line 47 of file ndn-app-delay-tracer.hpp.

Constructor & Destructor Documentation

◆ AppDelayTracer() [1/2]

ns3::ndn::AppDelayTracer::AppDelayTracer ( shared_ptr< std::ostream >  os,
Ptr< Node >  node 
)

Trace constructor that attaches to all applications on the node using node's pointer.

Parameters
osreference to the output stream
nodepointer to the node

Definition at line 174 of file ndn-app-delay-tracer.cpp.

◆ AppDelayTracer() [2/2]

ns3::ndn::AppDelayTracer::AppDelayTracer ( shared_ptr< std::ostream >  os,
const std::string &  node 
)

Trace constructor that attaches to all applications on the node using node's name.

Parameters
osreference to the output stream
nodeNamename of the node registered using Names::Add

Definition at line 188 of file ndn-app-delay-tracer.cpp.

◆ ~AppDelayTracer()

ns3::ndn::AppDelayTracer::~AppDelayTracer ( )

Destructor.

Definition at line 195 of file ndn-app-delay-tracer.cpp.

Member Function Documentation

◆ InstallAll()

void ns3::ndn::AppDelayTracer::InstallAll ( const std::string &  file)
static

Helper method to install tracers on all simulation nodes.

Parameters
fileFile to which traces will be written. If filename is -, then std::out is used

Definition at line 52 of file ndn-app-delay-tracer.cpp.

References ns3::ndn::g_tracers, and Install().

◆ Install() [1/3]

void ns3::ndn::AppDelayTracer::Install ( const NodeContainer &  nodes,
const std::string &  file 
)
static

Helper method to install tracers on the selected simulation nodes.

Parameters
nodesNodes on which to install tracer
fileFile to which traces will be written. If filename is -, then std::out is used

Definition at line 89 of file ndn-app-delay-tracer.cpp.

References ns3::ndn::g_tracers.

Referenced by Install(), and InstallAll().

◆ Install() [2/3]

void ns3::ndn::AppDelayTracer::Install ( Ptr< Node >  node,
const std::string &  file 
)
static

Helper method to install tracers on a specific simulation node.

Parameters
nodesNodes on which to install tracer
fileFile to which traces will be written. If filename is -, then std::out is used
averagingPeriodHow often data will be written into the trace file (default, every half second)

Definition at line 126 of file ndn-app-delay-tracer.cpp.

References ns3::ndn::g_tracers, and Install().

◆ Install() [3/3]

Ptr< AppDelayTracer > ns3::ndn::AppDelayTracer::Install ( Ptr< Node >  node,
shared_ptr< std::ostream >  outputStream 
)
static

Helper method to install tracers on a specific simulation node.

Parameters
nodesNodes on which to install tracer
outputStreamSmart pointer to a stream
averagingPeriodHow often data will be written into the trace file (default, every half second)
Returns
a tuple of reference to output stream and list of tracers. !!! Attention !!! This tuple needs to be preserved for the lifetime of simulation, otherwise SEGFAULTs are inevitable

Definition at line 161 of file ndn-app-delay-tracer.cpp.

◆ Destroy()

void ns3::ndn::AppDelayTracer::Destroy ( )
static

Explicit request to remove all statically created tracers.

This method can be helpful if simulation scenario contains several independent run, or if it is desired to do a postprocessing of the resulting data

Definition at line 46 of file ndn-app-delay-tracer.cpp.

References ns3::ndn::g_tracers.

◆ PrintHeader()

void ns3::ndn::AppDelayTracer::PrintHeader ( std::ostream &  os) const

Print head of the trace (e.g., for post-processing)

Parameters
osreference to output stream

Definition at line 210 of file ndn-app-delay-tracer.cpp.


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