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

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

#include <datagram-transport.hpp>

Inheritance diagram for nfd::face::DatagramTransport< Protocol, Addressing >:
Collaboration diagram for nfd::face::DatagramTransport< Protocol, Addressing >:

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

 DatagramTransport (typename protocol::socket &&socket)
 Construct datagram transport. More...
 
void receiveDatagram (const uint8_t *buffer, size_t nBytesReceived, const boost::system::error_code &error)
 Receive datagram, translate buffer into packet, deliver to parent class. 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...
 
virtual void doSend (Transport::Packet &&packet) override
 performs Transport specific operations to send a packet More...
 
void handleSend (const boost::system::error_code &error, size_t nBytesSent, const Block &payload)
 
void handleReceive (const boost::system::error_code &error, size_t nBytesReceived)
 
void processErrorCode (const boost::system::error_code &error)
 
bool hasBeenUsedRecently () const
 
void resetRecentUsage ()
 
 NFD_LOG_INCLASS_DECLARE ()
 
template<>
Transport::EndpointId makeEndpointId (const protocol::endpoint &ep)
 
template<>
Transport::EndpointId makeEndpointId (const protocol::endpoint &ep)
 
- 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...
 

Static Protected Member Functions

static EndpointId makeEndpointId (const typename protocol::endpoint &ep)
 

Protected Attributes

protocol::socket m_socket
 
protocol::endpoint m_sender
 
- 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 Addressing = Unicast>
class nfd::face::DatagramTransport< Protocol, Addressing >

Implements Transport for datagram-based protocols.

Template Parameters
Protocola datagram-based protocol in Boost.Asio

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

Member Typedef Documentation

◆ protocol

template<class Protocol, class Addressing = Unicast>
typedef Protocol nfd::face::DatagramTransport< Protocol, Addressing >::protocol

Definition at line 48 of file datagram-transport.hpp.

Constructor & Destructor Documentation

◆ DatagramTransport()

template<class Protocol, class Addressing = Unicast>
nfd::face::DatagramTransport< T, U >::DatagramTransport ( typename protocol::socket &&  socket)
explicit

Construct datagram transport.

Parameters
socketProtocol-specific socket for the created transport

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

Member Function Documentation

◆ receiveDatagram()

template<class T , class U >
void nfd::face::DatagramTransport< T, U >::receiveDatagram ( const uint8_t *  buffer,
size_t  nBytesReceived,
const boost::system::error_code &  error 
)

Receive datagram, translate buffer into packet, deliver to parent class.

Definition at line 149 of file datagram-transport.hpp.

◆ doClose()

template<class T , class U >
void nfd::face::DatagramTransport< T, U >::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.

Definition at line 115 of file datagram-transport.hpp.

Referenced by nfd::face::MulticastUdpTransport::beforeChangePersistency().

◆ doSend()

template<class T , class U >
void nfd::face::DatagramTransport< T, U >::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 136 of file datagram-transport.hpp.

◆ handleSend()

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

Definition at line 193 of file datagram-transport.hpp.

◆ handleReceive()

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

Definition at line 179 of file datagram-transport.hpp.

◆ processErrorCode()

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

Definition at line 205 of file datagram-transport.hpp.

◆ hasBeenUsedRecently()

template<class T , class U >
bool nfd::face::DatagramTransport< T, U >::hasBeenUsedRecently ( ) const
inlineprotected

Definition at line 230 of file datagram-transport.hpp.

◆ resetRecentUsage()

template<class T , class U >
void nfd::face::DatagramTransport< T, U >::resetRecentUsage ( )
inlineprotected

Definition at line 237 of file datagram-transport.hpp.

◆ makeEndpointId() [1/3]

template<class T , class U >
Transport::EndpointId nfd::face::DatagramTransport< T, U >::makeEndpointId ( const typename protocol::endpoint &  ep)
inlinestaticprotected

Definition at line 244 of file datagram-transport.hpp.

◆ NFD_LOG_INCLASS_DECLARE()

template<class Protocol, class Addressing = Unicast>
nfd::face::DatagramTransport< Protocol, Addressing >::NFD_LOG_INCLASS_DECLARE ( )
protected

◆ makeEndpointId() [2/3]

template<>
Transport::EndpointId nfd::face::DatagramTransport< boost::asio::ip::udp, Multicast >::makeEndpointId ( const protocol::endpoint &  ep)
protected

Definition at line 92 of file multicast-udp-transport.cpp.

◆ makeEndpointId() [3/3]

template<>
Transport::EndpointId nfd::face::DatagramTransport< boost::asio::ip::udp, Multicast >::makeEndpointId ( const protocol::endpoint &  ep)
protected

Member Data Documentation

◆ m_socket

template<class Protocol, class Addressing = Unicast>
protocol::socket nfd::face::DatagramTransport< Protocol, Addressing >::m_socket
protected

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

◆ m_sender

template<class Protocol, class Addressing = Unicast>
protocol::endpoint nfd::face::DatagramTransport< Protocol, Addressing >::m_sender
protected

Definition at line 92 of file datagram-transport.hpp.


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