implementation detail of a Boost.Asio-based stream-oriented transport More...

#include <stream-transport-impl.hpp>

Inheritance diagram for ndn::StreamTransportImpl< BaseTransport, Protocol >:

Collaboration diagram for ndn::StreamTransportImpl< BaseTransport, Protocol >:

Public Types
typedef StreamTransportImpl< BaseTransport, Protocol >	Impl

typedef std::list< Block >	BlockSequence

typedef std::list< BlockSequence >	TransmissionQueue

Public Member Functions
	StreamTransportImpl (BaseTransport &transport, boost::asio::io_service &ioService)

void	connect (const typename Protocol::endpoint &endpoint)

void	close ()

void	pause ()

void	resume ()

void	send (const Block &wire)

void	send (const Block &header, const Block &payload)

Protected Member Functions
void	connectHandler (const boost::system::error_code &error)

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

void	send (BlockSequence &&sequence)

void	asyncWrite ()

void	handleAsyncWrite (const boost::system::error_code &error, TransmissionQueue::iterator queueItem)

void	asyncReceive ()

void	handleAsyncReceive (const boost::system::error_code &error, std::size_t nBytesRecvd)

bool	processAllReceived (uint8_t *buffer, size_t &offset, size_t nBytesAvailable)

Protected Attributes
BaseTransport &	m_transport

Protocol::socket	m_socket

uint8_t	m_inputBuffer [MAX_NDN_PACKET_SIZE]

size_t	m_inputBufferSize

TransmissionQueue	m_transmissionQueue

bool	m_isConnecting

boost::asio::deadline_timer	m_connectTimer

Detailed Description

template<typename BaseTransport, typename Protocol>
class ndn::StreamTransportImpl< BaseTransport, Protocol >

implementation detail of a Boost.Asio-based stream-oriented transport

Template Parameters

BaseTransport	a subclass of Transport
Protocol	a Boost.Asio stream-oriented protocol, including boost::asio::ip::tcp and boost::asio::local::stream_protocol

Definition at line 40 of file stream-transport-impl.hpp.

Member Typedef Documentation

◆ Impl

template<typename BaseTransport , typename Protocol >

typedef StreamTransportImpl<BaseTransport, Protocol> ndn::StreamTransportImpl< BaseTransport, Protocol >::Impl

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

◆ BlockSequence

template<typename BaseTransport , typename Protocol >

typedef std::list<Block> ndn::StreamTransportImpl< BaseTransport, Protocol >::BlockSequence

Definition at line 44 of file stream-transport-impl.hpp.

◆ TransmissionQueue

template<typename BaseTransport , typename Protocol >

typedef std::list<BlockSequence> ndn::StreamTransportImpl< BaseTransport, Protocol >::TransmissionQueue

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

Constructor & Destructor Documentation

◆ StreamTransportImpl()

template<typename BaseTransport , typename Protocol >

ndn::StreamTransportImpl< BaseTransport, Protocol >::StreamTransportImpl	(	BaseTransport &	transport,
		boost::asio::io_service &	ioService
	)

inline

Definition at line 47 of file stream-transport-impl.hpp.

Member Function Documentation

◆ connect()

template<typename BaseTransport , typename Protocol >

void ndn::StreamTransportImpl< BaseTransport, Protocol >::connect ( const typename Protocol::endpoint & endpoint )

inline

Definition at line 57 of file stream-transport-impl.hpp.

References ndn::StreamTransportImpl< BaseTransport, Protocol >::connectHandler(), ndn::StreamTransportImpl< BaseTransport, Protocol >::connectTimeoutHandler(), ndn::StreamTransportImpl< BaseTransport, Protocol >::m_connectTimer, ndn::StreamTransportImpl< BaseTransport, Protocol >::m_isConnecting, and ndn::StreamTransportImpl< BaseTransport, Protocol >::m_socket.

◆ close()

template<typename BaseTransport , typename Protocol >

void ndn::StreamTransportImpl< BaseTransport, Protocol >::close ( )

inline

Definition at line 73 of file stream-transport-impl.hpp.

References ndn::StreamTransportImpl< BaseTransport, Protocol >::m_connectTimer, ndn::StreamTransportImpl< BaseTransport, Protocol >::m_isConnecting, ndn::StreamTransportImpl< BaseTransport, Protocol >::m_socket, ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transmissionQueue, and ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transport.

◆ pause()

template<typename BaseTransport , typename Protocol >

void ndn::StreamTransportImpl< BaseTransport, Protocol >::pause ( )

inline

Definition at line 88 of file stream-transport-impl.hpp.

References ndn::StreamTransportImpl< BaseTransport, Protocol >::m_isConnecting, ndn::StreamTransportImpl< BaseTransport, Protocol >::m_socket, and ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transport.

◆ resume()

template<typename BaseTransport , typename Protocol >

void ndn::StreamTransportImpl< BaseTransport, Protocol >::resume ( )

inline

Definition at line 100 of file stream-transport-impl.hpp.

References ndn::StreamTransportImpl< BaseTransport, Protocol >::asyncReceive(), ndn::StreamTransportImpl< BaseTransport, Protocol >::m_inputBufferSize, ndn::StreamTransportImpl< BaseTransport, Protocol >::m_isConnecting, and ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transport.

Referenced by ndn::StreamTransportImpl< BaseTransport, Protocol >::connectHandler().

◆ send() [1/3]

template<typename BaseTransport , typename Protocol >

void ndn::StreamTransportImpl< BaseTransport, Protocol >::send ( const Block & wire )

inline

Definition at line 113 of file stream-transport-impl.hpp.

Referenced by ndn::StreamTransportImpl< BaseTransport, Protocol >::send().

◆ send() [2/3]

template<typename BaseTransport , typename Protocol >

void ndn::StreamTransportImpl< BaseTransport, Protocol >::send	(	const Block &	header,
		const Block &	payload
	)

inline

Definition at line 121 of file stream-transport-impl.hpp.

References ndn::StreamTransportImpl< BaseTransport, Protocol >::send().

◆ connectHandler()

template<typename BaseTransport , typename Protocol >

void ndn::StreamTransportImpl< BaseTransport, Protocol >::connectHandler ( const boost::system::error_code & error )

inlineprotected

Definition at line 131 of file stream-transport-impl.hpp.

References ndn::StreamTransportImpl< BaseTransport, Protocol >::asyncWrite(), ndn::StreamTransportImpl< BaseTransport, Protocol >::m_connectTimer, ndn::StreamTransportImpl< BaseTransport, Protocol >::m_isConnecting, ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transmissionQueue, ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transport, and ndn::StreamTransportImpl< BaseTransport, Protocol >::resume().

Referenced by ndn::StreamTransportImpl< BaseTransport, Protocol >::connect(), and ndn::StreamTransportWithResolverImpl< BaseTransport, Protocol >::resolveHandler().

◆ connectTimeoutHandler()

template<typename BaseTransport , typename Protocol >

void ndn::StreamTransportImpl< BaseTransport, Protocol >::connectTimeoutHandler ( const boost::system::error_code & error )

inlineprotected

Definition at line 152 of file stream-transport-impl.hpp.

References ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transport.

Referenced by ndn::StreamTransportWithResolverImpl< BaseTransport, Protocol >::connect(), and ndn::StreamTransportImpl< BaseTransport, Protocol >::connect().

◆ send() [3/3]

template<typename BaseTransport , typename Protocol >

void ndn::StreamTransportImpl< BaseTransport, Protocol >::send ( BlockSequence && sequence )

inlineprotected

Definition at line 162 of file stream-transport-impl.hpp.

References ndn::StreamTransportImpl< BaseTransport, Protocol >::asyncWrite(), ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transmissionQueue, and ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transport.

◆ asyncWrite()

template<typename BaseTransport , typename Protocol >

void ndn::StreamTransportImpl< BaseTransport, Protocol >::asyncWrite ( )

inlineprotected

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

References ndn::StreamTransportImpl< BaseTransport, Protocol >::handleAsyncWrite(), ndn::StreamTransportImpl< BaseTransport, Protocol >::m_socket, and ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transmissionQueue.

Referenced by ndn::StreamTransportImpl< BaseTransport, Protocol >::connectHandler(), ndn::StreamTransportImpl< BaseTransport, Protocol >::handleAsyncWrite(), and ndn::StreamTransportImpl< BaseTransport, Protocol >::send().

◆ handleAsyncWrite()

template<typename BaseTransport , typename Protocol >

void ndn::StreamTransportImpl< BaseTransport, Protocol >::handleAsyncWrite	(	const boost::system::error_code &	error,
		TransmissionQueue::iterator	queueItem
	)

inlineprotected

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

References ndn::StreamTransportImpl< BaseTransport, Protocol >::asyncWrite(), ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transmissionQueue, and ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transport.

Referenced by ndn::StreamTransportImpl< BaseTransport, Protocol >::asyncWrite().

◆ asyncReceive()

template<typename BaseTransport , typename Protocol >

void ndn::StreamTransportImpl< BaseTransport, Protocol >::asyncReceive ( )

inlineprotected

Definition at line 207 of file stream-transport-impl.hpp.

References ndn::StreamTransportImpl< BaseTransport, Protocol >::handleAsyncReceive(), ndn::StreamTransportImpl< BaseTransport, Protocol >::m_inputBuffer, ndn::StreamTransportImpl< BaseTransport, Protocol >::m_inputBufferSize, ndn::StreamTransportImpl< BaseTransport, Protocol >::m_socket, and ndn::MAX_NDN_PACKET_SIZE.

Referenced by ndn::StreamTransportImpl< BaseTransport, Protocol >::handleAsyncReceive(), and ndn::StreamTransportImpl< BaseTransport, Protocol >::resume().

◆ handleAsyncReceive()

template<typename BaseTransport , typename Protocol >

void ndn::StreamTransportImpl< BaseTransport, Protocol >::handleAsyncReceive	(	const boost::system::error_code &	error,
		std::size_t	nBytesRecvd
	)

inlineprotected

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

References ndn::StreamTransportImpl< BaseTransport, Protocol >::asyncReceive(), ndn::StreamTransportImpl< BaseTransport, Protocol >::m_inputBuffer, ndn::StreamTransportImpl< BaseTransport, Protocol >::m_inputBufferSize, ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transport, ndn::MAX_NDN_PACKET_SIZE, and ndn::StreamTransportImpl< BaseTransport, Protocol >::processAllReceived().

Referenced by ndn::StreamTransportImpl< BaseTransport, Protocol >::asyncReceive().

◆ processAllReceived()

template<typename BaseTransport , typename Protocol >

bool ndn::StreamTransportImpl< BaseTransport, Protocol >::processAllReceived	(	uint8_t *	buffer,
		size_t &	offset,
		size_t	nBytesAvailable
	)

inlineprotected

Definition at line 253 of file stream-transport-impl.hpp.

References ndn::Block::fromBuffer(), ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transport, and ndn::Block::size().

Referenced by ndn::StreamTransportImpl< BaseTransport, Protocol >::handleAsyncReceive().

Member Data Documentation

◆ m_transport

template<typename BaseTransport , typename Protocol >

BaseTransport& ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transport

protected

Definition at line 269 of file stream-transport-impl.hpp.

◆ m_socket

template<typename BaseTransport , typename Protocol >

Protocol::socket ndn::StreamTransportImpl< BaseTransport, Protocol >::m_socket

protected

Definition at line 271 of file stream-transport-impl.hpp.

Referenced by ndn::StreamTransportImpl< BaseTransport, Protocol >::asyncReceive(), ndn::StreamTransportImpl< BaseTransport, Protocol >::asyncWrite(), ndn::StreamTransportImpl< BaseTransport, Protocol >::close(), ndn::StreamTransportWithResolverImpl< BaseTransport, Protocol >::connect(), ndn::StreamTransportImpl< BaseTransport, Protocol >::connect(), ndn::StreamTransportImpl< BaseTransport, Protocol >::pause(), and ndn::StreamTransportWithResolverImpl< BaseTransport, Protocol >::resolveHandler().

◆ m_inputBuffer

template<typename BaseTransport , typename Protocol >

uint8_t ndn::StreamTransportImpl< BaseTransport, Protocol >::m_inputBuffer[MAX_NDN_PACKET_SIZE]

protected

Definition at line 272 of file stream-transport-impl.hpp.

Referenced by ndn::StreamTransportImpl< BaseTransport, Protocol >::asyncReceive(), and ndn::StreamTransportImpl< BaseTransport, Protocol >::handleAsyncReceive().

◆ m_inputBufferSize

template<typename BaseTransport , typename Protocol >

size_t ndn::StreamTransportImpl< BaseTransport, Protocol >::m_inputBufferSize

protected

Definition at line 273 of file stream-transport-impl.hpp.

Referenced by ndn::StreamTransportImpl< BaseTransport, Protocol >::asyncReceive(), ndn::StreamTransportImpl< BaseTransport, Protocol >::handleAsyncReceive(), and ndn::StreamTransportImpl< BaseTransport, Protocol >::resume().

◆ m_transmissionQueue

template<typename BaseTransport , typename Protocol >

TransmissionQueue ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transmissionQueue

protected

Definition at line 275 of file stream-transport-impl.hpp.

Referenced by ndn::StreamTransportImpl< BaseTransport, Protocol >::asyncWrite(), ndn::StreamTransportImpl< BaseTransport, Protocol >::close(), ndn::StreamTransportImpl< BaseTransport, Protocol >::connectHandler(), ndn::StreamTransportImpl< BaseTransport, Protocol >::handleAsyncWrite(), and ndn::StreamTransportImpl< BaseTransport, Protocol >::send().

◆ m_isConnecting

template<typename BaseTransport , typename Protocol >

bool ndn::StreamTransportImpl< BaseTransport, Protocol >::m_isConnecting

protected

Definition at line 276 of file stream-transport-impl.hpp.

Referenced by ndn::StreamTransportImpl< BaseTransport, Protocol >::close(), ndn::StreamTransportWithResolverImpl< BaseTransport, Protocol >::connect(), ndn::StreamTransportImpl< BaseTransport, Protocol >::connect(), ndn::StreamTransportImpl< BaseTransport, Protocol >::connectHandler(), ndn::StreamTransportImpl< BaseTransport, Protocol >::pause(), and ndn::StreamTransportImpl< BaseTransport, Protocol >::resume().

◆ m_connectTimer

template<typename BaseTransport , typename Protocol >

boost::asio::deadline_timer ndn::StreamTransportImpl< BaseTransport, Protocol >::m_connectTimer

protected

Definition at line 278 of file stream-transport-impl.hpp.

Referenced by ndn::StreamTransportImpl< BaseTransport, Protocol >::close(), ndn::StreamTransportWithResolverImpl< BaseTransport, Protocol >::connect(), ndn::StreamTransportImpl< BaseTransport, Protocol >::connect(), and ndn::StreamTransportImpl< BaseTransport, Protocol >::connectHandler().

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

ndnSIM/ndn-cxx/src/transport/stream-transport-impl.hpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<typename BaseTransport, typename Protocol> class ndn::StreamTransportImpl< BaseTransport, Protocol >

Member Typedef Documentation

◆ Impl

◆ BlockSequence

◆ TransmissionQueue

Constructor & Destructor Documentation

◆ StreamTransportImpl()

Member Function Documentation

◆ connect()

◆ close()

◆ pause()

◆ resume()

◆ send() [1/3]

◆ send() [2/3]

◆ connectHandler()

◆ connectTimeoutHandler()

◆ send() [3/3]

◆ asyncWrite()

◆ handleAsyncWrite()

◆ asyncReceive()

◆ handleAsyncReceive()

◆ processAllReceived()

Member Data Documentation

◆ m_transport

◆ m_socket

◆ m_inputBuffer

◆ m_inputBufferSize

◆ m_transmissionQueue

◆ m_isConnecting

◆ m_connectTimer

template<typename BaseTransport, typename Protocol>
class ndn::StreamTransportImpl< BaseTransport, Protocol >