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

A Transport that drops every packet. More...

#include <null-transport.hpp>

Inheritance diagram for nfd::face::NullTransport:
Collaboration diagram for nfd::face::NullTransport:

Public Member Functions

 NullTransport (const FaceUri &localUri=FaceUri("null://"), const FaceUri &remoteUri=FaceUri("null://"), ndn::nfd::FaceScope scope=ndn::nfd::FACE_SCOPE_NON_LOCAL, ndn::nfd::FacePersistency persistency=ndn::nfd::FACE_PERSISTENCY_PERMANENT)
 
- Public Member Functions inherited from nfd::face::Transport
 Transport ()
 Default 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 (const Block &packet, const EndpointId &endpoint=0)
 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
 
virtual ssize_t getSendQueueLength ()
 

Protected Member Functions

void doClose () OVERRIDE_WITH_TESTS_ELSE_FINAL
 performs Transport specific operations to close the transport More...
 
- Protected Member Functions inherited from nfd::face::Transport
void receive (const Block &packet, const EndpointId &endpoint=0)
 Pass a received link-layer packet to the upper layer for further processing. 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)
 
virtual bool canChangePersistencyToImpl (ndn::nfd::FacePersistency newPersistency) const
 invoked by canChangePersistencyTo to perform the check More...
 
virtual void afterChangePersistency (ndn::nfd::FacePersistency oldPersistency)
 invoked after the persistency has been changed More...
 

Additional Inherited Members

- Public Types inherited from nfd::face::Transport
using Counters = TransportCounters
 Counters provided by a transport. More...
 
- Public Attributes inherited from nfd::face::Transport
signal::Signal< Transport, TransportState, TransportStateafterStateChange
 signals when transport state changes More...
 
- Static Public Attributes inherited from nfd::face::Transport
static constexpr ssize_t MIN_MTU = 64
 minimum MTU that may be set on a transport More...
 
- 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 drops every packet.

Definition at line 36 of file null-transport.hpp.

Constructor & Destructor Documentation

◆ NullTransport()

Member Function Documentation

◆ doClose()

void nfd::face::NullTransport::doClose ( )
inlineprotectedvirtual

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 47 of file null-transport.hpp.

References nfd::face::CLOSED, and nfd::face::Transport::setState().


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