nfd::face::TcpChannel Class Reference

Class implementing TCP-based channel to create faces. More...

#include <daemon/face/tcp-channel.hpp>

+ Inheritance diagram for nfd::face::TcpChannel:
+ Collaboration diagram for nfd::face::TcpChannel:

Public Member Functions

 TcpChannel (const tcp::Endpoint &localEndpoint, bool wantCongestionMarking, DetermineFaceScopeFromAddress determineFaceScope)
 Create TCP channel for the local endpoint. More...
 
void connect (const tcp::Endpoint &remoteEndpoint, const FaceParams &params, const FaceCreatedCallback &onFaceCreated, const FaceCreationFailedCallback &onConnectFailed, time::nanoseconds timeout=8_s)
 Create a face by establishing a TCP connection to remoteEndpoint. More...
 
const FaceUri & getUri () const
 
bool isListening () const override
 Returns whether the channel is listening. More...
 
void listen (const FaceCreatedCallback &onFaceCreated, const FaceCreationFailedCallback &onAcceptFailed, int backlog=boost::asio::ip::tcp::acceptor::max_connections)
 Enable listening on the local endpoint, accept connections, and create faces when remote host makes a connection. More...
 
size_t size () const override
 Returns the number of faces in the channel. More...
 

Protected Member Functions

void setUri (const FaceUri &uri)
 

Detailed Description

Class implementing TCP-based channel to create faces.

Channel can create faces as a response to incoming TCP connections (TcpChannel::listen needs to be called for that to work) or explicitly after using TcpChannel::connect method.

Definition at line 49 of file tcp-channel.hpp.

Constructor & Destructor Documentation

nfd::face::TcpChannel::TcpChannel ( const tcp::Endpoint localEndpoint,
bool  wantCongestionMarking,
DetermineFaceScopeFromAddress  determineFaceScope 
)

Create TCP channel for the local endpoint.

To enable creation faces upon incoming connections, one needs to explicitly call TcpChannel::listen method.

Definition at line 39 of file tcp-channel.cpp.

Member Function Documentation

void nfd::face::TcpChannel::connect ( const tcp::Endpoint remoteEndpoint,
const FaceParams params,
const FaceCreatedCallback onFaceCreated,
const FaceCreationFailedCallback onConnectFailed,
time::nanoseconds  timeout = 8_s 
)

Create a face by establishing a TCP connection to remoteEndpoint.

Definition at line 74 of file tcp-channel.cpp.

const FaceUri& nfd::face::Channel::getUri ( ) const
inlineinherited

Definition at line 48 of file channel.hpp.

bool nfd::face::TcpChannel::isListening ( ) const
inlineoverridevirtual

Returns whether the channel is listening.

Implements nfd::face::Channel.

Definition at line 62 of file tcp-channel.hpp.

void nfd::face::TcpChannel::listen ( const FaceCreatedCallback onFaceCreated,
const FaceCreationFailedCallback onAcceptFailed,
int  backlog = boost::asio::ip::tcp::acceptor::max_connections 
)

Enable listening on the local endpoint, accept connections, and create faces when remote host makes a connection.

Parameters
onFaceCreatedCallback to notify successful creation of the face
onAcceptFailedCallback to notify when channel fails (accept call returns an error)
backlogThe maximum length of the queue of pending incoming connections

Definition at line 52 of file tcp-channel.cpp.

void nfd::face::Channel::setUri ( const FaceUri &  uri)
protectedinherited

Definition at line 35 of file channel.cpp.

size_t nfd::face::TcpChannel::size ( ) const
inlineoverridevirtual

Returns the number of faces in the channel.

Implements nfd::face::Channel.

Definition at line 68 of file tcp-channel.hpp.