nfd::face::UnixStreamFactory Class Reference

protocol factory for stream-oriented Unix sockets More...

#include <unix-stream-factory.hpp>

Inheritance diagram for nfd::face::UnixStreamFactory:

Collaboration diagram for nfd::face::UnixStreamFactory:

Public Member Functions
	UnixStreamFactory (const CtorParams &params)
void	processConfig (OptionalConfigSection configSection, FaceSystem::ConfigContext &context) override
	process face_system.unix 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< UnixStreamChannel >	createChannel (const std::string &unixSocketPath)
	Create stream-oriented Unix channel using specified socket path. More...
std::vector< shared_ptr< const Channel > >	getChannels () const override
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 stream-oriented Unix sockets

Definition at line 37 of file unix-stream-factory.hpp.

Constructor & Destructor Documentation

UnixStreamFactory()

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

explicit

Definition at line 43 of file unix-stream-factory.cpp.

Member Function Documentation

getId()

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

static

Definition at line 37 of file unix-stream-factory.cpp.

processConfig()

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

overridevirtual

process face_system.unix config section

Implements nfd::face::ProtocolFactory.

Definition at line 49 of file unix-stream-factory.cpp.

References nfd::face::ProtocolFactory::addFace, createChannel(), nfd::face::FaceSystem::ConfigContext::generalConfig, nfd::face::FaceSystem::ConfigContext::isDryRun, NFD_LOG_WARN, and nfd::face::FaceSystem::GeneralConfig::wantCongestionMarking.

createFace()

void nfd::face::UnixStreamFactory::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 89 of file unix-stream-factory.cpp.

createChannel()

shared_ptr< UnixStreamChannel > nfd::face::UnixStreamFactory::createChannel

(

const std::string &

unixSocketPath

)

Create stream-oriented Unix channel using specified socket path.

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

Returns

always a valid pointer to a UnixStreamChannel object, an exception will be thrown if the channel cannot be created.

Definition at line 97 of file unix-stream-factory.cpp.

Referenced by processConfig().

getChannels()

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

overridevirtual

Implements nfd::face::ProtocolFactory.

Definition at line 113 of file unix-stream-factory.cpp.

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

---

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

• ndnSIM/NFD/daemon/face/unix-stream-factory.hpp
• ndnSIM/NFD/daemon/face/unix-stream-factory.cpp