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

#include <ethernet-transport.hpp>

Inheritance diagram for nfd::face::EthernetTransport:

[legend]

Collaboration diagram for nfd::face::EthernetTransport:

[legend]

Classes
class	Error

Public Member Functions
void	receivePayload (const uint8_t *payload, size_t length, const ethernet::Address &sender)
	Processes the payload of an incoming frame. More...

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 Face *	getFace () const

const LinkService *	getLinkService () const

LinkService *	getLinkService ()

virtual const Counters &	getCounters () 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
	EthernetTransport (const ndn::net::NetworkInterface &localEndpoint, const ethernet::Address &remoteEndpoint)

void	doClose () final
	performs Transport specific operations to close the transport More...

bool	hasRecentlyReceived () const

void	resetRecentlyReceived ()

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

Protected Attributes
boost::asio::posix::stream_descriptor	m_socket

PcapHelper	m_pcap

ethernet::Address	m_srcAddress

ethernet::Address	m_destAddress

std::string	m_interfaceName

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 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, TransportState >	afterStateChange
	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...

Detailed Description

Base class for Ethernet-based Transports.

Definition at line 41 of file ethernet-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.

References nfd::face::PcapHelper::activate(), nfd::face::PcapHelper::getFd(), m_pcap, m_socket, NDN_THROW_NESTED, and ndn::net::NetworkInterface::onStateChanged.

Member Function Documentation

◆ 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

payload	Pointer to the first byte of data after the Ethernet header
length	Payload length
sender	Sender address

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

References ndn::ethernet::ADDR_LEN, ndn::Block::fromBuffer(), ndn::ethernet::Address::isMulticast(), m_destAddress, NFD_LOG_FACE_TRACE, NFD_LOG_FACE_WARN, and nfd::face::Transport::receive().

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

References nfd::face::PcapHelper::close(), nfd::face::CLOSED, nfd::getGlobalIoService(), m_pcap, m_socket, NFD_LOG_FACE_TRACE, nfd::detail::SimulatorIo::post(), and nfd::face::Transport::setState().

◆ hasRecentlyReceived()

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

inlineprotected

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

◆ resetRecentlyReceived()

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

inlineprotected

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

Member Data Documentation

◆ m_socket

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

protected

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

Referenced by doClose(), and EthernetTransport().

◆ m_pcap

PcapHelper nfd::face::EthernetTransport::m_pcap

protected

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

Referenced by doClose(), EthernetTransport(), nfd::face::MulticastEthernetTransport::MulticastEthernetTransport(), and nfd::face::UnicastEthernetTransport::UnicastEthernetTransport().

◆ m_srcAddress

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

protected

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

Referenced by nfd::face::MulticastEthernetTransport::MulticastEthernetTransport(), and nfd::face::UnicastEthernetTransport::UnicastEthernetTransport().

◆ m_destAddress

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

protected

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

Referenced by nfd::face::MulticastEthernetTransport::MulticastEthernetTransport(), receivePayload(), and nfd::face::UnicastEthernetTransport::UnicastEthernetTransport().

◆ m_interfaceName

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

protected

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

Referenced by nfd::face::MulticastEthernetTransport::MulticastEthernetTransport(), and nfd::face::UnicastEthernetTransport::UnicastEthernetTransport().

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

ndnSIM/NFD/daemon/face/ethernet-transport.hpp
ndnSIM/NFD/daemon/face/ethernet-transport.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EthernetTransport()

Member Function Documentation

◆ receivePayload()

◆ doClose()

◆ hasRecentlyReceived()

◆ resetRecentlyReceived()

Member Data Documentation

◆ m_socket

◆ m_pcap

◆ m_srcAddress

◆ m_destAddress

◆ m_interfaceName