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

#include <udp-factory.hpp>

Inheritance diagram for nfd::face::UdpFactory:

Collaboration diagram for nfd::face::UdpFactory:

[legend]

Classes
class	Error
	Exception of UdpFactory. More...

Public Member Functions
	UdpFactory (const CtorParams &params)

void	processConfig (OptionalConfigSection configSection, FaceSystem::ConfigContext &context) override
	process face_system.udp config section More...

void	createFace (const CreateFaceRequest &req, const FaceCreatedCallback &onCreated, const FaceCreationFailedCallback &onFailure) override
	Try to create a unicast face using the supplied parameters. More...

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

std::vector< shared_ptr< const Channel > >	getChannels () const override

shared_ptr< Face >	createMulticastFace (const shared_ptr< const ndn::net::NetworkInterface > &netif, const boost::asio::ip::address &localAddress, const udp::Endpoint &multicastEndpoint)
	Create a multicast UDP face. More...

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< ProtocolFactory >	create (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::NetworkMonitor >	netmon
	NetworkMonitor for listing available network interfaces and monitoring their changes. 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.

Constructor & Destructor Documentation

◆ UdpFactory()

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

explicit

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

References nfd::face::ProtocolFactory::netmon.

Member Function Documentation

◆ getId()

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

static

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

◆ processConfig()

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

overridevirtual

process face_system.udp config section

Implements nfd::face::ProtocolFactory.

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

References nfd::face::ProtocolFactory::addFace, ndn::ip::addressV6FromString(), createChannel(), nfd::face::FaceSystem::ConfigContext::generalConfig, nfd::face::FaceSystem::ConfigContext::isDryRun, ndn::nfd::LINK_TYPE_AD_HOC, ndn::nfd::LINK_TYPE_MULTI_ACCESS, NFD_LOG_INFO, NFD_LOG_WARN, nfd::ConfigFile::parseYesNo(), nfd::face::ProtocolFactory::providedSchemes, and nfd::face::FaceSystem::GeneralConfig::wantCongestionMarking.

◆ createFace()

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

overridevirtual

Try to create a unicast face using the supplied parameters.

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

Implements nfd::face::ProtocolFactory.

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

References ndn::ip::addressFromString(), ndn::nfd::FACE_PERSISTENCY_ON_DEMAND, ndn::FaceUri::getHost(), ndn::FaceUri::getPort(), ndn::FaceUri::isCanonical(), nfd::face::ProtocolFactory::CreateFaceRequest::localUri, NFD_LOG_TRACE, nfd::face::ProtocolFactory::CreateFaceRequest::params, nfd::face::FaceParams::persistency, nfd::face::ProtocolFactory::CreateFaceRequest::remoteUri, and nfd::face::FaceParams::wantLocalFields.

◆ createChannel()

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 286 of file udp-factory.cpp.

Referenced by processConfig().

◆ getChannels()

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

overridevirtual

Implements nfd::face::ProtocolFactory.

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

References nfd::face::ProtocolFactory::getChannelsFromMap().

◆ createMulticastFace()

shared_ptr< Face > nfd::face::UdpFactory::createMulticastFace	(	const shared_ptr< const ndn::net::NetworkInterface > &	netif,
		const boost::asio::ip::address &	localAddress,
		const udp::Endpoint &	multicastEndpoint
	)

Create a multicast UDP face.

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 set of arguments, only one face will be created. The second call will just return the existing face.

If a UDP channel, unicast face, or multicast face already exists on the same combination of local address and multicast port, the creation fails and an exception is thrown.

Parameters

netif	the network interface to which the face will be bound
localAddress	the local IP address to which the face will be bound
multicastEndpoint	the multicast endpoint (multicast group and port number)

Returns: always a valid shared pointer to the created face; an exception is thrown if the face cannot be created.

Exceptions

UdpFactory::Error

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

References nfd::face::GenericLinkService::Options::allowCongestionMarking, nfd::face::connectFaceClosedSignal(), nfd::getGlobalIoService(), nfd::face::MulticastUdpTransport::openRxSocket(), and nfd::face::MulticastUdpTransport::openTxSocket().

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

ndnSIM/NFD/daemon/face/udp-factory.hpp
ndnSIM/NFD/daemon/face/udp-factory.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UdpFactory()

Member Function Documentation

◆ getId()

◆ processConfig()

◆ createFace()

◆ createChannel()

◆ getChannels()

◆ createMulticastFace()