NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks 		API Documentation
Public Member Functions | List of all members
nfd::WebSocketChannel Class Reference

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

#include <websocket-channel.hpp>

Inheritance diagram for nfd::WebSocketChannel:
Inheritance graph
[legend]
Collaboration diagram for nfd::WebSocketChannel:
Collaboration graph
[legend]

Public Member Functions

 WebSocketChannel (const websocket::Endpoint &localEndpoint)
 Create WebSocket channel for the local endpoint. More...
 
void listen (const FaceCreatedCallback &onFaceCreated)
 Enable listening on the local endpoint, accept connections, and create faces when remote host makes a connection. More...
 
size_t size () const
 Get number of faces in the channel. More...
 
bool isListening () const
 
- Public Member Functions inherited from nfd::Channel
virtual ~Channel ()
 
const FaceUri & getUri () const
 

Additional Inherited Members

- Protected Member Functions inherited from nfd::Channel
void setUri (const FaceUri &uri)
 

Detailed Description

Class implementing WebSocket-based channel to create faces.

Definition at line 41 of file websocket-channel.hpp.

Constructor & Destructor Documentation

◆ WebSocketChannel()

nfd::WebSocketChannel::WebSocketChannel ( const websocket::Endpoint &  localEndpoint)
explicit

Create WebSocket channel for the local endpoint.

To enable creation of faces upon incoming connections, one needs to explicitly call WebSocketChannel::listen method. The created channel is bound to the localEndpoint.

Definition at line 35 of file websocket-channel.cpp.

References nfd::fw::all, nfd::connectFaceClosedSignal(), nfd::getGlobalIoService(), NFD_LOG_WARN, and nfd::Channel::setUri().

Member Function Documentation

◆ listen()

void nfd::WebSocketChannel::listen ( const FaceCreatedCallback &  onFaceCreated)

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

Parameters
onFaceCreatedCallback to notify successful creation of a face

Definition at line 138 of file websocket-channel.cpp.

References NFD_LOG_WARN.

◆ size()

size_t nfd::WebSocketChannel::size ( ) const

Get number of faces in the channel.

Definition at line 151 of file websocket-channel.cpp.

◆ isListening()

bool nfd::WebSocketChannel::isListening ( ) const
inline

Definition at line 112 of file websocket-channel.hpp.

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