represents a face More...

#include <face.hpp>

Inheritance diagram for nfd::Face:

[legend]

Collaboration diagram for nfd::Face:

[legend]

Classes
class	Error
	Face-related error. More...

Public Member Functions
	Face (const FaceUri &remoteUri, const FaceUri &localUri, bool isLocal=false, bool isMultiAccess=false)

virtual	~Face ()

virtual void	sendInterest (const Interest &interest)=0
	send an Interest More...

virtual void	sendData (const Data &data)=0
	send a Data More...

virtual void	close ()=0
	Close the face. More...

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 FaceCounters &	getCounters () const

const FaceUri &	getRemoteUri () const

const FaceUri &	getLocalUri () const

template<typename FaceTraits >
void	copyStatusTo (FaceTraits &traits) const

virtual ndn::nfd::FaceStatus	getFaceStatus () const

Public Attributes
signal::Signal< Face, Interest >	onReceiveInterest
	fires when an Interest is received More...

signal::Signal< Face, Data >	onReceiveData
	fires when a Data is received More...

signal::Signal< Face, Interest >	onSendInterest
	fires when an Interest is sent out More...

signal::Signal< Face, Data >	onSendData
	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
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...

FaceCounters &	getMutableCounters ()

Friends
class	FaceTable

Detailed Description

represents a face

Definition at line 57 of file face.hpp.

Constructor & Destructor Documentation

◆ Face()

nfd::Face::Face	(	const FaceUri &	remoteUri,
		const FaceUri &	localUri,
		bool	isLocal = `false`,
		bool	isMultiAccess = `false`
	)

Definition at line 32 of file face.cpp.

References nfd::NetworkLayerCounters::getNInDatas(), nfd::NetworkLayerCounters::getNInInterests(), nfd::NetworkLayerCounters::getNOutDatas(), nfd::NetworkLayerCounters::getNOutInterests(), onReceiveData, onReceiveInterest, onSendData, and onSendInterest.

◆ ~Face()

nfd::Face::~Face ( )

virtual

Definition at line 48 of file face.cpp.

Member Function Documentation

◆ sendInterest()

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

pure virtual

send an Interest

Implemented in ndn::Face::Impl::NfdFace, nfd::EthernetFace, nfd::InternalFace, nfd::WebSocketFace, nfd::DatagramFace< Protocol, Addressing >, nfd::DatagramFace< boost::asio::ip::udp >, nfd::DatagramFace< boost::asio::ip::udp, Multicast >, nfd::MulticastUdpFace, nfd::StreamFace< boost::asio::ip::tcp >, nfd::StreamFace< boost::asio::local::stream_protocol, LocalFace >, nfd::StreamFace< boost::asio::ip::tcp, LocalFace >, and nfd::NullFace.

◆ sendData()

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

pure virtual

send a Data

Implemented in ndn::Face::Impl::NfdFace, nfd::EthernetFace, nfd::InternalFace, nfd::WebSocketFace, nfd::DatagramFace< Protocol, Addressing >, nfd::DatagramFace< boost::asio::ip::udp >, nfd::DatagramFace< boost::asio::ip::udp, Multicast >, nfd::MulticastUdpFace, nfd::StreamFace< boost::asio::ip::tcp >, nfd::StreamFace< boost::asio::local::stream_protocol, LocalFace >, nfd::StreamFace< boost::asio::ip::tcp, LocalFace >, and nfd::NullFace.

◆ close()

virtual void nfd::Face::close ( )

pure virtual

Close the face.

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

Implemented in ndn::Face::Impl::NfdFace, nfd::EthernetFace, nfd::InternalFace, nfd::WebSocketFace, nfd::DatagramFace< Protocol, Addressing >, nfd::DatagramFace< boost::asio::ip::udp >, nfd::DatagramFace< boost::asio::ip::udp, Multicast >, nfd::StreamFace< boost::asio::ip::tcp >, nfd::StreamFace< boost::asio::local::stream_protocol, LocalFace >, nfd::StreamFace< boost::asio::ip::tcp, LocalFace >, and nfd::NullFace.

◆ getId()

FaceId nfd::Face::getId ( ) const

inline

Definition at line 221 of file face.hpp.

Referenced by nfd::fw::BestRouteStrategy2::afterReceiveInterest(), nfd::fw::AccessStrategy::afterReceiveInterest(), nfd::fw::AccessStrategy::beforeSatisfyInterest(), nfd::fw::Strategy::beforeSatisfyInterest(), and copyStatusTo().

◆ getDescription()

const std::string & nfd::Face::getDescription ( ) const

inline

Get the description.

Definition at line 233 of file face.hpp.

◆ setDescription()

void nfd::Face::setDescription ( const std::string & description )

inline

Set the face description.

This is typically invoked by management on set description command

Definition at line 239 of file face.hpp.

◆ isLocal()

bool nfd::Face::isLocal ( ) const

inline

Get whether face is connected to a local app.

Definition at line 245 of file face.hpp.

Referenced by copyStatusTo(), and nfd::pit::Entry::violatesScope().

◆ getPersistency()

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

inline

Get the persistency setting.

Definition at line 251 of file face.hpp.

Referenced by copyStatusTo(), nfd::UdpFace::getFaceStatus(), nfd::DatagramFace< boost::asio::ip::udp, Multicast >::processErrorCode(), and nfd::UdpFace::UdpFace().

◆ isMultiAccess()

bool nfd::Face::isMultiAccess ( ) const

inline

Get whether packets sent by this face may reach multiple peers.

Definition at line 263 of file face.hpp.

Referenced by copyStatusTo().

◆ isUp()

bool nfd::Face::isUp ( ) const

virtual

Get whether underlying communication is up.

In this base class this property is always true.

Definition at line 53 of file face.cpp.

◆ getCounters()

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

inline

Definition at line 269 of file face.hpp.

Referenced by getFaceStatus().

◆ getRemoteUri()

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

inline

Returns: a FaceUri that represents the remote endpoint

Definition at line 281 of file face.hpp.

Referenced by copyStatusTo().

◆ getLocalUri()

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

inline

Returns: a FaceUri that represents the local endpoint (NFD side)

Definition at line 287 of file face.hpp.

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

◆ copyStatusTo()

template<typename FaceTraits >

void nfd::Face::copyStatusTo ( FaceTraits & traits ) const

Returns: FaceTraits data structure filled with the current FaceTraits status

Definition at line 99 of file face.cpp.

References ndn::nfd::FACE_SCOPE_LOCAL, ndn::nfd::FACE_SCOPE_NON_LOCAL, getId(), getLocalUri(), getPersistency(), getRemoteUri(), isLocal(), isMultiAccess(), ndn::nfd::LINK_TYPE_MULTI_ACCESS, ndn::nfd::LINK_TYPE_POINT_TO_POINT, and ndn::time::toString().

Referenced by getFaceStatus().

◆ getFaceStatus()

ndn::nfd::FaceStatus nfd::Face::getFaceStatus ( ) const

virtual

Returns: FaceStatus data structure filled with the current Face status

Reimplemented in nfd::UdpFace.

Definition at line 118 of file face.cpp.

References copyStatusTo(), nfd::FaceCounters::copyTo(), and getCounters().

Referenced by nfd::UdpFace::getFaceStatus().

◆ setPersistency()

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

inlineprotected

Definition at line 257 of file face.hpp.

Referenced by nfd::UdpFace::UdpFace(), and nfd::WebSocketFace::WebSocketFace().

◆ decodeAndDispatchInput()

bool nfd::Face::decodeAndDispatchInput ( const Block & element )

protected

Definition at line 59 of file face.cpp.

References ndn::tlv::Data, ndn::tlv::Interest, onReceiveData, onReceiveInterest, and ndn::Block::type().

Referenced by nfd::WebSocketFace::handleReceive(), and nfd::DatagramFace< boost::asio::ip::udp, Multicast >::receiveDatagram().

◆ fail()

void nfd::Face::fail ( const std::string & reason )

protected

fail the face and raise onFail event if it's UP; otherwise do nothing

Definition at line 87 of file face.cpp.

References onFail.

Referenced by nfd::NullFace::close(), nfd::DatagramFace< boost::asio::ip::udp, Multicast >::close(), nfd::WebSocketFace::close(), nfd::EthernetFace::close(), ndn::Face::Impl::NfdFace::close(), and nfd::DatagramFace< boost::asio::ip::udp, Multicast >::processErrorCode().

◆ getMutableCounters()

FaceCounters & nfd::Face::getMutableCounters ( )

inlineprotected

Definition at line 275 of file face.hpp.

Referenced by nfd::WebSocketFace::handleReceive(), nfd::DatagramFace< boost::asio::ip::udp, Multicast >::handleSend(), nfd::DatagramFace< boost::asio::ip::udp, Multicast >::receiveDatagram(), nfd::WebSocketFace::sendData(), and nfd::WebSocketFace::sendInterest().

Friends And Related Function Documentation

◆ FaceTable

friend class FaceTable

friend

Definition at line 217 of file face.hpp.

Member Data Documentation

◆ onReceiveInterest

signal::Signal<Face, Interest> nfd::Face::onReceiveInterest

fires when an Interest is received

Definition at line 80 of file face.hpp.

Referenced by nfd::LocalFace::decodeAndDispatchInput(), decodeAndDispatchInput(), and Face().

◆ onReceiveData

signal::Signal<Face, Data> nfd::Face::onReceiveData

fires when a Data is received

Definition at line 83 of file face.hpp.

Referenced by nfd::LocalFace::decodeAndDispatchInput(), decodeAndDispatchInput(), Face(), and nfd::InternalFace::put().

◆ onSendInterest

signal::Signal<Face, Interest> nfd::Face::onSendInterest

fires when an Interest is sent out

Definition at line 86 of file face.hpp.

Referenced by Face(), nfd::MulticastUdpFace::sendInterest(), nfd::DatagramFace< boost::asio::ip::udp, Multicast >::sendInterest(), nfd::WebSocketFace::sendInterest(), nfd::InternalFace::sendInterest(), and nfd::EthernetFace::sendInterest().

◆ onSendData

signal::Signal<Face, Data> nfd::Face::onSendData

fires when a Data is sent out

Definition at line 89 of file face.hpp.

Referenced by Face(), nfd::MulticastUdpFace::sendData(), nfd::DatagramFace< boost::asio::ip::udp, Multicast >::sendData(), nfd::WebSocketFace::sendData(), nfd::InternalFace::sendData(), and nfd::EthernetFace::sendData().

◆ onFail

signal::Signal<Face, std::string> nfd::Face::onFail

fires when face disconnects or fails to perform properly

Definition at line 92 of file face.hpp.

Referenced by fail().

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

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

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Face()

◆ ~Face()

Member Function Documentation

◆ sendInterest()

◆ sendData()

◆ close()

◆ getId()

◆ getDescription()

◆ setDescription()

◆ isLocal()

◆ getPersistency()

◆ isMultiAccess()

◆ isUp()

◆ getCounters()

◆ getRemoteUri()

◆ getLocalUri()

◆ copyStatusTo()

◆ getFaceStatus()

◆ setPersistency()

◆ decodeAndDispatchInput()

◆ fail()

◆ getMutableCounters()

Friends And Related Function Documentation

◆ FaceTable

Member Data Documentation

◆ onReceiveInterest

◆ onReceiveData

◆ onSendInterest

◆ onSendData

◆ onFail