NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.0: NDN, CCN, CCNx, content centric networks 		API Documentation
Public Types | Public Member Functions | Protected Attributes | List of all members
ndn::StreamTransportImpl< BaseTransport, Protocol > Class Template Reference

#include <stream-transport.hpp>

Inheritance diagram for ndn::StreamTransportImpl< BaseTransport, Protocol >:
Inheritance graph
[legend]
Collaboration diagram for ndn::StreamTransportImpl< BaseTransport, Protocol >:
Collaboration graph
[legend]

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 connectHandler (const boost::system::error_code &error)
 
void connectTimeoutHandler (const boost::system::error_code &error)
 
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)
 
void handleAsyncWrite (const boost::system::error_code &error, TransmissionQueue::iterator queueItem)
 
bool processAll (uint8_t *buffer, size_t &offset, size_t nBytesAvailable)
 
void handleAsyncReceive (const boost::system::error_code &error, std::size_t nBytesRecvd)
 

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_connectionInProgress
 
boost::asio::deadline_timer m_connectTimer
 

Detailed Description

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

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

Member Typedef Documentation

§ Impl

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

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

§ BlockSequence

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

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

§ TransmissionQueue

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

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

Constructor & Destructor Documentation

§ StreamTransportImpl()

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

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

Member Function Documentation

§ connectHandler()

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

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

References ndn::StreamTransportImpl< BaseTransport, Protocol >::handleAsyncWrite(), ndn::StreamTransportImpl< BaseTransport, Protocol >::m_connectionInProgress, ndn::StreamTransportImpl< BaseTransport, Protocol >::m_connectTimer, ndn::StreamTransportImpl< BaseTransport, Protocol >::m_socket, 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<class BaseTransport , class Protocol >
void ndn::StreamTransportImpl< BaseTransport, Protocol >::connectTimeoutHandler ( const boost::system::error_code &  error)
inline

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

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

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

§ connect()

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

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

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

§ close()

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

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

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

§ pause()

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

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

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

§ resume()

template<class BaseTransport , class Protocol >
void ndn::StreamTransportImpl< BaseTransport, Protocol >::resume ( )
inline
Warning
Must not be called directly or indirectly from within handleAsyncReceive invocation

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

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

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

§ send() [1/2]

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

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

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

§ send() [2/2]

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

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

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

§ handleAsyncWrite()

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

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

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

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

§ processAll()

template<class BaseTransport , class Protocol >
bool ndn::StreamTransportImpl< BaseTransport, Protocol >::processAll ( uint8_t *  buffer,
size_t &  offset,
size_t  nBytesAvailable 
)
inline

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

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

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

§ handleAsyncReceive()

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

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

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

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

Member Data Documentation

§ m_transport

template<class BaseTransport , class Protocol >
BaseTransport& ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transport
protected

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

Referenced by ndn::StreamTransportImpl< BaseTransport, Protocol >::close(), ndn::StreamTransportImpl< BaseTransport, Protocol >::connectHandler(), ndn::StreamTransportImpl< BaseTransport, Protocol >::connectTimeoutHandler(), ndn::StreamTransportImpl< BaseTransport, Protocol >::handleAsyncReceive(), ndn::StreamTransportImpl< BaseTransport, Protocol >::handleAsyncWrite(), ndn::StreamTransportImpl< BaseTransport, Protocol >::pause(), ndn::StreamTransportImpl< BaseTransport, Protocol >::processAll(), ndn::StreamTransportWithResolverImpl< BaseTransport, Protocol >::resolveHandler(), ndn::StreamTransportImpl< BaseTransport, Protocol >::resume(), and ndn::StreamTransportImpl< BaseTransport, Protocol >::send().

§ m_socket

template<class BaseTransport , class Protocol >
Protocol::socket ndn::StreamTransportImpl< BaseTransport, Protocol >::m_socket
protected

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

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

§ m_inputBuffer

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

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

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

§ m_inputBufferSize

template<class BaseTransport , class Protocol >
size_t ndn::StreamTransportImpl< BaseTransport, Protocol >::m_inputBufferSize
protected

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

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

§ m_transmissionQueue

template<class BaseTransport , class Protocol >
TransmissionQueue ndn::StreamTransportImpl< BaseTransport, Protocol >::m_transmissionQueue
protected

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

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

§ m_connectionInProgress

template<class BaseTransport , class Protocol >
bool ndn::StreamTransportImpl< BaseTransport, Protocol >::m_connectionInProgress
protected

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

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

§ m_connectTimer

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

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

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

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