NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
nfd::face::UdpFactory Class Reference

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:

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< UdpChannelcreateChannel (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< FacecreateMulticastFace (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< ProtocolFactorycreate (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::NetworkMonitornetmon
 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()

◆ 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
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

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

◆ 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
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
UdpFactory::Error

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

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


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