ndn::TcpTransport Class Reference

A transport that uses a TCP socket for communication. More...

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

Inheritance diagram for ndn::TcpTransport:

Collaboration diagram for ndn::TcpTransport:

Public Types
using	ReceiveCallback = std::function< void(const Block &)>
enum class	State {   CLOSED ,   CONNECTING ,   RUNNING ,   PAUSED }

Public Member Functions
	TcpTransport (const std::string &host, const std::string &port="6363")
	~TcpTransport () override
void	close () override
	Close the connection. More...
void	connect (boost::asio::io_context &ioCtx, ReceiveCallback receiveCallback) override
	Asynchronously open the connection. More...
State	getState () const noexcept
	Return the current state of the transport. More...
void	pause () override
	Pause the transport, canceling all pending operations. More...
void	resume () override
	Resume the transport. More...
void	send (const Block &wire) override
	Send a TLV block through the transport. More...

Static Public Member Functions
static shared_ptr< TcpTransport >	create (const std::string &uri)
	Create transport with parameters defined in URI. More...

Protected Member Functions
void	setState (State state) noexcept

Protected Attributes
boost::asio::io_context *	m_ioCtx = nullptr
ReceiveCallback	m_receiveCallback

Friends
class	detail::StreamTransportImpl< TcpTransport, boost::asio::ip::tcp >

Detailed Description

A transport that uses a TCP socket for communication.

Definition at line 44 of file tcp-transport.hpp.

Member Typedef Documentation

ReceiveCallback

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

inherited

Definition at line 54 of file transport.hpp.

Member Enumeration Documentation

State

enum ndn::Transport::State

stronginherited

Enumerator
CLOSED
CONNECTING
RUNNING
PAUSED

Definition at line 47 of file transport.hpp.

Constructor & Destructor Documentation

TcpTransport()

ndn::TcpTransport::TcpTransport ( const std::string &  host, const std::string &  port = "6363"  )

explicit

Definition at line 33 of file tcp-transport.cpp.

~TcpTransport()

ndn::TcpTransport::~TcpTransport ( )

overridedefault

Member Function Documentation

close()

void ndn::TcpTransport::close ( )

overridevirtual

Close the connection.

Implements ndn::Transport.

Definition at line 100 of file tcp-transport.cpp.

connect()

void ndn::TcpTransport::connect ( boost::asio::io_context &  ioCtx, ReceiveCallback  receiveCallback  )

overridevirtual

Asynchronously open the connection.

Parameters

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

Definition at line 81 of file tcp-transport.cpp.

create()

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

static

Create transport with parameters defined in URI.

Exceptions

Transport::Error

incorrect URI or unsupported protocol is specified

Definition at line 42 of file tcp-transport.cpp.

getState()

State ndn::Transport::getState ( ) const

inlinenoexceptinherited

Return the current state of the transport.

Definition at line 103 of file transport.hpp.

pause()

void ndn::TcpTransport::pause ( )

overridevirtual

Pause the transport, canceling all pending operations.

Postcondition

the receive callback will not be invoked

Note

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

Implements ndn::Transport.

Definition at line 109 of file tcp-transport.cpp.

resume()

void ndn::TcpTransport::resume ( )

overridevirtual

Resume the transport.

Postcondition

the receive callback will be invoked

Note

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

Implements ndn::Transport.

Definition at line 118 of file tcp-transport.cpp.

send()

void ndn::TcpTransport::send ( const Block &  block )

overridevirtual

Send a TLV block through the transport.

Implements ndn::Transport.

Definition at line 93 of file tcp-transport.cpp.

setState()

void ndn::Transport::setState ( State  state )

inlineprotectednoexceptinherited

Definition at line 110 of file transport.hpp.

Friends And Related Function Documentation

detail::StreamTransportImpl< TcpTransport, boost::asio::ip::tcp >

friend class detail::StreamTransportImpl< TcpTransport, boost::asio::ip::tcp >

friend

Definition at line 80 of file tcp-transport.hpp.

Member Data Documentation

m_ioCtx

boost::asio::io_context* ndn::Transport::m_ioCtx = nullptr

protectedinherited

Definition at line 116 of file transport.hpp.

m_receiveCallback

ReceiveCallback ndn::Transport::m_receiveCallback

protectedinherited

Definition at line 117 of file transport.hpp.