The lower half of a Face. More...

#include <transport.hpp>

Inheritance diagram for nfd::face::Transport:

[legend]

Collaboration diagram for nfd::face::Transport:

[legend]

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

Public Member Functions
	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)
	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 ()

Public Attributes
signal::Signal< Transport, TransportState, TransportState >	afterStateChange
	signals when transport state changes More...

Protected Member Functions
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...

virtual void	doClose ()=0
	performs Transport specific operations to close the transport More...

Additional Inherited Members
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

The lower half of a Face.

See also: Face

Definition at line 108 of file transport.hpp.

Member Typedef Documentation

◆ Counters

using nfd::face::Transport::Counters = TransportCounters

Counters provided by a transport.

See also: TransportCounters

Definition at line 114 of file transport.hpp.

Constructor & Destructor Documentation

◆ Transport()

nfd::face::Transport::Transport ( )

Default constructor.

This constructor initializes static properties to invalid values. Subclass constructor must explicitly set every static property.

This constructor initializes TransportState to UP; subclass constructor can rely on this default value.

Definition at line 53 of file transport.cpp.

References nfd::face::UP, and ~Transport().

◆ ~Transport()

nfd::face::Transport::~Transport ( )

virtualdefault

Referenced by Transport().

Member Function Documentation

◆ setFaceAndLinkService()

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

set Face and LinkService for Transport

Precondition: setFaceAndLinkService has not been called

Definition at line 69 of file transport.cpp.

◆ getFace()

const Face * nfd::face::Transport::getFace ( ) const

inline

Returns: Face to which this Transport is attached

Definition at line 355 of file transport.hpp.

Referenced by nfd::face::operator<<().

◆ getLinkService() [1/2]

const LinkService * nfd::face::Transport::getLinkService ( ) const

inline

Returns: LinkService to which this Transport is attached

Definition at line 361 of file transport.hpp.

◆ getLinkService() [2/2]

LinkService * nfd::face::Transport::getLinkService ( )

inline

Returns: LinkService to which this Transport is attached

Definition at line 367 of file transport.hpp.

◆ getCounters()

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

inlinevirtual

Reimplemented in nfd::face::NFD_FINAL_UNLESS_WITH_TESTS, nfd::face::NFD_FINAL_UNLESS_WITH_TESTS, and nfd::face::WebSocketTransport.

Definition at line 373 of file transport.hpp.

◆ close()

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

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.

References nfd::face::CLOSING, doClose(), nfd::face::DOWN, setState(), and nfd::face::UP.

Referenced by nfd::face::UnicastUdpTransport::afterChangePersistency(), and nfd::face::UnicastEthernetTransport::afterChangePersistency().

◆ send()

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

Send a link-layer packet.

Parameters

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

References nfd::face::DOWN, getMtu(), getState(), ndn::Block::isValid(), nfd::face::MTU_UNLIMITED, NFD_LOG_FACE_TRACE, nfd::face::TransportCounters::nOutBytes, nfd::face::TransportCounters::nOutPackets, ndn::Block::size(), and nfd::face::UP.

◆ getLocalUri()

FaceUri nfd::face::Transport::getLocalUri ( ) const

inline

Returns: a FaceUri representing local endpoint

Definition at line 379 of file transport.hpp.

Referenced by ns3::ndn::NetDeviceTransport::getSendQueueLength(), ns3::ndn::NetDeviceTransport::NetDeviceTransport(), and nfd::face::operator<<().

◆ getRemoteUri()

FaceUri nfd::face::Transport::getRemoteUri ( ) const

inline

Returns: a FaceUri representing remote endpoint

Definition at line 391 of file transport.hpp.

Referenced by nfd::face::operator<<().

◆ getScope()

ndn::nfd::FaceScope nfd::face::Transport::getScope ( ) const

inline

Returns: whether face is local or non-local for scope control purpose

Definition at line 403 of file transport.hpp.

◆ getPersistency()

ndn::nfd::FacePersistency nfd::face::Transport::getPersistency ( ) const

inline

Returns: face persistency setting

Definition at line 415 of file transport.hpp.

Referenced by nfd::face::UnicastUdpTransport::afterChangePersistency(), nfd::face::UnicastEthernetTransport::afterChangePersistency(), nfd::face::EthernetTransport::receivePayload(), nfd::face::UnicastEthernetTransport::UnicastEthernetTransport(), and nfd::face::UnicastUdpTransport::UnicastUdpTransport().

◆ canChangePersistencyTo()

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

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.

References canChangePersistencyToImpl(), ndn::nfd::FACE_PERSISTENCY_NONE, and NFD_LOG_FACE_TRACE.

Referenced by setPersistency().

◆ setPersistency()

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

changes face persistency setting

Definition at line 164 of file transport.cpp.

References afterChangePersistency(), canChangePersistencyTo(), ndn::nfd::FACE_PERSISTENCY_NONE, and NFD_LOG_FACE_INFO.

Referenced by nfd::face::InternalForwarderTransport::InternalForwarderTransport(), nfd::face::MulticastEthernetTransport::MulticastEthernetTransport(), nfd::face::MulticastUdpTransport::MulticastUdpTransport(), ns3::ndn::NetDeviceTransport::NetDeviceTransport(), ns3::ndn::NullTransport::NullTransport(), nfd::face::UnicastEthernetTransport::UnicastEthernetTransport(), nfd::face::UnicastUdpTransport::UnicastUdpTransport(), nfd::face::UnixStreamTransport::UnixStreamTransport(), and nfd::face::WebSocketTransport::WebSocketTransport().

◆ getLinkType()

ndn::nfd::LinkType nfd::face::Transport::getLinkType ( ) const

inline

Returns: the link type of the transport

Definition at line 421 of file transport.hpp.

◆ getMtu()

ssize_t nfd::face::Transport::getMtu ( ) const

inline

Returns: maximum payload size

Return values

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

Referenced by receive(), and send().

◆ getSendQueueCapacity()

ssize_t nfd::face::Transport::getSendQueueCapacity ( ) const

inline

Returns: capacity of the send queue (in bytes)

Return values

QUEUE_UNSUPPORTED	transport does not support queue capacity retrieval
QUEUE_ERROR	transport was unable to retrieve the queue capacity

Definition at line 439 of file transport.hpp.

◆ getState()

TransportState nfd::face::Transport::getState ( ) const

inline

Returns: transport state

Definition at line 451 of file transport.hpp.

Referenced by nfd::face::EthernetTransport::doClose(), nfd::face::WebSocketTransport::handlePongTimeout(), and send().

◆ getExpirationTime()

time::steady_clock::TimePoint nfd::face::Transport::getExpirationTime ( ) const

inline

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.

◆ getSendQueueLength()

virtual ssize_t nfd::face::Transport::getSendQueueLength ( )

inlinevirtual

Returns: current send queue length of the transport (in octets)

Return values

QUEUE_UNSUPPORTED	transport does not support queue length retrieval
QUEUE_ERROR	transport 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 >, ns3::ndn::NetDeviceTransport, nfd::face::StreamTransport< Protocol >, nfd::face::StreamTransport< boost::asio::ip::tcp >, nfd::face::StreamTransport< boost::asio::local::stream_protocol >, and nfd::face::NFD_FINAL_UNLESS_WITH_TESTS.

Definition at line 256 of file transport.hpp.

References Face, and nfd::face::QUEUE_UNSUPPORTED.

◆ receive()

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

protected

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

Parameters

packet	the received packet, must be a valid and well-formed TLV block
endpoint	the source endpoint

Warning: Behavior is undefined if packet size exceeds the MTU limit

Definition at line 113 of file transport.cpp.

References getMtu(), ndn::Block::isValid(), nfd::face::MTU_UNLIMITED, nfd::face::TransportCounters::nInBytes, nfd::face::TransportCounters::nInPackets, nfd::face::LinkService::receivePacket(), and ndn::Block::size().

Referenced by ns3::ndn::NetDeviceTransport::getSendQueueLength(), nfd::face::WebSocketTransport::receiveMessage(), nfd::face::InternalForwarderTransport::receivePacket(), and nfd::face::EthernetTransport::receivePayload().

◆ setLocalUri()

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

inlineprotected

Definition at line 385 of file transport.hpp.

Referenced by nfd::face::InternalForwarderTransport::InternalForwarderTransport(), nfd::face::MulticastEthernetTransport::MulticastEthernetTransport(), nfd::face::MulticastUdpTransport::MulticastUdpTransport(), ns3::ndn::NetDeviceTransport::NetDeviceTransport(), ns3::ndn::NullTransport::NullTransport(), nfd::face::UnicastEthernetTransport::UnicastEthernetTransport(), nfd::face::UnicastUdpTransport::UnicastUdpTransport(), nfd::face::UnixStreamTransport::UnixStreamTransport(), and nfd::face::WebSocketTransport::WebSocketTransport().

◆ setRemoteUri()

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

inlineprotected

Definition at line 397 of file transport.hpp.

Referenced by nfd::face::InternalForwarderTransport::InternalForwarderTransport(), nfd::face::MulticastEthernetTransport::MulticastEthernetTransport(), nfd::face::MulticastUdpTransport::MulticastUdpTransport(), ns3::ndn::NetDeviceTransport::NetDeviceTransport(), ns3::ndn::NullTransport::NullTransport(), nfd::face::UnicastEthernetTransport::UnicastEthernetTransport(), nfd::face::UnicastUdpTransport::UnicastUdpTransport(), nfd::face::UnixStreamTransport::UnixStreamTransport(), and nfd::face::WebSocketTransport::WebSocketTransport().

◆ setScope()

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

inlineprotected

Definition at line 409 of file transport.hpp.

Referenced by nfd::face::InternalForwarderTransport::InternalForwarderTransport(), nfd::face::MulticastEthernetTransport::MulticastEthernetTransport(), nfd::face::MulticastUdpTransport::MulticastUdpTransport(), ns3::ndn::NetDeviceTransport::NetDeviceTransport(), ns3::ndn::NullTransport::NullTransport(), nfd::face::UnicastEthernetTransport::UnicastEthernetTransport(), nfd::face::UnicastUdpTransport::UnicastUdpTransport(), nfd::face::UnixStreamTransport::UnixStreamTransport(), and nfd::face::WebSocketTransport::WebSocketTransport().

◆ setLinkType()

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

inlineprotected

Definition at line 427 of file transport.hpp.

Referenced by nfd::face::InternalForwarderTransport::InternalForwarderTransport(), nfd::face::MulticastEthernetTransport::MulticastEthernetTransport(), nfd::face::MulticastUdpTransport::MulticastUdpTransport(), ns3::ndn::NetDeviceTransport::NetDeviceTransport(), ns3::ndn::NullTransport::NullTransport(), nfd::face::UnicastEthernetTransport::UnicastEthernetTransport(), nfd::face::UnicastUdpTransport::UnicastUdpTransport(), nfd::face::UnixStreamTransport::UnixStreamTransport(), and nfd::face::WebSocketTransport::WebSocketTransport().

◆ setMtu()

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

protected

Definition at line 126 of file transport.cpp.

References nfd::face::MTU_INVALID, nfd::face::MTU_UNLIMITED, and NFD_LOG_FACE_INFO.

Referenced by nfd::face::EthernetTransport::EthernetTransport(), nfd::face::InternalForwarderTransport::InternalForwarderTransport(), nfd::face::MulticastEthernetTransport::MulticastEthernetTransport(), nfd::face::MulticastUdpTransport::MulticastUdpTransport(), ns3::ndn::NetDeviceTransport::NetDeviceTransport(), nfd::face::UnicastEthernetTransport::UnicastEthernetTransport(), nfd::face::UnicastUdpTransport::UnicastUdpTransport(), nfd::face::UnixStreamTransport::UnixStreamTransport(), and nfd::face::WebSocketTransport::WebSocketTransport().

◆ setSendQueueCapacity()

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

inlineprotected

Definition at line 445 of file transport.hpp.

Referenced by nfd::face::MulticastUdpTransport::MulticastUdpTransport(), and ns3::ndn::NetDeviceTransport::NetDeviceTransport().

◆ setState()

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

protected

set transport state

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

Exceptions

std::runtime_error transition is invalid.

Definition at line 187 of file transport.cpp.

References afterStateChange, nfd::face::CLOSED, nfd::face::CLOSING, nfd::face::DOWN, nfd::face::FAILED, NDN_THROW, NFD_LOG_FACE_INFO, and nfd::face::UP.

Referenced by close(), nfd::face::EthernetTransport::doClose(), nfd::face::InternalForwarderTransport::doClose(), nfd::face::WebSocketTransport::doClose(), ns3::ndn::NetDeviceTransport::getSendQueueLength(), nfd::face::WebSocketTransport::handlePongTimeout(), ns3::ndn::NullTransport::NullTransport(), and nfd::face::EthernetTransport::receivePayload().

◆ setExpirationTime()

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

inlineprotected

Definition at line 463 of file transport.hpp.

Referenced by nfd::face::UnicastUdpTransport::afterChangePersistency(), and nfd::face::UnicastEthernetTransport::afterChangePersistency().

◆ canChangePersistencyToImpl()

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

protectedvirtual

invoked by canChangePersistencyTo to perform the check

Base class implementation returns false.

Parameters

newPersistency the new persistency, guaranteed to be different from current persistency

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

Definition at line 158 of file transport.cpp.

Referenced by canChangePersistencyTo().

◆ afterChangePersistency()

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

protectedvirtual

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

Definition at line 182 of file transport.cpp.

Referenced by setPersistency().

◆ doClose()

virtual void nfd::face::Transport::doClose ( )

protectedpure virtual

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.

Implemented in nfd::face::WebSocketTransport, nfd::face::InternalForwarderTransport, nfd::face::DatagramTransport< Protocol, Addressing >, nfd::face::DatagramTransport< boost::asio::ip::udp, Unicast >, nfd::face::DatagramTransport< boost::asio::ip::udp, Multicast >, nfd::face::EthernetTransport, nfd::face::StreamTransport< Protocol >, nfd::face::StreamTransport< boost::asio::ip::tcp >, nfd::face::StreamTransport< boost::asio::local::stream_protocol >, nfd::face::NFD_FINAL_UNLESS_WITH_TESTS, and nfd::face::NFD_FINAL_UNLESS_WITH_TESTS.

Referenced by close().

Member Data Documentation

◆ afterStateChange

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

signals when transport state changes

Definition at line 243 of file transport.hpp.

Referenced by setState().

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

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

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Counters

Constructor & Destructor Documentation

◆ Transport()

◆ ~Transport()

Member Function Documentation

◆ setFaceAndLinkService()

◆ getFace()

◆ getLinkService() [1/2]

◆ getLinkService() [2/2]

◆ getCounters()

◆ close()

◆ send()

◆ getLocalUri()

◆ getRemoteUri()

◆ getScope()

◆ getPersistency()

◆ canChangePersistencyTo()

◆ setPersistency()

◆ getLinkType()

◆ getMtu()

◆ getSendQueueCapacity()

◆ getState()

◆ getExpirationTime()

◆ getSendQueueLength()

◆ receive()

◆ setLocalUri()

◆ setRemoteUri()

◆ setScope()

◆ setLinkType()

◆ setMtu()

◆ setSendQueueCapacity()

◆ setState()

◆ setExpirationTime()

◆ canChangePersistencyToImpl()

◆ afterChangePersistency()

◆ doClose()

Member Data Documentation

◆ afterStateChange