protocol factory for Ethernet More...

#include <ethernet-factory.hpp>

Inheritance diagram for nfd::face::EthernetFactory:

Collaboration diagram for nfd::face::EthernetFactory:

[legend]

Public Member Functions
	EthernetFactory (const CtorParams &params)

void	processConfig (OptionalConfigSection configSection, FaceSystem::ConfigContext &context) override
	process face_system.ether 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< EthernetChannel >	createChannel (const shared_ptr< const ndn::net::NetworkInterface > &localEndpoint, time::nanoseconds idleTimeout)
	Create Ethernet-based channel on the specified network interface. More...

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

shared_ptr< Face >	createMulticastFace (const ndn::net::NetworkInterface &localEndpoint, const ethernet::Address &group)
	Create a face to communicate on the given Ethernet multicast group. 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 Ethernet

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

Constructor & Destructor Documentation

◆ EthernetFactory()

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

explicit

Definition at line 46 of file ethernet-factory.cpp.

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

Member Function Documentation

◆ getId()

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

static

Definition at line 40 of file ethernet-factory.cpp.

◆ processConfig()

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

overridevirtual

process face_system.ether config section

Implements nfd::face::ProtocolFactory.

Definition at line 57 of file ethernet-factory.cpp.

References ndn::ethernet::Address::fromString(), nfd::face::FaceSystem::ConfigContext::isDryRun, ndn::nfd::LINK_TYPE_AD_HOC, ndn::nfd::LINK_TYPE_MULTI_ACCESS, NFD_LOG_INFO, NFD_LOG_WARN, and nfd::ConfigFile::parseYesNo().

◆ createFace()

void nfd::face::EthernetFactory::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 169 of file ethernet-factory.cpp.

References ndn::nfd::FACE_PERSISTENCY_ON_DEMAND, ndn::ethernet::Address::fromString(), ndn::FaceUri::getHost(), ndn::FaceUri::isCanonical(), ndn::ethernet::Address::isMulticast(), 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< EthernetChannel > nfd::face::EthernetFactory::createChannel	(	const shared_ptr< const ndn::net::NetworkInterface > &	localEndpoint,
		time::nanoseconds	idleTimeout
	)

Create Ethernet-based channel on the specified network interface.

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.

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

Exceptions

PcapHelper::Error channel creation failed

Definition at line 216 of file ethernet-factory.cpp.

◆ getChannels()

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

overridevirtual

Implements nfd::face::ProtocolFactory.

Definition at line 230 of file ethernet-factory.cpp.

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

◆ createMulticastFace()

shared_ptr< Face > nfd::face::EthernetFactory::createMulticastFace	(	const ndn::net::NetworkInterface &	localEndpoint,
		const ethernet::Address &	group
	)

Create a face to communicate on the given Ethernet multicast group.

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

Parameters

localEndpoint	local network interface
group	multicast group address

Exceptions

EthernetTransport::Error transport creation fails

Definition at line 236 of file ethernet-factory.cpp.

References nfd::face::GenericLinkService::Options::allowFragmentation, nfd::face::GenericLinkService::Options::allowReassembly, nfd::face::connectFaceClosedSignal(), ndn::net::NetworkInterface::getName(), and ndn::ethernet::Address::isMulticast().

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EthernetFactory()

Member Function Documentation

◆ getId()

◆ processConfig()

◆ createFace()

◆ createChannel()

◆ getChannels()

◆ createMulticastFace()