nfd::face::UnixStreamChannel Class Reference

Class implementing a local channel to create faces. More...

#include <daemon/face/unix-stream-channel.hpp>

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

Classes

class  Error
 UnixStreamChannel-related error. More...
 

Public Member Functions

 UnixStreamChannel (const unix_stream::Endpoint &endpoint, bool wantCongestionMarking)
 Create UnixStream channel for the specified endpoint. More...
 
 ~UnixStreamChannel () override
 
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::local::stream_protocol::acceptor::max_connections)
 Start listening. 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 a local channel to create faces.

Channel can create faces as a response to incoming IPC connections (UnixStreamChannel::listen needs to be called for that to work).

Definition at line 45 of file unix-stream-channel.hpp.

Constructor & Destructor Documentation

nfd::face::UnixStreamChannel::UnixStreamChannel ( const unix_stream::Endpoint endpoint,
bool  wantCongestionMarking 
)

Create UnixStream channel for the specified endpoint.

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

Definition at line 40 of file unix-stream-channel.cpp.

nfd::face::UnixStreamChannel::~UnixStreamChannel ( )
override

Definition at line 52 of file unix-stream-channel.cpp.

Member Function Documentation

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

Definition at line 48 of file channel.hpp.

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

Returns whether the channel is listening.

Implements nfd::face::Channel.

Definition at line 72 of file unix-stream-channel.hpp.

void nfd::face::UnixStreamChannel::listen ( const FaceCreatedCallback onFaceCreated,
const FaceCreationFailedCallback onAcceptFailed,
int  backlog = boost::asio::local::stream_protocol::acceptor::max_connections 
)

Start listening.

Enable listening on the Unix socket, waiting for incoming connections, and creating a face when a connection is made.

Faces created in this way will have on-demand persistency.

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
Exceptions
Error

Definition at line 65 of file unix-stream-channel.cpp.

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

Definition at line 35 of file channel.cpp.

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

Returns the number of faces in the channel.

Implements nfd::face::Channel.

Definition at line 78 of file unix-stream-channel.hpp.