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
using	ReceiveCallback = std::function< void(const Block &wire)>
using	ErrorCallback = std::function< void()>

Public Member Functions
virtual	~Transport ()=default
virtual void	connect (ReceiveCallback receiveCallback)
	Asynchronously open the connection. More...
virtual void	close ()=0
	Close the connection. 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...
virtual void	pause ()=0
	pause the transport More...
virtual void	resume ()=0
	resume the transport More...
bool	isConnected () const noexcept
bool	isReceiving () const noexcept

Protected Attributes
ReceiveCallback	m_receiveCallback
bool	m_isConnected = false
bool	m_isReceiving = false

Detailed Description

Provides TLV-block delivery service.

Definition at line 35 of file transport.hpp.

Member Typedef Documentation

ReceiveCallback

using ndn::Transport::ReceiveCallback = std::function<void(const Block& wire)>

Definition at line 46 of file transport.hpp.

ErrorCallback

using ndn::Transport::ErrorCallback = std::function<void()>

Definition at line 47 of file transport.hpp.

Constructor & Destructor Documentation

~Transport()

virtual ndn::Transport::~Transport ( )

virtualdefault

Member Function Documentation

connect()

void ndn::Transport::connect ( ReceiveCallback  receiveCallback )

virtual

Asynchronously open the connection.

Parameters

receiveCallback

callback function when a TLV block is received; must not be empty

Exceptions

boost::system::system_error

connection cannot be established

Definition at line 32 of file transport.cpp.

References m_receiveCallback, and nonstd::optional_lite::std11::move().

close()

virtual void ndn::Transport::close ( )

pure virtual

Close the connection.

Implemented in ndn::util::DummyClientFace::Transport, and nfd::face::InternalClientTransport.

send() [1/2]

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

pure virtual

send a TLV block through the transport

Implemented in ndn::util::DummyClientFace::Transport, and nfd::face::InternalClientTransport.

send() [2/2]

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::util::DummyClientFace::Transport, and nfd::face::InternalClientTransport.

pause()

virtual void ndn::Transport::pause ( )

pure virtual

pause the transport

Postcondition

the receive callback will not be invoked

Note

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

Implemented in ndn::util::DummyClientFace::Transport, and nfd::face::InternalClientTransport.

resume()

virtual void ndn::Transport::resume ( )

pure virtual

resume the transport

Postcondition

the receive callback will be invoked

Note

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

Implemented in ndn::util::DummyClientFace::Transport, and nfd::face::InternalClientTransport.

isConnected()

bool ndn::Transport::isConnected ( ) const

inlinenoexcept

Return values

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

Definition at line 97 of file transport.hpp.

References m_isConnected.

isReceiving()

bool ndn::Transport::isReceiving ( ) const

inlinenoexcept

Return values

true	incoming packets are expected, the receive callback will be invoked
false	incoming packets are not expected, the receive callback will not be invoked

Definition at line 106 of file transport.hpp.

References m_isReceiving.

Member Data Documentation

m_receiveCallback

ReceiveCallback ndn::Transport::m_receiveCallback

protected

Definition at line 112 of file transport.hpp.

Referenced by connect(), ndn::util::DummyClientFace::Transport::receive(), and nfd::face::InternalClientTransport::receivePacket().

m_isConnected

bool ndn::Transport::m_isConnected = false

protected

Definition at line 113 of file transport.hpp.

Referenced by isConnected().

m_isReceiving

bool ndn::Transport::m_isReceiving = false

protected

Definition at line 114 of file transport.hpp.

Referenced by isReceiving().

---

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

• ndnSIM/ndn-cxx/ndn-cxx/transport/transport.hpp
• ndnSIM/ndn-cxx/ndn-cxx/transport/transport.cpp