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

a Face that has no underlying transport and drops every packet More...

#include <null-face.hpp>

Inheritance diagram for nfd::NullFace:
Collaboration diagram for nfd::NullFace:

Public Member Functions

 NullFace (const FaceUri &uri=FaceUri("null://"))
 
void sendInterest (const Interest &interest) 1
 send an Interest More...
 
void sendData (const Data &data) 1
 send a Data More...
 
void close () 1
 Close the face. More...
 
- Public Member Functions inherited from nfd::Face
 Face (const FaceUri &remoteUri, const FaceUri &localUri, bool isLocal=false, bool isMultiAccess=false)
 
virtual ~Face ()
 
FaceId getId () const
 
const std::string & getDescription () const
 Get the description. More...
 
void setDescription (const std::string &description)
 Set the face description. More...
 
void setMetric (uint64_t metric)
 
uint64_t getMetric () const
 
bool isLocal () const
 Get whether face is connected to a local app. More...
 
ndn::nfd::FacePersistency getPersistency () const
 Get the persistency setting. More...
 
bool isMultiAccess () const
 Get whether packets sent by this face may reach multiple peers. More...
 
virtual bool isUp () const
 Get whether underlying communication is up. More...
 
const FaceCountersgetCounters () const
 
const FaceUrigetRemoteUri () const
 
const FaceUrigetLocalUri () const
 
template<typename FaceTraits >
void copyStatusTo (FaceTraits &traits) const
 
virtual ndn::nfd::FaceStatus getFaceStatus () const
 

Additional Inherited Members

- Public Attributes inherited from nfd::Face
signal::Signal< Face, InterestonReceiveInterest
 fires when an Interest is received More...
 
signal::Signal< Face, DataonReceiveData
 fires when a Data is received More...
 
signal::Signal< Face, InterestonSendInterest
 fires when an Interest is sent out More...
 
signal::Signal< Face, DataonSendData
 fires when a Data is sent out More...
 
signal::Signal< Face, std::string > onFail
 fires when face disconnects or fails to perform properly More...
 
- Protected Member Functions inherited from nfd::Face
void setPersistency (ndn::nfd::FacePersistency persistency)
 
bool decodeAndDispatchInput (const Block &element)
 
void fail (const std::string &reason)
 fail the face and raise onFail event if it's UP; otherwise do nothing More...
 
FaceCountersgetMutableCounters ()
 

Detailed Description

a Face that has no underlying transport and drops every packet

Definition at line 36 of file null-face.hpp.

Constructor & Destructor Documentation

◆ NullFace()

nfd::NullFace::NullFace ( const FaceUri uri = FaceUri("null://"))
explicit

Definition at line 33 of file null-face.cpp.

Member Function Documentation

◆ sendInterest()

void nfd::NullFace::sendInterest ( const Interest interest)
virtual

send an Interest

Implements nfd::Face.

Definition at line 39 of file null-face.cpp.

◆ sendData()

void nfd::NullFace::sendData ( const Data data)
virtual

send a Data

Implements nfd::Face.

Definition at line 44 of file null-face.cpp.

◆ close()

void nfd::NullFace::close ( )
virtual

Close the face.

This terminates all communication on the face and cause onFail() method event to be invoked

Implements nfd::Face.

Definition at line 49 of file null-face.cpp.

References nfd::Face::fail().


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