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
shared_ptr< WebSocketChannel >	createChannel (const websocket::Endpoint &localEndpoint)
	Create WebSocket-based channel using websocket::Endpoint.

void	createFace (const CreateFaceRequest &req, const FaceCreatedCallback &onCreated, const FaceCreationFailedCallback &onFailure)
	Create a unicast face.

shared_ptr< Face >	createNetdevBoundFace (const FaceUri &remote, const shared_ptr< const ndn::net::NetworkInterface > &netdev)
	Create a netdev-bound face.

std::vector< shared_ptr< const Channel > >	getChannels () const
	Get list of open channels (listening + non-listening)

const std::set< std::string > &	getProvidedSchemes () const noexcept
	Get FaceUri schemes accepted by this protocol factory.

void	processConfig (OptionalConfigSection configSection, FaceSystem::ConfigContext &context)
	Process face_system subsection that corresponds to this protocol factory id.

	ProtocolFactory (const CtorParams &params)

Static Public Member Functions
static unique_ptr< ProtocolFactory >	create (const std::string &id, const CtorParams &params)
	Create a protocol factory instance.

static const std::string &	getId () noexcept

static std::set< std::string >	listRegistered ()
	Get all registered protocol factory IDs.

template<typename PF >
static void	registerType (const std::string &id=PF::getId())
	Register a protocol factory type.

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

shared_ptr< ndn::net::NetworkMonitor >	netmon
	NetworkMonitor for listing available network interfaces and monitoring their changes.

std::set< std::string >	providedSchemes
	FaceUri schemes provided by this protocol factory.

Detailed Description

Protocol factory for WebSocket.

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

Member Typedef Documentation

◆ CtorParams

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

inherited

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

Member Function Documentation

◆ create()

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

staticinherited

Create a protocol factory instance.

Return values

nullptr if a factory with the given id is not registered

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

◆ createChannel()

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

Create WebSocket-based channel using websocket::Endpoint.

websocket::Endpoint is 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 117 of file websocket-factory.cpp.

◆ createFace()

void nfd::face::ProtocolFactory::createFace	(	const CreateFaceRequest &	req,
		const FaceCreatedCallback &	onCreated,
		const FaceCreationFailedCallback &	onFailure
	)

inherited

Create a unicast face.

Parameters

req	request object containing the face creation parameters
onCreated	callback if face creation succeeds or face already exists; the settings of an existing face are not updated if they differ from the request
onFailure	callback if face creation fails

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

◆ createNetdevBoundFace()

shared_ptr< Face > nfd::face::ProtocolFactory::createNetdevBoundFace	(	const FaceUri &	remote,
		const shared_ptr< const ndn::net::NetworkInterface > &	netdev
	)

inherited

Create a netdev-bound face.

Parameters

remote	remote FaceUri, must be canonical
netdev	local network interface

Returns: new face

Exceptions

Error cannot create a face using specified arguments

Note: The caller must ensure there is no existing netdev-bound face with same remote FaceUri on the same local network interface.

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

◆ getChannels()

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

inherited

Get list of open channels (listening + non-listening)

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

◆ getChannelsFromMap()

template<typename ChannelMap >

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

inlinestaticprotectedinherited

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

◆ getId()

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

staticnoexcept

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

◆ getProvidedSchemes()

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

inlinenoexceptinherited

Get FaceUri schemes accepted by this protocol factory.

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

◆ listRegistered()

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

staticinherited

Get all registered protocol factory IDs.

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

◆ processConfig()

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

inherited

Process face_system subsection that corresponds to this protocol factory id.

Parameters

configSection	the configuration section or boost::none to indicate it is omitted
context	provides access to data structures and contextual information

Exceptions

ConfigFile::Error invalid configuration

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

◆ ProtocolFactory()

nfd::face::ProtocolFactory::ProtocolFactory ( const CtorParams & params )

explicit

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

◆ registerType()

template<typename PF >

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

inlinestaticinherited

Register a protocol factory type.

Template Parameters

PF	subclass of ProtocolFactory

Parameters

id	factory identifier

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

Member Data Documentation

◆ addFace

FaceCreatedCallback nfd::face::ProtocolFactory::addFace

protectedinherited

callback when a new face is created

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

◆ netmon

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 261 of file protocol-factory.hpp.

◆ providedSchemes

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

protectedinherited

FaceUri schemes provided by this protocol factory.

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

NFD: Named Data Networking Forwarding Daemon 24.07-20-gbeb9e85b documentation

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ CtorParams

Member Function Documentation

◆ create()

◆ createChannel()

◆ createFace()

◆ createNetdevBoundFace()

◆ getChannels()

◆ getChannelsFromMap()

◆ getId()

◆ getProvidedSchemes()

◆ listRegistered()

◆ processConfig()

◆ ProtocolFactory()

◆ registerType()

Member Data Documentation

◆ addFace

◆ netmon

◆ providedSchemes