protocol factory for UDP over IPv4 and IPv6 More...

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

Inheritance diagram for nfd::face::UdpFactory:

Collaboration diagram for nfd::face::UdpFactory:

Classes
class	Error
	Exception of UdpFactory. More...

Public Types
using	CtorParams = ProtocolFactoryCtorParams

Public Member Functions
	UdpFactory (const CtorParams &params)

shared_ptr< UdpChannel >	createChannel (const udp::Endpoint &localEndpoint, time::nanoseconds idleTimeout)
	Create UDP-based channel using udp::Endpoint. More...

void	createFace (const CreateFaceParams &params, const FaceCreatedCallback &onCreated, const FaceCreationFailedCallback &onFailure) override
	Try to create face using the supplied parameters. More...

shared_ptr< Face >	createMulticastFace (const udp::Endpoint &localEndpoint, const udp::Endpoint &multicastEndpoint, const std::string &networkInterfaceName="")
	Create multicast UDP face using udp::Endpoint. More...

shared_ptr< Face >	createMulticastFace (const std::string &localIp, const std::string &multicastIp, const std::string &multicastPort, const std::string &networkInterfaceName="")

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.udp 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 UDP over IPv4 and IPv6

UDP unicast is available over both IPv4 and IPv6. UDP multicast is available over IPv4 only.

Definition at line 40 of file udp-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::UdpFactory::UdpFactory ( const CtorParams & params )

explicit

Definition at line 56 of file udp-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< UdpChannel > nfd::face::UdpFactory::createChannel	(	const udp::Endpoint &	localEndpoint,
		time::nanoseconds	idleTimeout
	)

Create UDP-based channel using udp::Endpoint.

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

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

If a multicast face is already active on the same local endpoint, the creation fails and an exception is thrown.

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

Exceptions

UdpFactory::Error

Definition at line 263 of file udp-factory.cpp.

void nfd::face::UdpFactory::createFace	(	const CreateFaceParams &	params,
		const FaceCreatedCallback &	onCreated,
		const FaceCreationFailedCallback &	onFailure
	)

overridevirtual

Try to create face using the supplied parameters.

Parameters

params	parameters to create face with
onCreated	callback if face creation succeeds or face already exists; persistency and local fields settings are not updated on an existing face
onFailure	callback if face creation fails

Implements nfd::face::ProtocolFactory.

Definition at line 214 of file udp-factory.cpp.

shared_ptr< Face > nfd::face::UdpFactory::createMulticastFace	(	const udp::Endpoint &	localEndpoint,
		const udp::Endpoint &	multicastEndpoint,
		const std::string &	networkInterfaceName = `""`
	)

Create multicast UDP face using udp::Endpoint.

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

The face will join the specified multicast group.

If this method is called twice with the same pair of endpoints, only one face will be created. The second call will just return the existing face.

If an unicast face is already active on the same local NIC and port, the creation fails and an exception is thrown.

Parameters

localEndpoint	local endpoint
multicastEndpoint	multicast endpoint
networkInterfaceName	name of the network interface on which the face will be bound (Used only on multihomed linux machine with more than one multicast UDP face for the same multicast group. If specified, will require CAP_NET_RAW capability) An empty string can be provided in other system or in linux machine with only one multicast UDP face per multicast group

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

Exceptions

UdpFactory::Error

Definition at line 294 of file udp-factory.cpp.

shared_ptr< Face > nfd::face::UdpFactory::createMulticastFace	(	const std::string &	localIp,
		const std::string &	multicastIp,
		const std::string &	multicastPort,
		const std::string &	networkInterfaceName = `""`
	)

Definition at line 378 of file udp-factory.cpp.

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

overridevirtual

Implements nfd::face::ProtocolFactory.

Definition at line 288 of file udp-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::UdpFactory::getId ( )

static

Definition at line 50 of file udp-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::UdpFactory::processConfig	(	OptionalConfigSection	configSection,
		FaceSystem::ConfigContext &	context
	)

overridevirtual

process face_system.udp config section

Implements nfd::face::ProtocolFactory.

Definition at line 63 of file udp-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.

NFD: Named Data Networking Forwarding Daemon 0.6.0 documentation

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation