Implements Transport for stream-based protocols. More...

#include <stream-transport.hpp>

Inheritance diagram for nfd::face::StreamTransport< Protocol >:

[legend]

Collaboration diagram for nfd::face::StreamTransport< Protocol >:

[legend]

Public Types
typedef Protocol	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 Member Functions
	StreamTransport (typename protocol::socket &&socket)
	Construct stream transport. More...

ssize_t	getSendQueueLength () override

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 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 (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
void	doClose () override
	performs Transport specific operations to close the transport More...

void	deferredClose ()

void	doSend (Transport::Packet &&packet) override
	performs Transport specific operations to send a packet More...

void	sendFromQueue ()

void	handleSend (const boost::system::error_code &error, size_t nBytesSent)

void	startReceive ()

void	handleReceive (const boost::system::error_code &error, size_t nBytesReceived)

void	processErrorCode (const boost::system::error_code &error)

virtual void	handleError (const boost::system::error_code &error)

void	resetReceiveBuffer ()

void	resetSendQueue ()

size_t	getSendQueueBytes () const

	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)

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
protocol::socket	m_socket

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 Attributes inherited from nfd::face::Transport
signal::Signal< Transport, TransportState, TransportState >	afterStateChange
	signals when transport state changes More...

Detailed Description

template<class Protocol>
class nfd::face::StreamTransport< Protocol >

Implements Transport for stream-based protocols.

Template Parameters

Protocol a stream-based protocol in Boost.Asio

Definition at line 43 of file stream-transport.hpp.

Member Typedef Documentation

◆ protocol

template<class Protocol>

typedef Protocol nfd::face::StreamTransport< Protocol >::protocol

Definition at line 46 of file stream-transport.hpp.

Constructor & Destructor Documentation

◆ StreamTransport()

template<class Protocol>

nfd::face::StreamTransport< T >::StreamTransport ( typename protocol::socket && socket )

explicit

Construct stream transport.

Parameters

socket Protocol-specific socket for the created transport

Definition at line 111 of file stream-transport.hpp.

Member Function Documentation

◆ getSendQueueLength()

template<class T >

ssize_t nfd::face::StreamTransport< T >::getSendQueueLength ( )

overridevirtual

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 from nfd::face::Transport.

Definition at line 125 of file stream-transport.hpp.

◆ doClose()

template<class T >

void nfd::face::StreamTransport< T >::doClose ( )

overrideprotectedvirtual

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 136 of file stream-transport.hpp.

Referenced by nfd::face::TcpTransport::doClose().

◆ deferredClose()

template<class T >

void nfd::face::StreamTransport< T >::deferredClose ( )

protected

Definition at line 168 of file stream-transport.hpp.

◆ doSend()

template<class T >

void nfd::face::StreamTransport< T >::doSend ( Transport::Packet && packet )

overrideprotectedvirtual

performs Transport specific operations to send a packet

Parameters

packet the packet, which must be a well-formed TLV block

Precondition: state is either UP or DOWN

Implements nfd::face::Transport.

Definition at line 183 of file stream-transport.hpp.

◆ sendFromQueue()

template<class T >

void nfd::face::StreamTransport< T >::sendFromQueue ( )

protected

Definition at line 200 of file stream-transport.hpp.

◆ handleSend()

template<class T >

void nfd::face::StreamTransport< T >::handleSend	(	const boost::system::error_code &	error,
		size_t	nBytesSent
	)

protected

Definition at line 210 of file stream-transport.hpp.

◆ startReceive()

template<class T >

void nfd::face::StreamTransport< T >::startReceive ( )

protected

Definition at line 229 of file stream-transport.hpp.

◆ handleReceive()

template<class T >

void nfd::face::StreamTransport< T >::handleReceive	(	const boost::system::error_code &	error,
		size_t	nBytesReceived
	)

protected

Definition at line 242 of file stream-transport.hpp.

◆ processErrorCode()

template<class T >

void nfd::face::StreamTransport< T >::processErrorCode ( const boost::system::error_code & error )

protected

Definition at line 287 of file stream-transport.hpp.

◆ handleError()

template<class T >

void nfd::face::StreamTransport< T >::handleError ( const boost::system::error_code & error )

protectedvirtual

Reimplemented in nfd::face::TcpTransport.

Definition at line 304 of file stream-transport.hpp.

Referenced by nfd::face::TcpTransport::handleError().

◆ resetReceiveBuffer()

template<class T >

void nfd::face::StreamTransport< T >::resetReceiveBuffer ( )

protected

Definition at line 318 of file stream-transport.hpp.

◆ resetSendQueue()

template<class T >

void nfd::face::StreamTransport< T >::resetSendQueue ( )

protected

Definition at line 325 of file stream-transport.hpp.

◆ getSendQueueBytes()

template<class T >

size_t nfd::face::StreamTransport< T >::getSendQueueBytes ( ) const

protected

Definition at line 334 of file stream-transport.hpp.

◆ NFD_LOG_INCLASS_DECLARE()

template<class Protocol>

nfd::face::StreamTransport< Protocol >::NFD_LOG_INCLASS_DECLARE ( )

protected

Member Data Documentation

◆ m_socket

template<class Protocol>

protocol::socket nfd::face::StreamTransport< Protocol >::m_socket

protected

Definition at line 98 of file stream-transport.hpp.

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

ndnSIM/NFD/daemon/face/stream-transport.hpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Protocol> class nfd::face::StreamTransport< Protocol >

Member Typedef Documentation

◆ protocol

Constructor & Destructor Documentation

◆ StreamTransport()

Member Function Documentation

◆ getSendQueueLength()

◆ doClose()

◆ deferredClose()

◆ doSend()

◆ sendFromQueue()

◆ handleSend()

◆ startReceive()

◆ handleReceive()

◆ processErrorCode()

◆ handleError()

◆ resetReceiveBuffer()

◆ resetSendQueue()

◆ getSendQueueBytes()

◆ NFD_LOG_INCLASS_DECLARE()

Member Data Documentation

◆ m_socket

template<class Protocol>
class nfd::face::StreamTransport< Protocol >