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

#include <internal-face.hpp>

Inheritance diagram for nfd::InternalFace:
Collaboration diagram for nfd::InternalFace:

Classes

class  Error
 InternalFace-related error. More...
 

Public Member Functions

 InternalFace ()
 
CommandValidatorgetValidator ()
 
virtual ~InternalFace ()
 
virtual void sendInterest (const Interest &interest)
 send an Interest More...
 
virtual void sendData (const Data &data)
 send a Data More...
 
virtual void close ()
 Close the face. More...
 
virtual void setInterestFilter (const Name &filter, OnInterest onInterest)
 
virtual void put (const Data &data)
 
- 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
 
- Public Member Functions inherited from nfd::AppFace
virtual ~AppFace ()
 

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

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

Constructor & Destructor Documentation

◆ InternalFace()

nfd::InternalFace::InternalFace ( )

Definition at line 34 of file internal-face.cpp.

◆ ~InternalFace()

nfd::InternalFace::~InternalFace ( )
virtual

Definition at line 148 of file internal-face.cpp.

Member Function Documentation

◆ getValidator()

CommandValidator & nfd::InternalFace::getValidator ( )
inline

Definition at line 90 of file internal-face.hpp.

◆ sendInterest()

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

send an Interest

Implements nfd::Face.

Definition at line 40 of file internal-face.cpp.

References emitSignal, nfd::Face::onSendInterest, and nfd::scheduler::schedule().

◆ sendData()

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

send a Data

Implements nfd::Face.

Definition at line 123 of file internal-face.cpp.

References emitSignal, and nfd::Face::onSendData.

◆ close()

void nfd::InternalFace::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 129 of file internal-face.cpp.

◆ setInterestFilter()

void nfd::InternalFace::setInterestFilter ( const Name filter,
OnInterest  onInterest 
)
virtual

Implements nfd::AppFace.

Definition at line 135 of file internal-face.cpp.

References NFD_LOG_INFO.

◆ put()

void nfd::InternalFace::put ( const Data data)
virtual

Implements nfd::AppFace.

Definition at line 143 of file internal-face.cpp.

References emitSignal, and nfd::Face::onReceiveData.


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