NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks
API Documentation
nfd::face::UnixStreamTransport Class Referencefinal

A Transport that communicates on a stream-oriented Unix domain socket. More...

#include <unix-stream-transport.hpp>

Inheritance diagram for nfd::face::UnixStreamTransport:
Collaboration diagram for nfd::face::UnixStreamTransport:

Public Member Functions

 UnixStreamTransport (protocol::socket &&socket)
 
- Public Member Functions inherited from nfd::face::StreamTransport< boost::asio::local::stream_protocol >
 StreamTransport (typename protocol::socket &&socket)
 Construct stream transport. More...
 
- Public Member Functions inherited from nfd::face::Transport
 Transport ()
 constructor More...
 
virtual ~Transport ()
 
void setFaceAndLinkService (Face &face, LinkService &service)
 set Face and LinkService for Transport More...
 
const Face * getFace () const
 
const LinkService * getLinkService () const
 
LinkService * getLinkService ()
 
virtual const Counters & getCounters () const
 
void close ()
 request the transport to be closed More...
 
void send (Packet &&packet)
 send a link-layer packet More...
 
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
 
ssize_t getMtu () const
 
TransportState getState () const
 
time::steady_clock::TimePoint getExpirationTime () const
 

Protected Member Functions

virtual void beforeChangePersistency (ndn::nfd::FacePersistency newPersistency) final
 invoked before persistency is changed More...
 
- Protected Member Functions inherited from nfd::face::StreamTransport< boost::asio::local::stream_protocol >
virtual void doClose () override
 performs Transport specific operations to close the transport More...
 
void deferredClose ()
 
virtual void doSend (Transport::Packet &&packet) override
 performs Transport specific operations to send a packet More...
 
void sendFromQueue ()
 
void handleSend (const boost::system::error_code &error, size_t nBytesSent)
 
void startReceive ()
 
void handleReceive (const boost::system::error_code &error, size_t nBytesReceived)
 
void processErrorCode (const boost::system::error_code &error)
 
virtual void handleError (const boost::system::error_code &error)
 
void resetReceiveBuffer ()
 
void resetSendQueue ()
 
 NFD_LOG_INCLASS_DECLARE ()
 
- Protected Member Functions inherited from nfd::face::Transport
void receive (Packet &&packet)
 receive a link-layer packet More...
 
void setLocalUri (const FaceUri &uri)
 
void setRemoteUri (const FaceUri &uri)
 
void setScope (ndn::nfd::FaceScope scope)
 
void setLinkType (ndn::nfd::LinkType linkType)
 
void setMtu (ssize_t mtu)
 
void setState (TransportState newState)
 set transport state More...
 
void setExpirationTime (const time::steady_clock::TimePoint &expirationTime)
 

Additional Inherited Members

- Public Types inherited from nfd::face::StreamTransport< boost::asio::local::stream_protocol >
typedef boost::asio::local::stream_protocol protocol
 
- Public Types inherited from nfd::face::Transport
typedef uint64_t EndpointId
 identifies an endpoint on the link More...
 
typedef TransportCounters Counters
 counters provided by Transport More...
 
- Public Attributes inherited from nfd::face::Transport
signal::Signal< Transport, TransportState, TransportState > afterStateChange
 signals when transport state changes More...
 
- Protected Attributes inherited from nfd::face::StreamTransport< boost::asio::local::stream_protocol >
protocol::socket m_socket
 
- Protected Attributes inherited from nfd::face::TransportCounters
PacketCounter nInPackets
 count of incoming packets More...
 
PacketCounter nOutPackets
 count of outgoing packets More...
 
ByteCounter nInBytes
 total incoming bytes More...
 
ByteCounter nOutBytes
 total outgoing bytes More...
 

Detailed Description

A Transport that communicates on a stream-oriented Unix domain socket.

Definition at line 41 of file unix-stream-transport.hpp.

Constructor & Destructor Documentation

◆ UnixStreamTransport()

Member Function Documentation

◆ beforeChangePersistency()

void nfd::face::UnixStreamTransport::beforeChangePersistency ( ndn::nfd::FacePersistency  newPersistency)
finalprotectedvirtual

invoked before persistency is changed

Exceptions
std::invalid_argumentnew persistency is not supported
std::runtime_errortransition is disallowed

Implements nfd::face::Transport.

Definition at line 53 of file unix-stream-transport.cpp.

References ndn::nfd::FACE_PERSISTENCY_ON_DEMAND.


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