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

Implementation of Face abstraction that uses TCP as underlying transport mechanism and is used for local communication (can enable LocalControlHeader) More...

#include <tcp-face.hpp>

Inheritance diagram for nfd::TcpLocalFace:
Collaboration diagram for nfd::TcpLocalFace:

Public Member Functions

 TcpLocalFace (const FaceUri &remoteUri, const FaceUri &localUri, protocol::socket socket, bool isOnDemand)
 
- Public Member Functions inherited from nfd::StreamFace< boost::asio::ip::tcp, LocalFace >
 StreamFace (const FaceUri &remoteUri, const FaceUri &localUri, typename protocol::socket socket, bool isOnDemand)
 
void sendInterest (const Interest &interest) 1
 
void sendData (const Data &data) 1
 
void close () 1
 
- Public Member Functions inherited from nfd::LocalFace
 LocalFace (const FaceUri &remoteUri, const FaceUri &localUri)
 
bool isLocalControlHeaderEnabled () const
 get whether any LocalControlHeader feature is enabled More...
 
bool isLocalControlHeaderEnabled (LocalControlFeature feature) const
 get whether a specific LocalControlHeader feature is enabled More...
 
void setLocalControlHeaderFeature (LocalControlFeature feature, bool enabled=true)
 enable or disable a LocalControlHeader feature 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 Types inherited from nfd::StreamFace< boost::asio::ip::tcp, LocalFace >
typedef boost::asio::ip::tcp protocol
 
- 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...
 
- Static Public Attributes inherited from nfd::LocalFace
static const size_t LOCAL_CONTROL_FEATURE_MAX = 3
 
static const size_t LOCAL_CONTROL_FEATURE_ANY = 0
 upper bound of LocalControlFeature enum More...
 
- Protected Member Functions inherited from nfd::StreamFace< boost::asio::ip::tcp, LocalFace >
void processErrorCode (const boost::system::error_code &error)
 
void sendFromQueue ()
 
void handleSend (const boost::system::error_code &error, size_t nBytesSent)
 
void handleReceive (const boost::system::error_code &error, size_t nBytesReceived)
 
void shutdownSocket ()
 
void deferredClose (const shared_ptr< Face > &face)
 
 NFD_LOG_INCLASS_DECLARE ()
 
- Protected Member Functions inherited from nfd::LocalFace
bool decodeAndDispatchInput (const Block &element)
 any feature More...
 
bool isEmptyFilteredLocalControlHeader (const ndn::nfd::LocalControlHeader &header) const
 Check if LocalControlHeader needs to be included, taking into account both set parameters in supplied LocalControlHeader and features enabled on the local face. More...
 
template<class Packet >
Block filterAndEncodeLocalControlHeader (const Packet &packet)
 Create LocalControlHeader, considering enabled features. 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 ()
 
- Protected Attributes inherited from nfd::StreamFace< boost::asio::ip::tcp, LocalFace >
protocol::socket m_socket
 

Detailed Description

Implementation of Face abstraction that uses TCP as underlying transport mechanism and is used for local communication (can enable LocalControlHeader)

Definition at line 49 of file tcp-face.hpp.

Constructor & Destructor Documentation

nfd::TcpLocalFace::TcpLocalFace ( const FaceUri remoteUri,
const FaceUri localUri,
protocol::socket  socket,
bool  isOnDemand 
)

Definition at line 41 of file tcp-face.cpp.


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