NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks
API Documentation
nfd::face::WebSocketFactory Class Reference

protocol factory for WebSocket More...

#include <websocket-factory.hpp>

Inheritance diagram for nfd::face::WebSocketFactory:
Collaboration diagram for nfd::face::WebSocketFactory:

Public Member Functions

 WebSocketFactory (const CtorParams &params)
 
void processConfig (OptionalConfigSection configSection, FaceSystem::ConfigContext &context) override
 process face_system.websocket config section More...
 
void createFace (const CreateFaceParams &params, const FaceCreatedCallback &onCreated, const FaceCreationFailedCallback &onFailure) override
 unicast face creation is not supported and will always fail More...
 
shared_ptr< WebSocketChannelcreateChannel (const websocket::Endpoint &localEndpoint)
 Create WebSocket-based channel using websocket::Endpoint. More...
 
std::vector< shared_ptr< const Channel > > getChannels () const override
 
- Public Member Functions inherited from nfd::face::ProtocolFactory
virtual ~ProtocolFactory ()=default
 
const std::set< std::string > & getProvidedSchemes ()
 Get FaceUri schemes accepted by this ProtocolFactory. More...
 

Static Public Member Functions

static const std::string & getId ()
 
- Static Public Member Functions inherited from nfd::face::ProtocolFactory
template<typename PF >
static void registerType (const std::string &id=PF::getId())
 Register a protocol factory type. More...
 
static unique_ptr< ProtocolFactorycreate (const std::string &id, const CtorParams &params)
 Create a protocol factory instance. More...
 
static std::set< std::string > listRegistered ()
 Get registered protocol factory ids. More...
 
static const std::string & getId ()
 Get id for this ProtocolFactory. More...
 

Additional Inherited Members

- Public Types inherited from nfd::face::ProtocolFactory
using CtorParams = ProtocolFactoryCtorParams
 
- Protected Member Functions inherited from nfd::face::ProtocolFactory
 ProtocolFactory (const CtorParams &params)
 
- Static Protected Member Functions inherited from nfd::face::ProtocolFactory
template<typename ChannelMap >
static std::vector< shared_ptr< const Channel > > getChannelsFromMap (const ChannelMap &channelMap)
 
- Protected Attributes inherited from nfd::face::ProtocolFactory
std::set< std::string > providedSchemes
 FaceUri schemes provided by this ProtocolFactory. More...
 
FaceCreatedCallback addFace
 callback when a new face is created More...
 
shared_ptr< ndn::net::NetworkMonitornetmon
 NetworkMonitor for listing available network interfaces and monitoring their changes. More...
 

Detailed Description

protocol factory for WebSocket

Definition at line 37 of file websocket-factory.hpp.

Constructor & Destructor Documentation

nfd::face::WebSocketFactory::WebSocketFactory ( const CtorParams params)
explicit

Definition at line 43 of file websocket-factory.cpp.

Member Function Documentation

const std::string & nfd::face::WebSocketFactory::getId ( )
static

Definition at line 37 of file websocket-factory.cpp.

void nfd::face::WebSocketFactory::processConfig ( OptionalConfigSection  configSection,
FaceSystem::ConfigContext context 
)
overridevirtual
void nfd::face::WebSocketFactory::createFace ( const CreateFaceParams params,
const FaceCreatedCallback onCreated,
const FaceCreationFailedCallback onFailure 
)
overridevirtual

unicast face creation is not supported and will always fail

Implements nfd::face::ProtocolFactory.

Definition at line 121 of file websocket-factory.cpp.

shared_ptr< WebSocketChannel > nfd::face::WebSocketFactory::createChannel ( const websocket::Endpoint localEndpoint)

Create WebSocket-based channel using websocket::Endpoint.

websocket::Endpoint is really an alias for boost::asio::ip::tcp::endpoint.

If this method called twice with the same endpoint, only one channel will be created. The second call will just retrieve the existing channel.

Returns
always a valid pointer to a WebSocketChannel object, an exception is thrown if it cannot be created.

Definition at line 129 of file websocket-factory.cpp.

Referenced by processConfig().

std::vector< shared_ptr< const Channel > > nfd::face::WebSocketFactory::getChannels ( ) const
overridevirtual

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