NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks 		API Documentation
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ndn::Transport Class Referenceabstract

provides TLV-block delivery service More...

#include <transport.hpp>

Inheritance diagram for ndn::Transport:
Inheritance graph
[legend]
Collaboration diagram for ndn::Transport:
Collaboration graph
[legend]

Classes

class  Error
 

Public Types

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

Public Member Functions

 Transport ()
 
virtual ~Transport ()=default
 
virtual void connect (boost::asio::io_service &ioService, const 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
 
bool isReceiving () const
 

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

Member Typedef Documentation

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

Definition at line 52 of file transport.hpp.

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

Definition at line 53 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

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

asynchronously open the connection

Parameters
ioServiceio_service to create socket on
receiveCallbackcallback function when a TLV block is received; must not be empty
Exceptions
boost::system::system_errorconnection cannot be established

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

Definition at line 44 of file transport.cpp.

References m_ioService, and m_receiveCallback.

Referenced by ndn::UnixTransport::connect(), ndn::TcpTransport::connect(), and ndn::util::DummyClientFace::DummyClientFace().

virtual void ndn::Transport::close ( )
pure virtual

Close the connection.

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

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

send a TLV block through the transport

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

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

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

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

bool ndn::Transport::isConnected ( ) const
inline
Return values
trueconnection has been established
falseconnection is not yet established or has been closed

Definition at line 128 of file transport.hpp.

bool ndn::Transport::isReceiving ( ) const
inline
Return values
trueincoming packets are expected, receiveCallback will be invoked
falseincoming packets are not expected, receiveCallback will not be invoked

Definition at line 134 of file transport.hpp.

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

invoke the receive callback

Definition at line 140 of file transport.hpp.

Member Data Documentation

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

Definition at line 121 of file transport.hpp.

Referenced by connect(), and ndn::util::DummyClientFace::Transport::getIoService().

bool ndn::Transport::m_isConnected
protected

Definition at line 122 of file transport.hpp.

bool ndn::Transport::m_isReceiving
protected

Definition at line 123 of file transport.hpp.

ReceiveCallback ndn::Transport::m_receiveCallback
protected

Definition at line 124 of file transport.hpp.

Referenced by connect(), and ndn::util::DummyClientFace::Transport::receive().

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