ndn::Transport Class Reference

provides TLV-block delivery service More...

#include <transport.hpp>

Inheritance diagram for ndn::Transport:

Collaboration diagram for ndn::Transport:

Classes
class	Error

Public Types
typedef function< void()>	ErrorCallback
typedef function< void(const Block &wire)>	ReceiveCallback

Public Member Functions
	Transport ()
virtual	~Transport ()=default
virtual void	close ()=0
	Close the connection. More...
virtual void	connect (boost::asio::io_service &ioService, const ReceiveCallback &receiveCallback)
	asynchronously open the connection More...
bool	isConnected () const
bool	isReceiving () const
virtual void	pause ()=0
	pause the transport More...
virtual void	resume ()=0
	resume the transport More...
virtual void	send (const Block &wire)=0
	send a TLV block through the transport More...
virtual void	send (const Block &header, const Block &payload)=0
	send two memory blocks through the transport More...

Protected Member Functions
void	receive (const Block &wire)
	invoke the receive callback More...

Protected Attributes
boost::asio::io_service *	m_ioService
bool	m_isConnected
bool	m_isReceiving
ReceiveCallback	m_receiveCallback

Detailed Description

provides TLV-block delivery service

Definition at line 35 of file transport.hpp.

Member Typedef Documentation

typedef function<void()> ndn::Transport::ErrorCallback

Definition at line 48 of file transport.hpp.

typedef function<void(const Block& wire)> ndn::Transport::ReceiveCallback

Definition at line 47 of file transport.hpp.

Constructor & Destructor Documentation

ndn::Transport::Transport

(

)

Definition at line 36 of file transport.cpp.

virtual ndn::Transport::~Transport ( )

virtualdefault

Member Function Documentation

virtual void ndn::Transport::close ( )

pure virtual

Close the connection.

Implemented in ndn::TcpTransport, and ndn::UnixTransport.

void ndn::Transport::connect ( boost::asio::io_service &  ioService, const ReceiveCallback &  receiveCallback  )

virtual

asynchronously open the connection

Parameters

ioService	io_service to create socket on
receiveCallback	callback function when a TLV block is received; must not be empty

Exceptions

boost::system::system_error

connection cannot be established

Reimplemented in ndn::TcpTransport, and ndn::UnixTransport.

Definition at line 44 of file transport.cpp.

bool ndn::Transport::isConnected ( ) const

inline

Return values

true	connection has been established
false	connection is not yet established or has been closed

Definition at line 123 of file transport.hpp.

bool ndn::Transport::isReceiving ( ) const

inline

Return values

true	incoming packets are expected, receiveCallback will be invoked
false	incoming packets are not expected, receiveCallback will not be invoked

Definition at line 129 of file transport.hpp.

virtual void ndn::Transport::pause ( )

pure virtual

pause the transport

Postcondition

receiveCallback will not be invoked

Note

This operation has no effect if transport has been paused, or when connection is being established.

Implemented in ndn::TcpTransport, and ndn::UnixTransport.

void ndn::Transport::receive ( const Block &  wire )

inlineprotected

invoke the receive callback

Definition at line 135 of file transport.hpp.

virtual void ndn::Transport::resume ( )

pure virtual

resume the transport

Postcondition

receiveCallback will be invoked

Note

This operation has no effect if transport is not paused, or when connection is being established.

Implemented in ndn::TcpTransport, and ndn::UnixTransport.

virtual void ndn::Transport::send ( const Block &  wire )

pure virtual

send a TLV block through the transport

Implemented in ndn::TcpTransport, and ndn::UnixTransport.

virtual void ndn::Transport::send ( const Block &  header, const Block &  payload  )

pure virtual

send two memory blocks through the transport

Scatter/gather API is utilized to send two non-consecutive memory blocks together (as part of the same message in datagram-oriented transports).

Implemented in ndn::TcpTransport, and ndn::UnixTransport.

Member Data Documentation

boost::asio::io_service* ndn::Transport::m_ioService

protected

Definition at line 116 of file transport.hpp.

bool ndn::Transport::m_isConnected

protected

Definition at line 117 of file transport.hpp.

bool ndn::Transport::m_isReceiving

protected

Definition at line 118 of file transport.hpp.

ReceiveCallback ndn::Transport::m_receiveCallback

protected

Definition at line 119 of file transport.hpp.