NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks
API Documentation
nfd::face::StreamTransport< Protocol > Class Template Reference

Implements Transport for stream-based protocols. More...

#include <stream-transport.hpp>

Inheritance diagram for nfd::face::StreamTransport< Protocol >:
Collaboration diagram for nfd::face::StreamTransport< Protocol >:

Public Types

typedef 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 Member Functions

 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 FacegetFace () const
 
const LinkServicegetLinkService () const
 
LinkServicegetLinkService ()
 
virtual const CountersgetCounters () 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 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)
 
virtual void beforeChangePersistency (ndn::nfd::FacePersistency newPersistency)=0
 invoked before persistency is changed More...
 

Protected Attributes

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...
 

Additional Inherited Members

- Public Attributes inherited from nfd::face::Transport
signal::Signal< Transport, TransportState, TransportStateafterStateChange
 signals when transport state changes More...
 

Detailed Description

template<class Protocol>
class nfd::face::StreamTransport< Protocol >

Implements Transport for stream-based protocols.

Template Parameters
Protocola stream-based protocol in Boost.Asio

Definition at line 42 of file stream-transport.hpp.

Member Typedef Documentation

◆ protocol

template<class Protocol>
typedef Protocol nfd::face::StreamTransport< Protocol >::protocol

Definition at line 45 of file stream-transport.hpp.

Constructor & Destructor Documentation

◆ StreamTransport()

template<class Protocol>
nfd::face::StreamTransport< T >::StreamTransport ( typename protocol::socket &&  socket)
explicit

Construct stream transport.

Parameters
socketProtocol-specific socket for the created transport

Definition at line 103 of file stream-transport.hpp.

Member Function Documentation

◆ doClose()

template<class T >
void nfd::face::StreamTransport< T >::doClose ( )
overrideprotectedvirtual

performs Transport specific operations to close the transport

This is invoked once by close() after changing state to CLOSING. It will not be invoked by Transport class if the transport is already CLOSING or CLOSED.

When the cleanup procedure is complete, this method should change state to CLOSED. This transition can happen synchronously or asynchronously.

Implements nfd::face::Transport.

Reimplemented in nfd::face::TcpTransport.

Definition at line 112 of file stream-transport.hpp.

Referenced by nfd::face::TcpTransport::doClose().

◆ deferredClose()

template<class T >
void nfd::face::StreamTransport< T >::deferredClose ( )
protected

Definition at line 144 of file stream-transport.hpp.

◆ doSend()

template<class T >
void nfd::face::StreamTransport< T >::doSend ( Transport::Packet &&  packet)
overrideprotectedvirtual

performs Transport specific operations to send a packet

Parameters
packetthe packet, which must be a well-formed TLV block
Precondition
state is either UP or DOWN

Implements nfd::face::Transport.

Definition at line 159 of file stream-transport.hpp.

◆ sendFromQueue()

template<class T >
void nfd::face::StreamTransport< T >::sendFromQueue ( )
protected

Definition at line 175 of file stream-transport.hpp.

◆ handleSend()

template<class T >
void nfd::face::StreamTransport< T >::handleSend ( const boost::system::error_code &  error,
size_t  nBytesSent 
)
protected

Definition at line 185 of file stream-transport.hpp.

◆ startReceive()

template<class T >
void nfd::face::StreamTransport< T >::startReceive ( )
protected

Definition at line 202 of file stream-transport.hpp.

◆ handleReceive()

template<class T >
void nfd::face::StreamTransport< T >::handleReceive ( const boost::system::error_code &  error,
size_t  nBytesReceived 
)
protected

Definition at line 215 of file stream-transport.hpp.

◆ processErrorCode()

template<class T >
void nfd::face::StreamTransport< T >::processErrorCode ( const boost::system::error_code &  error)
protected

Definition at line 262 of file stream-transport.hpp.

◆ handleError()

template<class T >
void nfd::face::StreamTransport< T >::handleError ( const boost::system::error_code &  error)
protectedvirtual

Reimplemented in nfd::face::TcpTransport.

Definition at line 279 of file stream-transport.hpp.

Referenced by nfd::face::TcpTransport::handleError().

◆ resetReceiveBuffer()

template<class T >
void nfd::face::StreamTransport< T >::resetReceiveBuffer ( )
protected

Definition at line 290 of file stream-transport.hpp.

◆ resetSendQueue()

template<class T >
void nfd::face::StreamTransport< T >::resetSendQueue ( )
protected

Definition at line 297 of file stream-transport.hpp.

◆ NFD_LOG_INCLASS_DECLARE()

template<class Protocol>
nfd::face::StreamTransport< Protocol >::NFD_LOG_INCLASS_DECLARE ( )
protected

Member Data Documentation

◆ m_socket

template<class Protocol>
protocol::socket nfd::face::StreamTransport< Protocol >::m_socket
protected

Definition at line 91 of file stream-transport.hpp.


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