nfd::face::WebSocketFactory Class Reference

protocol factory for WebSocket More...

#include <daemon/face/websocket-factory.hpp>

Inheritance diagram for nfd::face::WebSocketFactory:

Collaboration diagram for nfd::face::WebSocketFactory:

Public Types
using	CtorParams = ProtocolFactoryCtorParams

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

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

Static Protected Member Functions
template<typename ChannelMap >
static std::vector< shared_ptr< const Channel > >	getChannelsFromMap (const ChannelMap &channelMap)

Protected Attributes
FaceCreatedCallback	addFace
	callback when a new face is created More...
shared_ptr< ndn::net::NetworkMonitor >	netmon
	NetworkMonitor for listing available network interfaces and monitoring their changes. More...
std::set< std::string >	providedSchemes
	FaceUri schemes provided by this ProtocolFactory. More...

Detailed Description

protocol factory for WebSocket

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

Member Typedef Documentation

using nfd::face::ProtocolFactory::CtorParams = ProtocolFactoryCtorParams

inherited

Definition at line 62 of file protocol-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

unique_ptr< ProtocolFactory > nfd::face::ProtocolFactory::create ( const std::string &  id, const CtorParams &  params  )

staticinherited

Create a protocol factory instance.

Return values

nullptr

if factory with id is not registered

Definition at line 41 of file protocol-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.

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.

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

overridevirtual

Implements nfd::face::ProtocolFactory.

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

template<typename ChannelMap >

static std::vector<shared_ptr<const Channel> > nfd::face::ProtocolFactory::getChannelsFromMap ( const ChannelMap &  channelMap )

inlinestaticprotectedinherited

Definition at line 167 of file protocol-factory.hpp.

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

static

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

const std::set<std::string>& nfd::face::ProtocolFactory::getProvidedSchemes ( )

inlineinherited

Get FaceUri schemes accepted by this ProtocolFactory.

Definition at line 127 of file protocol-factory.hpp.

std::set< std::string > nfd::face::ProtocolFactory::listRegistered ( )

staticinherited

Get registered protocol factory ids.

Definition at line 53 of file protocol-factory.cpp.

void nfd::face::WebSocketFactory::processConfig ( OptionalConfigSection  configSection, FaceSystem::ConfigContext &  context  )

overridevirtual

process face_system.websocket config section

Implements nfd::face::ProtocolFactory.

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

template<typename PF >

static void nfd::face::ProtocolFactory::registerType ( const std::string &  id = PF::getId() )

inlinestaticinherited

Register a protocol factory type.

Template Parameters

S	subclass of ProtocolFactory

Parameters

id	factory identifier

Definition at line 70 of file protocol-factory.hpp.

Member Data Documentation

FaceCreatedCallback nfd::face::ProtocolFactory::addFace

protectedinherited

callback when a new face is created

Definition at line 184 of file protocol-factory.hpp.

shared_ptr<ndn::net::NetworkMonitor> nfd::face::ProtocolFactory::netmon

protectedinherited

NetworkMonitor for listing available network interfaces and monitoring their changes.

ProtocolFactory subclass should check the NetworkMonitor has sufficient capabilities prior to usage.

Definition at line 191 of file protocol-factory.hpp.

std::set<std::string> nfd::face::ProtocolFactory::providedSchemes

protectedinherited

FaceUri schemes provided by this ProtocolFactory.

Definition at line 182 of file protocol-factory.hpp.