nfd::face::EthernetTransport Class Reference

Base class for Ethernet-based Transports. More...

#include <daemon/face/ethernet-transport.hpp>

+ Inheritance diagram for nfd::face::EthernetTransport:
+ Collaboration diagram for nfd::face::EthernetTransport:

Classes

class  Error
 

Public Types

using Counters = TransportCounters
 Counters provided by a transport. More...
 

Public Member Functions

bool canChangePersistencyTo (ndn::nfd::FacePersistency newPersistency) const
 check whether the face persistency can be changed to newPersistency More...
 
void close ()
 Request the transport to be closed. More...
 
virtual const CountersgetCounters () const
 
time::steady_clock::TimePoint getExpirationTime () const
 
const FacegetFace () const
 
const LinkServicegetLinkService () const
 
LinkServicegetLinkService ()
 
ndn::nfd::LinkType getLinkType () const
 
FaceUri getLocalUri () const
 
ssize_t getMtu () const
 
ndn::nfd::FacePersistency getPersistency () const
 
FaceUri getRemoteUri () const
 
ndn::nfd::FaceScope getScope () const
 
ssize_t getSendQueueCapacity () const
 
virtual ssize_t getSendQueueLength ()
 
TransportState getState () const
 
void receivePayload (const uint8_t *payload, size_t length, const ethernet::Address &sender)
 Processes the payload of an incoming frame. More...
 
void send (const Block &packet)
 Send a link-layer packet. More...
 
void setFaceAndLinkService (Face &face, LinkService &service)
 set Face and LinkService for Transport More...
 
void setPersistency (ndn::nfd::FacePersistency newPersistency)
 changes face persistency setting More...
 

Public Attributes

signal::Signal< Transport, TransportState, TransportStateafterStateChange
 signals when transport state changes More...
 

Protected Member Functions

 EthernetTransport (const ndn::net::NetworkInterface &localEndpoint, const ethernet::Address &remoteEndpoint)
 
virtual void afterChangePersistency (ndn::nfd::FacePersistency oldPersistency)
 invoked after the persistency has been changed More...
 
virtual bool canChangePersistencyToImpl (ndn::nfd::FacePersistency newPersistency) const
 invoked by canChangePersistencyTo to perform the check More...
 
void doClose () final
 performs Transport specific operations to close the transport More...
 
bool hasRecentlyReceived () const
 
void receive (const Block &packet, const EndpointId &endpoint=0)
 Pass a received link-layer packet to the upper layer for further processing. More...
 
void resetRecentlyReceived ()
 
void setExpirationTime (const time::steady_clock::TimePoint &expirationTime)
 
void setLinkType (ndn::nfd::LinkType linkType)
 
void setLocalUri (const FaceUri &uri)
 
void setMtu (ssize_t mtu)
 
void setRemoteUri (const FaceUri &uri)
 
void setScope (ndn::nfd::FaceScope scope)
 
void setSendQueueCapacity (ssize_t sendQueueCapacity)
 
void setState (TransportState newState)
 set transport state More...
 

Protected Attributes

ethernet::Address m_destAddress
 
std::string m_interfaceName
 
PcapHelper m_pcap
 
boost::asio::posix::stream_descriptor m_socket
 
ethernet::Address m_srcAddress
 
ByteCounter nInBytes
 total incoming bytes More...
 
PacketCounter nInPackets
 count of incoming packets More...
 
ByteCounter nOutBytes
 total outgoing bytes More...
 
PacketCounter nOutPackets
 count of outgoing packets More...
 

Detailed Description

Base class for Ethernet-based Transports.

Definition at line 41 of file ethernet-transport.hpp.

Member Typedef Documentation

◆ Counters

Counters provided by a transport.

See also
TransportCounters

Definition at line 114 of file transport.hpp.

Constructor & Destructor Documentation

◆ EthernetTransport()

nfd::face::EthernetTransport::EthernetTransport ( const ndn::net::NetworkInterface &  localEndpoint,
const ethernet::Address &  remoteEndpoint 
)
protected

Definition at line 41 of file ethernet-transport.cpp.

Member Function Documentation

◆ afterChangePersistency()

void nfd::face::Transport::afterChangePersistency ( ndn::nfd::FacePersistency  oldPersistency)
protectedvirtualinherited

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 in nfd::face::TcpTransport, nfd::face::UnicastEthernetTransport, and nfd::face::UnicastUdpTransport.

Definition at line 182 of file transport.cpp.

◆ canChangePersistencyTo()

bool nfd::face::Transport::canChangePersistencyTo ( ndn::nfd::FacePersistency  newPersistency) const
inherited

check whether the face persistency can be changed to newPersistency

This function serves as the external API, and invokes the protected function canChangePersistencyToImpl to perform further checks if newPersistency differs from the current persistency.

Returns
true if the change can be performed, false otherwise

Definition at line 142 of file transport.cpp.

◆ canChangePersistencyToImpl()

bool nfd::face::Transport::canChangePersistencyToImpl ( ndn::nfd::FacePersistency  newPersistency) const
protectedvirtualinherited

invoked by canChangePersistencyTo to perform the check

Base class implementation returns false.

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

Reimplemented in nfd::face::TcpTransport, nfd::face::UnicastEthernetTransport, and nfd::face::UnicastUdpTransport.

Definition at line 158 of file transport.cpp.

◆ close()

void nfd::face::Transport::close ( )
inherited

Request the transport to be closed.

This operation is effective only if transport is in UP or DOWN state, otherwise it has no effect. The transport changes state to CLOSING, and performs cleanup procedure. The state will be changed to CLOSED when cleanup is complete, which may happen synchronously or asynchronously.

Definition at line 79 of file transport.cpp.

◆ doClose()

void nfd::face::EthernetTransport::doClose ( )
finalprotectedvirtual

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 78 of file ethernet-transport.cpp.

◆ getCounters()

const Transport::Counters & nfd::face::Transport::getCounters ( ) const
inlinevirtualinherited

Reimplemented in nfd::face::WebSocketTransport.

Definition at line 373 of file transport.hpp.

◆ getExpirationTime()

time::steady_clock::TimePoint nfd::face::Transport::getExpirationTime ( ) const
inlineinherited
Returns
expiration time of the transport
Return values
time::steady_clock::TimePoint::max()the transport has indefinite lifetime

Definition at line 457 of file transport.hpp.

◆ getFace()

const Face * nfd::face::Transport::getFace ( ) const
inlineinherited
Returns
Face to which this Transport is attached

Definition at line 355 of file transport.hpp.

◆ getLinkService() [1/2]

const LinkService * nfd::face::Transport::getLinkService ( ) const
inlineinherited
Returns
LinkService to which this Transport is attached

Definition at line 361 of file transport.hpp.

◆ getLinkService() [2/2]

LinkService * nfd::face::Transport::getLinkService ( )
inlineinherited
Returns
LinkService to which this Transport is attached

Definition at line 367 of file transport.hpp.

◆ getLinkType()

ndn::nfd::LinkType nfd::face::Transport::getLinkType ( ) const
inlineinherited
Returns
the link type of the transport

Definition at line 421 of file transport.hpp.

◆ getLocalUri()

FaceUri nfd::face::Transport::getLocalUri ( ) const
inlineinherited
Returns
a FaceUri representing local endpoint

Definition at line 379 of file transport.hpp.

◆ getMtu()

ssize_t nfd::face::Transport::getMtu ( ) const
inlineinherited
Returns
maximum payload size
Return values
MTU_UNLIMITEDtransport has no limit on payload size

This size is the maximum packet size that can be sent or received through this transport.

For a datagram-based transport, this is typically the Maximum Transmission Unit (MTU), after the overhead of headers introduced by the transport has been accounted for. For a stream-based transport, this is typically unlimited (MTU_UNLIMITED).

Definition at line 433 of file transport.hpp.

◆ getPersistency()

ndn::nfd::FacePersistency nfd::face::Transport::getPersistency ( ) const
inlineinherited
Returns
face persistency setting

Definition at line 415 of file transport.hpp.

◆ getRemoteUri()

FaceUri nfd::face::Transport::getRemoteUri ( ) const
inlineinherited
Returns
a FaceUri representing remote endpoint

Definition at line 391 of file transport.hpp.

◆ getScope()

ndn::nfd::FaceScope nfd::face::Transport::getScope ( ) const
inlineinherited
Returns
whether face is local or non-local for scope control purpose

Definition at line 403 of file transport.hpp.

◆ getSendQueueCapacity()

ssize_t nfd::face::Transport::getSendQueueCapacity ( ) const
inlineinherited
Returns
capacity of the send queue (in bytes)
Return values
QUEUE_UNSUPPORTEDtransport does not support queue capacity retrieval
QUEUE_ERRORtransport was unable to retrieve the queue capacity

Definition at line 439 of file transport.hpp.

◆ getSendQueueLength()

virtual ssize_t nfd::face::Transport::getSendQueueLength ( )
inlinevirtualinherited
Returns
current send queue length of the transport (in octets)
Return values
QUEUE_UNSUPPORTEDtransport does not support queue length retrieval
QUEUE_ERRORtransport was unable to retrieve the queue length

Reimplemented in nfd::face::MulticastUdpTransport, nfd::face::DatagramTransport< Protocol, Addressing >, nfd::face::DatagramTransport< boost::asio::ip::udp, Unicast >, nfd::face::DatagramTransport< boost::asio::ip::udp, Multicast >, nfd::face::StreamTransport< Protocol >, nfd::face::StreamTransport< boost::asio::ip::tcp >, nfd::face::StreamTransport< boost::asio::local::stream_protocol >, and nfd::face::TcpTransport.

Definition at line 256 of file transport.hpp.

◆ getState()

TransportState nfd::face::Transport::getState ( ) const
inlineinherited
Returns
transport state

Definition at line 451 of file transport.hpp.

◆ hasRecentlyReceived()

bool nfd::face::EthernetTransport::hasRecentlyReceived ( ) const
inlineprotected

Definition at line 68 of file ethernet-transport.hpp.

◆ receive()

void nfd::face::Transport::receive ( const Block &  packet,
const EndpointId endpoint = 0 
)
protectedinherited

Pass a received link-layer packet to the upper layer for further processing.

Parameters
packetthe received packet, must be a valid and well-formed TLV block
endpointthe source endpoint
Warning
Behavior is undefined if packet size exceeds the MTU limit

Definition at line 113 of file transport.cpp.

◆ receivePayload()

void nfd::face::EthernetTransport::receivePayload ( const uint8_t *  payload,
size_t  length,
const ethernet::Address &  sender 
)

Processes the payload of an incoming frame.

Parameters
payloadPointer to the first byte of data after the Ethernet header
lengthPayload length
senderSender address

Definition at line 205 of file ethernet-transport.cpp.

◆ resetRecentlyReceived()

void nfd::face::EthernetTransport::resetRecentlyReceived ( )
inlineprotected

Definition at line 74 of file ethernet-transport.hpp.

◆ send()

void nfd::face::Transport::send ( const Block &  packet)
inherited

Send a link-layer packet.

Parameters
packetthe packet to be sent, must be a valid and well-formed TLV block
Note
This operation has no effect if getState() is neither UP nor DOWN
Warning
Behavior is undefined if packet size exceeds the MTU limit

Definition at line 92 of file transport.cpp.

◆ setExpirationTime()

void nfd::face::Transport::setExpirationTime ( const time::steady_clock::TimePoint &  expirationTime)
inlineprotectedinherited

Definition at line 463 of file transport.hpp.

◆ setFaceAndLinkService()

void nfd::face::Transport::setFaceAndLinkService ( Face face,
LinkService service 
)
inherited

set Face and LinkService for Transport

Precondition
setFaceAndLinkService has not been called

Definition at line 69 of file transport.cpp.

◆ setLinkType()

void nfd::face::Transport::setLinkType ( ndn::nfd::LinkType  linkType)
inlineprotectedinherited

Definition at line 427 of file transport.hpp.

◆ setLocalUri()

void nfd::face::Transport::setLocalUri ( const FaceUri &  uri)
inlineprotectedinherited

Definition at line 385 of file transport.hpp.

◆ setMtu()

void nfd::face::Transport::setMtu ( ssize_t  mtu)
protectedinherited

Definition at line 126 of file transport.cpp.

◆ setPersistency()

void nfd::face::Transport::setPersistency ( ndn::nfd::FacePersistency  newPersistency)
inherited

changes face persistency setting

Definition at line 164 of file transport.cpp.

◆ setRemoteUri()

void nfd::face::Transport::setRemoteUri ( const FaceUri &  uri)
inlineprotectedinherited

Definition at line 397 of file transport.hpp.

◆ setScope()

void nfd::face::Transport::setScope ( ndn::nfd::FaceScope  scope)
inlineprotectedinherited

Definition at line 409 of file transport.hpp.

◆ setSendQueueCapacity()

void nfd::face::Transport::setSendQueueCapacity ( ssize_t  sendQueueCapacity)
inlineprotectedinherited

Definition at line 445 of file transport.hpp.

◆ setState()

void nfd::face::Transport::setState ( TransportState  newState)
protectedinherited

set transport state

Only the following transitions are valid: UP->DOWN, DOWN->UP, UP/DOWN->CLOSING/FAILED, CLOSING/FAILED->CLOSED

Exceptions
std::runtime_errortransition is invalid.

Definition at line 187 of file transport.cpp.

Member Data Documentation

◆ afterStateChange

signal::Signal<Transport, TransportState, TransportState> nfd::face::Transport::afterStateChange
inherited

signals when transport state changes

Definition at line 243 of file transport.hpp.

◆ m_destAddress

ethernet::Address nfd::face::EthernetTransport::m_destAddress
protected

Definition at line 105 of file ethernet-transport.hpp.

◆ m_interfaceName

std::string nfd::face::EthernetTransport::m_interfaceName
protected

Definition at line 106 of file ethernet-transport.hpp.

◆ m_pcap

PcapHelper nfd::face::EthernetTransport::m_pcap
protected

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

◆ m_socket

boost::asio::posix::stream_descriptor nfd::face::EthernetTransport::m_socket
protected

Definition at line 102 of file ethernet-transport.hpp.

◆ m_srcAddress

ethernet::Address nfd::face::EthernetTransport::m_srcAddress
protected

Definition at line 104 of file ethernet-transport.hpp.

◆ nInBytes

ByteCounter nfd::face::TransportCounters::nInBytes
inherited

total incoming bytes

This counter includes headers imposed by NFD (such as NDNLP), but excludes overhead of underlying protocol (such as IP header). For a datagram-based transport, an incoming packet that cannot be parsed as TLV would not be counted.

Definition at line 78 of file transport.hpp.

◆ nInPackets

PacketCounter nfd::face::TransportCounters::nInPackets
inherited

count of incoming packets

A 'packet' typically means a top-level TLV block. For a datagram-based transport, an incoming packet that cannot be parsed as TLV would not be counted.

Definition at line 62 of file transport.hpp.

◆ nOutBytes

ByteCounter nfd::face::TransportCounters::nOutBytes
inherited

total outgoing bytes

This counter includes headers imposed by NFD (such as NDNLP), but excludes overhead of underlying protocol (such as IP header). This counter is increased only if transport is UP.

Definition at line 86 of file transport.hpp.

◆ nOutPackets

PacketCounter nfd::face::TransportCounters::nOutPackets
inherited

count of outgoing packets

A 'packet' typically means a top-level TLV block. This counter is incremented only if transport is UP.

Definition at line 69 of file transport.hpp.