nfd::face::UdpFactory Class Referencefinal

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
 

Public Types

using CtorParams = ProtocolFactoryCtorParams
 

Public Member Functions

 UdpFactory (const CtorParams &params)
 
shared_ptr< UdpChannelcreateChannel (const udp::Endpoint &localEndpoint, time::nanoseconds idleTimeout)
 Create UDP-based channel using udp::Endpoint. More...
 
void createFace (const CreateFaceRequest &req, const FaceCreatedCallback &onCreated, const FaceCreationFailedCallback &onFailure)
 Create a unicast face. More...
 
shared_ptr< FacecreateMulticastFace (const ndn::net::NetworkInterface &netif, const boost::asio::ip::address &localAddress, const udp::Endpoint &multicastEndpoint)
 Create a multicast UDP face. More...
 
shared_ptr< FacecreateNetdevBoundFace (const FaceUri &remote, const shared_ptr< const ndn::net::NetworkInterface > &netdev)
 Create a netdev-bound face. More...
 
std::vector< shared_ptr< const Channel > > getChannels () const
 Get list of open channels (listening + non-listening) More...
 
const std::set< std::string > & getProvidedSchemes () const noexcept
 Get FaceUri schemes accepted by this protocol factory. More...
 
void processConfig (OptionalConfigSection configSection, FaceSystem::ConfigContext &context)
 Process face_system subsection that corresponds to this protocol factory id. More...
 

Static Public Member Functions

static unique_ptr< ProtocolFactorycreate (const std::string &id, const CtorParams &params)
 Create a protocol factory instance. More...
 
static const std::string & getId () noexcept
 
static std::set< std::string > listRegistered ()
 Get all 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 protocol factory. More...
 

Detailed Description

Protocol factory for UDP over IPv4 and IPv6.

Definition at line 38 of file udp-factory.hpp.

Member Typedef Documentation

◆ CtorParams

Constructor & Destructor Documentation

◆ UdpFactory()

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

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

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
nullptrif a factory with the given id is not registered

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

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

◆ createFace()

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

Create a unicast face.

Parameters
reqrequest object containing the face creation parameters
onCreatedcallback if face creation succeeds or face already exists; the settings of an existing face are not updated if they differ from the request
onFailurecallback if face creation fails

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

◆ createMulticastFace()

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

Create a multicast UDP face.

udp::Endpoint is 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
netifthe network interface to which the face will be bound
localAddressthe local IP address to which the face will be bound
multicastEndpointthe 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
std::runtime_errorFace creation failed

Definition at line 328 of file udp-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
remoteremote FaceUri, must be canonical
netdevlocal network interface
Returns
new face
Exceptions
Errorcannot 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::UdpFactory::getId ( )
staticnoexcept

Definition at line 45 of file udp-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
configSectionthe configuration section or boost::none to indicate it is omitted
contextprovides access to data structures and contextual information
Exceptions
ConfigFile::Errorinvalid configuration

Definition at line 72 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
PFsubclass of ProtocolFactory
Parameters
idfactory 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.