nfd::face::Face Class Referencefinal

generalization of a network interface More...

#include <daemon/face/face.hpp>

+ Inheritance diagram for nfd::face::Face:
+ Collaboration diagram for nfd::face::Face:

Public Member Functions

 Face (unique_ptr< LinkService > service, unique_ptr< Transport > transport)
 
void close ()
 request the face to be closed More...
 
const FaceCountersgetCounters () const
 
time::steady_clock::TimePoint getExpirationTime () const
 
FaceId getId () const
 
LinkServicegetLinkService () const
 
ndn::nfd::LinkType getLinkType () const
 
FaceUri getLocalUri () const
 
ndn::nfd::FacePersistency getPersistency () const
 
FaceUri getRemoteUri () const
 
ndn::nfd::FaceScope getScope () const
 
FaceState getState () const
 
TransportgetTransport () const
 
void sendData (const Data &data)
 sends Data on Face More...
 
void sendInterest (const Interest &interest)
 sends Interest on Face More...
 
void sendNack (const lp::Nack &nack)
 sends Nack on Face More...
 
void setId (FaceId id)
 sets face ID More...
 
void setPersistency (ndn::nfd::FacePersistency persistency)
 changes face persistency setting More...
 

Public Attributes

signal::Signal< LinkService, Data > & afterReceiveData
 signals on Data received More...
 
signal::Signal< LinkService, Interest > & afterReceiveInterest
 signals on Interest 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

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

Definition at line 31 of file face.cpp.

Member Function Documentation

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 282 of file face.hpp.

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

Definition at line 288 of file face.hpp.

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 276 of file face.hpp.

FaceId nfd::face::Face::getId ( ) const
inline
Returns
face ID

Definition at line 222 of file face.hpp.

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

Definition at line 192 of file face.hpp.

ndn::nfd::LinkType nfd::face::Face::getLinkType ( ) const
inline
Returns
whether face is point-to-point or multi-access

Definition at line 264 of file face.hpp.

FaceUri nfd::face::Face::getLocalUri ( ) const
inline
Returns
a FaceUri representing local endpoint

Definition at line 234 of file face.hpp.

ndn::nfd::FacePersistency nfd::face::Face::getPersistency ( ) const
inline
Returns
face persistency setting

Definition at line 252 of file face.hpp.

FaceUri nfd::face::Face::getRemoteUri ( ) const
inline
Returns
a FaceUri representing remote endpoint

Definition at line 240 of file face.hpp.

ndn::nfd::FaceScope nfd::face::Face::getScope ( ) const
inline
Returns
whether face is local or non-local for scope control purpose

Definition at line 246 of file face.hpp.

FaceState nfd::face::Face::getState ( ) const
inline
Returns
face state

Definition at line 270 of file face.hpp.

Transport * nfd::face::Face::getTransport ( ) const
inline

Definition at line 198 of file face.hpp.

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

sends Data on Face

Definition at line 210 of file face.hpp.

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

sends Interest on Face

Definition at line 204 of file face.hpp.

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

sends Nack on Face

Definition at line 216 of file face.hpp.

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

sets face ID

Note
Normally, this should only be invoked by FaceTable.

Definition at line 228 of file face.hpp.

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

changes face persistency setting

Definition at line 258 of file face.hpp.

Member Data Documentation

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

signals on Data received

Definition at line 104 of file face.hpp.

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

signals on Interest received

Definition at line 100 of file face.hpp.

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

signals on Nack received

Definition at line 108 of file face.hpp.

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

signals after face state changed

Definition at line 160 of file face.hpp.