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

#include <stream-transport.hpp>

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

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

Public Types
typedef Protocol	protocol

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

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

TransportState	getState () const

time::steady_clock::TimePoint	getExpirationTime () const

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

Protected Member Functions
virtual void	doClose () override
	performs Transport specific operations to close the transport More...

void	deferredClose ()

virtual 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 ()

	NFD_LOG_INCLASS_DECLARE ()

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

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

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

Member Typedef Documentation

typedef TransportCounters nfd::face::Transport::Counters

inherited

counters provided by Transport

Definition at line 137 of file transport.hpp.

typedef uint64_t nfd::face::Transport::EndpointId

inherited

identifies an endpoint on the link

Definition at line 109 of file transport.hpp.

template<class Protocol>

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

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

Constructor & Destructor Documentation

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

Member Function Documentation

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

Definition at line 169 of file transport.cpp.

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

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

protectedvirtualinherited

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

Definition at line 145 of file transport.cpp.

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

template<class T >

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

protected

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

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.

Reimplemented in nfd::face::TcpTransport.

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

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

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

inlinevirtualinherited

Reimplemented in nfd::face::WebSocketTransport.

Definition at line 372 of file transport.hpp.

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

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

inlineinherited

Returns: Face to which this Transport is attached

Definition at line 354 of file transport.hpp.

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

inlineinherited

Returns: LinkService to which this Transport is attached

Definition at line 360 of file transport.hpp.

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

inlineinherited

Returns: LinkService to which this Transport is attached

Definition at line 366 of file transport.hpp.

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

inlineinherited

Returns: whether face is point-to-point or multi-access

Definition at line 420 of file transport.hpp.

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

inlineinherited

Returns: a FaceUri representing local endpoint

Definition at line 378 of file transport.hpp.

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

inlineinherited

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

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

inlineinherited

Returns: face persistency setting

Definition at line 414 of file transport.hpp.

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

inlineinherited

Returns: a FaceUri representing remote endpoint

Definition at line 390 of file transport.hpp.

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

inlineinherited

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

Definition at line 402 of file transport.hpp.

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

inlineinherited

Returns: transport state

Definition at line 445 of file transport.hpp.

template<class T >

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

protectedvirtual

Reimplemented in nfd::face::TcpTransport.

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

template<class T >

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

protected

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

template<class T >

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

protected

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

template<class Protocol>

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

protected

template<class T >

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

protected

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

void nfd::face::Transport::receive ( Packet && packet )

protectedinherited

receive a link-layer packet

Warning: undefined behavior if packet size exceeds MTU limit

Definition at line 117 of file transport.cpp.

template<class T >

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

protected

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

template<class T >

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

protected

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

void nfd::face::Transport::send ( Packet && packet )

inherited

send a link-layer packet

Note: This operation has no effect if getState() is neither UP nor DOWN

Warning: undefined behavior if packet size exceeds MTU limit

Definition at line 97 of file transport.cpp.

template<class T >

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

protected

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

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

inlineprotectedinherited

Definition at line 457 of file transport.hpp.

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

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

inlineprotectedinherited

Definition at line 426 of file transport.hpp.

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

inlineprotectedinherited

Definition at line 384 of file transport.hpp.

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

inlineprotectedinherited

Definition at line 438 of file transport.hpp.

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

inherited

changes face persistency setting

Definition at line 151 of file transport.cpp.

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

inlineprotectedinherited

Definition at line 396 of file transport.hpp.

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

inlineprotectedinherited

Definition at line 408 of file transport.hpp.

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_error transition is invalid.

Definition at line 174 of file transport.cpp.

template<class T >

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

protected

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

Member Data Documentation

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

inherited

signals when transport state changes

Definition at line 265 of file transport.hpp.

template<class Protocol>

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

protected

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

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

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

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

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

NFD - Named Data Networking Forwarding Daemon 0.5.1 documentation

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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