generalization of a network interface More...

#include <face.hpp>

Inheritance diagram for nfd::face::Face:

Collaboration diagram for nfd::face::Face:

[legend]

Public Member Functions
	Face (unique_ptr< LinkService > service, unique_ptr< Transport > transport)

LinkService *	getLinkService () const

Transport *	getTransport () const

void	sendInterest (const Interest &interest)
	sends Interest on Face More...

void	sendData (const Data &data)
	sends Data on Face More...

void	sendNack (const lp::Nack &nack)
	sends Nack on Face More...

FaceId	getId () const

void	setId (FaceId id)
	sets face ID More...

void	setMetric (uint64_t metric)

uint64_t	getMetric () const

FaceUri	getLocalUri () const

FaceUri	getRemoteUri () const

ndn::nfd::FaceScope	getScope () const

ndn::nfd::FacePersistency	getPersistency () const

void	setPersistency (ndn::nfd::FacePersistency persistency)
	changes face persistency setting More...

ndn::nfd::LinkType	getLinkType () const

FaceState	getState () const

time::steady_clock::TimePoint	getExpirationTime () const

void	close ()
	request the face to be closed More...

const FaceCounters &	getCounters () const

Public Attributes
signal::Signal< LinkService, Interest > &	afterReceiveInterest
	signals on Interest received More...

signal::Signal< LinkService, Data > &	afterReceiveData
	signals on Data received More...

signal::Signal< LinkService, lp::Nack > &	afterReceiveNack
	signals on Nack received More...

signal::Signal< Transport, FaceState, FaceState > &	afterStateChange
	signals after face state changed More...

Detailed Description

generalization of a network interface

A face generalizes a network interface. It provides best-effort network-layer packet delivery services on a physical interface, an overlay tunnel, or a link to a local application.

A face combines two parts: LinkService and Transport. Transport is the lower part, which provides best-effort TLV block deliveries. LinkService is the upper part, which translates between network-layer packets and TLV blocks, and may provide additional services such as fragmentation and reassembly.

Definition at line 67 of file face.hpp.

Constructor & Destructor Documentation

◆ Face()

nfd::face::Face::Face	(	unique_ptr< LinkService >	service,
		unique_ptr< Transport >	transport
	)

Definition at line 31 of file face.cpp.

Member Function Documentation

◆ getLinkService()

LinkService * nfd::face::Face::getLinkService ( ) const

inline

Definition at line 199 of file face.hpp.

Referenced by nfd::FaceManager::setConfigFile().

◆ getTransport()

shared_ptr< Transport > ndn::Face::getTransport ( ) const

inline

Definition at line 205 of file face.hpp.

◆ sendInterest()

void nfd::face::Face::sendInterest ( const Interest & interest )

inline

sends Interest on Face

Definition at line 211 of file face.hpp.

Referenced by nfd::Forwarder::startProcessNack().

◆ sendData()

void nfd::face::Face::sendData ( const Data & data )

inline

sends Data on Face

Definition at line 217 of file face.hpp.

Referenced by nfd::Forwarder::startProcessNack().

◆ sendNack()

void nfd::face::Face::sendNack ( const lp::Nack & nack )

inline

sends Nack on Face

Definition at line 223 of file face.hpp.

Referenced by nfd::Forwarder::startProcessNack().

◆ getId()

FaceId nfd::face::Face::getId ( ) const

inline

Returns: face ID

Definition at line 229 of file face.hpp.

Referenced by nfd::fw::NccStrategy::afterReceiveInterest(), nfd::fw::asf::AsfStrategy::afterReceiveInterest(), nfd::fw::AccessStrategy::afterReceiveInterest(), nfd::fw::BestRouteStrategy2::afterReceiveInterest(), nfd::fw::asf::AsfStrategy::afterReceiveNack(), nfd::fw::BestRouteStrategy2::afterReceiveNack(), nfd::fw::Strategy::afterReceiveNack(), nfd::fw::asf::AsfStrategy::beforeSatisfyInterest(), nfd::fw::AccessStrategy::beforeSatisfyInterest(), nfd::fw::Strategy::beforeSatisfyInterest(), nfd::fw::asf::NamespaceInfo::extendFaceInfoLifetime(), nfd::fw::asf::NamespaceInfo::getFaceInfo(), nfd::fw::asf::ProbingModule::getFaceToProbe(), nfd::fw::asf::NamespaceInfo::getOrCreateFaceInfo(), nfd::fw::asf::getValueForSorting(), nfd::face::operator<<(), nfd::fw::asf::FaceInfo::recordRtt(), nfd::FaceManager::setConfigFile(), nfd::Forwarder::startProcessInterest(), and nfd::Forwarder::startProcessNack().

◆ setId()

void nfd::face::Face::setId ( FaceId id )

inline

sets face ID

Note: Normally, this should only be invoked by FaceTable.

Definition at line 235 of file face.hpp.

◆ setMetric()

void nfd::face::Face::setMetric ( uint64_t metric )

inline

Definition at line 241 of file face.hpp.

◆ getMetric()

uint64_t nfd::face::Face::getMetric ( ) const

inline

Definition at line 247 of file face.hpp.

◆ getLocalUri()

FaceUri nfd::face::Face::getLocalUri ( ) const

inline

Returns: a FaceUri representing local endpoint

Definition at line 253 of file face.hpp.

Referenced by nfd::face::operator<<(), and nfd::FaceManager::setConfigFile().

◆ getRemoteUri()

FaceUri nfd::face::Face::getRemoteUri ( ) const

inline

Returns: a FaceUri representing remote endpoint

Definition at line 259 of file face.hpp.

Referenced by nfd::face::operator<<(), and nfd::FaceManager::setConfigFile().

◆ getScope()

ndn::nfd::FaceScope nfd::face::Face::getScope ( ) const

inline

Returns: whether face is local or non-local for scope control purpose

Definition at line 265 of file face.hpp.

Referenced by nfd::fw::AdmitLocalUnsolicitedDataPolicy::decide(), nfd::fw::AdmitNetworkUnsolicitedDataPolicy::decide(), nfd::FaceManager::setConfigFile(), nfd::Forwarder::startProcessNack(), nfd::fw::violatesScope(), and nfd::fw::wouldViolateScope().

◆ getPersistency()

ndn::nfd::FacePersistency nfd::face::Face::getPersistency ( ) const

inline

Returns: face persistency setting

Definition at line 271 of file face.hpp.

Referenced by nfd::FaceManager::setConfigFile().

◆ setPersistency()

void nfd::face::Face::setPersistency ( ndn::nfd::FacePersistency persistency )

inline

changes face persistency setting

Definition at line 277 of file face.hpp.

◆ getLinkType()

ndn::nfd::LinkType nfd::face::Face::getLinkType ( ) const

inline

Returns: whether face is point-to-point or multi-access

Definition at line 283 of file face.hpp.

Referenced by nfd::FaceManager::setConfigFile(), and nfd::Forwarder::startProcessNack().

◆ getState()

FaceState nfd::face::Face::getState ( ) const

inline

Returns: face state

Definition at line 289 of file face.hpp.

◆ getExpirationTime()

time::steady_clock::TimePoint nfd::face::Face::getExpirationTime ( ) const

inline

Returns: expiration time of the face

Return values

time::steady_clock::TimePoint::max() the face has an indefinite lifetime

Definition at line 295 of file face.hpp.

Referenced by nfd::FaceManager::setConfigFile().

◆ close()

void nfd::face::Face::close ( )

inline

request the face to be closed

This operation is effective only if face is in UP or DOWN state, otherwise it has no effect. The face changes state to CLOSING, and performs cleanup procedure. The state will be changed to CLOSED when cleanup is complete, which may happen synchronously or asynchronously.

Warning: the face must not be deallocated until its state changes to CLOSED

Definition at line 301 of file face.hpp.

Referenced by nfd::FaceManager::setConfigFile().

◆ getCounters()

const FaceCounters & nfd::face::Face::getCounters ( ) const

inline

Definition at line 307 of file face.hpp.

Referenced by nfd::FaceManager::setConfigFile().

Member Data Documentation

◆ afterReceiveInterest

signal::Signal<LinkService, Interest>& nfd::face::Face::afterReceiveInterest

signals on Interest received

Definition at line 100 of file face.hpp.

Referenced by nfd::Forwarder::Forwarder().

◆ afterReceiveData

signal::Signal<LinkService, Data>& nfd::face::Face::afterReceiveData

signals on Data received

Definition at line 104 of file face.hpp.

Referenced by nfd::Forwarder::Forwarder().

◆ afterReceiveNack

signal::Signal<LinkService, lp::Nack>& nfd::face::Face::afterReceiveNack

signals on Nack received

Definition at line 108 of file face.hpp.

Referenced by nfd::Forwarder::Forwarder().

◆ afterStateChange

signal::Signal<Transport, FaceState, FaceState>& nfd::face::Face::afterStateChange

signals after face state changed

Definition at line 166 of file face.hpp.

Referenced by nfd::connectFaceClosedSignal(), and nfd::FaceManager::setConfigFile().

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

ndnSIM/NFD/daemon/face/face.hpp
ndnSIM/NFD/daemon/face/face.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Face()

Member Function Documentation

◆ getLinkService()

◆ getTransport()

◆ sendInterest()

◆ sendData()

◆ sendNack()

◆ getId()

◆ setId()

◆ setMetric()

◆ getMetric()

◆ getLocalUri()

◆ getRemoteUri()

◆ getScope()

◆ getPersistency()

◆ setPersistency()

◆ getLinkType()

◆ getState()

◆ getExpirationTime()

◆ close()

◆ getCounters()

Member Data Documentation

◆ afterReceiveInterest

◆ afterReceiveData

◆ afterReceiveNack

◆ afterStateChange