Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ndn::UnixTransport Class Reference

a transport using Unix stream socket More...

#include <ndn-cxx/transport/unix-transport.hpp>

+ Inheritance diagram for ndn::UnixTransport:
+ Collaboration diagram for ndn::UnixTransport:

Public Types

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

Public Member Functions

 UnixTransport (const std::string &unixSocket)
 
 ~UnixTransport () override
 
void close () override
 Close the connection. More...
 
void connect (boost::asio::io_service &ioService, const ReceiveCallback &receiveCallback) override
 asynchronously open the connection More...
 
bool isConnected () const
 
bool isReceiving () const
 
void pause () override
 pause the transport More...
 
void resume () override
 resume the transport More...
 
void send (const Block &wire) override
 send a TLV block through the transport More...
 
void send (const Block &header, const Block &payload) override
 send two memory blocks through the transport More...
 

Static Public Member Functions

static shared_ptr< UnixTransport > create (const std::string &uri)
 Create transport with parameters defined in URI. 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

a transport using Unix stream socket

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

Member Typedef Documentation

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

Definition at line 47 of file transport.hpp.

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

Definition at line 46 of file transport.hpp.

Constructor & Destructor Documentation

ndn::UnixTransport::UnixTransport ( const std::string &  unixSocket)
explicit

Definition at line 34 of file unix-transport.cpp.

ndn::UnixTransport::~UnixTransport ( )
overridedefault

Member Function Documentation

void ndn::UnixTransport::close ( )
overridevirtual

Close the connection.

Implements ndn::Transport.

Definition at line 105 of file unix-transport.cpp.

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

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 from ndn::Transport.

Definition at line 76 of file unix-transport.cpp.

shared_ptr< UnixTransport > ndn::UnixTransport::create ( const std::string &  uri)
static

Create transport with parameters defined in URI.

Exceptions
Transport::Errorincorrect URI or unsupported protocol is specified

Definition at line 70 of file unix-transport.cpp.

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

Definition at line 122 of file transport.hpp.

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

Definition at line 128 of file transport.hpp.

void ndn::UnixTransport::pause ( )
overridevirtual

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.

Implements ndn::Transport.

Definition at line 114 of file unix-transport.cpp.

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

invoke the receive callback

Definition at line 134 of file transport.hpp.

void ndn::UnixTransport::resume ( )
overridevirtual

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.

Implements ndn::Transport.

Definition at line 123 of file unix-transport.cpp.

void ndn::UnixTransport::send ( const Block &  wire)
overridevirtual

send a TLV block through the transport

Implements ndn::Transport.

Definition at line 91 of file unix-transport.cpp.

void ndn::UnixTransport::send ( const Block &  header,
const Block &  payload 
)
overridevirtual

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).

Implements ndn::Transport.

Definition at line 98 of file unix-transport.cpp.

Member Data Documentation

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

Definition at line 115 of file transport.hpp.

bool ndn::Transport::m_isConnected
protectedinherited

Definition at line 116 of file transport.hpp.

bool ndn::Transport::m_isReceiving
protectedinherited

Definition at line 117 of file transport.hpp.

ReceiveCallback ndn::Transport::m_receiveCallback
protectedinherited

Definition at line 118 of file transport.hpp.