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

A Transport that communicates on a unicast UDP socket. More...

#include <unicast-udp-transport.hpp>

Inheritance diagram for nfd::face::UnicastUdpTransport:
Collaboration diagram for nfd::face::UnicastUdpTransport:

Public Member Functions

 UnicastUdpTransport (protocol::socket &&socket, ndn::nfd::FacePersistency persistency, time::nanoseconds idleTimeout)
 
- Public Member Functions inherited from nfd::face::DatagramTransport< boost::asio::ip::udp, Unicast >
 DatagramTransport (typename protocol::socket &&socket)
 Construct datagram transport. More...
 
ssize_t getSendQueueLength () override
 
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
 
bool canChangePersistencyTo (ndn::nfd::FacePersistency newPersistency) const
 check whether the face persistency can be changed to newPersistency More...
 
void setPersistency (ndn::nfd::FacePersistency newPersistency)
 changes face persistency setting More...
 
ndn::nfd::LinkType getLinkType () const
 
ssize_t getMtu () const
 
ssize_t getSendQueueCapacity () const
 
TransportState getState () const
 
time::steady_clock::TimePoint getExpirationTime () const
 

Protected Member Functions

bool canChangePersistencyToImpl (ndn::nfd::FacePersistency newPersistency) const final
 invoked by canChangePersistencyTo to perform the check More...
 
void afterChangePersistency (ndn::nfd::FacePersistency oldPersistency) final
 invoked after the persistency has been changed More...
 
- Protected Member Functions inherited from nfd::face::DatagramTransport< boost::asio::ip::udp, Unicast >
void doClose () override
 performs Transport specific operations to close the transport More...
 
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 hasRecentlyReceived () const
 
void resetRecentlyReceived ()
 
Transport::EndpointId makeEndpointId (const protocol::endpoint &ep)
 
Transport::EndpointId makeEndpointId (const protocol::endpoint &ep)
 
 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 setSendQueueCapacity (ssize_t sendQueueCapacity)
 
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::DatagramTransport< boost::asio::ip::udp, Unicast >
typedef boost::asio::ip::udp 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, TransportStateafterStateChange
 signals when transport state changes More...
 
- Static Protected Member Functions inherited from nfd::face::DatagramTransport< boost::asio::ip::udp, Unicast >
static EndpointId makeEndpointId (const typename protocol::endpoint &ep)
 
- Protected Attributes inherited from nfd::face::DatagramTransport< boost::asio::ip::udp, Unicast >
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...
 

Detailed Description

A Transport that communicates on a unicast UDP socket.

Definition at line 38 of file unicast-udp-transport.hpp.

Constructor & Destructor Documentation

◆ UnicastUdpTransport()

Member Function Documentation

◆ canChangePersistencyToImpl()

bool nfd::face::UnicastUdpTransport::canChangePersistencyToImpl ( ndn::nfd::FacePersistency  newPersistency) const
finalprotectedvirtual

invoked by canChangePersistencyTo to perform the check

Base class implementation returns false.

Parameters
newPersistencythe new persistency, guaranteed to be different from current persistency

Reimplemented from nfd::face::Transport.

Definition at line 84 of file unicast-udp-transport.cpp.

◆ afterChangePersistency()

void nfd::face::UnicastUdpTransport::afterChangePersistency ( ndn::nfd::FacePersistency  oldPersistency)
finalprotectedvirtual

invoked after the persistency has been changed

The base class implementation does nothing. When overridden in a subclass, the function should update internal states after persistency setting has been changed.

Reimplemented from nfd::face::Transport.

Definition at line 90 of file unicast-udp-transport.cpp.

References nfd::scheduler::ScopedEventId::cancel(), ndn::nfd::FACE_PERSISTENCY_ON_DEMAND, nfd::face::Transport::getPersistency(), and nfd::face::Transport::setExpirationTime().


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