nfd::face::TcpFactory Class Reference

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

#include <tcp-factory.hpp>

Inheritance diagram for nfd::face::TcpFactory:

Collaboration diagram for nfd::face::TcpFactory:

Public Member Functions
void	processConfig (OptionalConfigSection configSection, FaceSystem::ConfigContext &context) override
	process face_system.tcp config section More...
void	createFace (const FaceUri &uri, ndn::nfd::FacePersistency persistency, bool wantLocalFieldsEnabled, const FaceCreatedCallback &onCreated, const FaceCreationFailedCallback &onFailure) override
	Try to create Face using the supplied FaceUri. More...
shared_ptr< TcpChannel >	createChannel (const tcp::Endpoint &localEndpoint)
	Create TCP-based channel using tcp::Endpoint. More...
shared_ptr< TcpChannel >	createChannel (const std::string &localIp, const std::string &localPort)
	Create TCP-based channel using specified IP address and port number. More...
std::vector< shared_ptr< const Channel > >	getChannels () const override
const std::set< std::string > &	getProvidedSchemes ()

Static Public Member Functions
static const std::string &	getId ()
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)
static std::set< std::string >	listRegistered ()

Static Protected Member Functions
template<typename ChannelMap >
static std::vector< shared_ptr< const Channel > >	getChannelsFromMap (const ChannelMap &channelMap)

Protected Attributes
std::set< std::string >	providedSchemes
	FaceUri schemes provided by this ProtocolFactory. More...

Detailed Description

protocol factory for TCP over IPv4 and IPv6

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

Member Function Documentation

unique_ptr< ProtocolFactory > nfd::face::ProtocolFactory::create ( const std::string &  id )

staticinherited

Returns

a protocol factory instance

Return values

nullptr

if factory with id is not registered

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

shared_ptr< TcpChannel > nfd::face::TcpFactory::createChannel

(

const tcp::Endpoint &

localEndpoint

)

Create TCP-based channel using tcp::Endpoint.

tcp::Endpoint is really an alias for boost::asio::ip::tcp::endpoint.

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

Returns

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

See also

http://www.boost.org/doc/libs/1_42_0/doc/html/boost_asio/reference/ip__tcp/endpoint.html for details on ways to create tcp::Endpoint

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

shared_ptr< TcpChannel > nfd::face::TcpFactory::createChannel	(	const std::string &	localIp,
		const std::string &	localPort
	)

Create TCP-based channel using specified IP address and port number.

This method is just a helper that converts a string representation of localIp and port to tcp::Endpoint and calls the other createChannel overload.

Exceptions

std::runtime_error

Definition at line 231 of file tcp-factory.cpp.

void nfd::face::TcpFactory::createFace ( const FaceUri &  uri, ndn::nfd::FacePersistency  persistency, bool  wantLocalFieldsEnabled, const FaceCreatedCallback &  onCreated, const FaceCreationFailedCallback &  onFailure  )

overridevirtual

Try to create Face using the supplied FaceUri.

This method should automatically choose channel, based on supplied FaceUri and create face.

Parameters

uri	remote URI of the new face
persistency	persistency of the new face
wantLocalFieldsEnabled	whether local fields should be enabled on the face
onCreated	callback if face creation succeeds If a face with the same remote URI already exists, its persistency and LocalFieldsEnabled setting will not be modified.
onFailure	callback if face creation fails

Implements nfd::face::ProtocolFactory.

Definition at line 124 of file tcp-factory.cpp.

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

overridevirtual

Implements nfd::face::ProtocolFactory.

Definition at line 239 of file tcp-factory.cpp.

template<typename ChannelMap >

static std::vector<shared_ptr<const Channel> > nfd::face::ProtocolFactory::getChannelsFromMap ( const ChannelMap &  channelMap )

inlinestaticprotectedinherited

Definition at line 147 of file protocol-factory.hpp.

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

static

Definition at line 38 of file tcp-factory.cpp.

const std::set<std::string>& nfd::face::ProtocolFactory::getProvidedSchemes ( )

inlineinherited

Returns

FaceUri schemes accepted by this ProtocolFactory

Definition at line 116 of file protocol-factory.hpp.

std::set< std::string > nfd::face::ProtocolFactory::listRegistered ( )

staticinherited

Returns

registered protocol factory ids

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

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

overridevirtual

process face_system.tcp config section

Reimplemented from nfd::face::ProtocolFactory.

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

template<typename PF >

static void nfd::face::ProtocolFactory::registerType ( const std::string &  id = PF::getId() )

inlinestaticinherited

register a protocol factory type

Template Parameters

S	subclass of ProtocolFactory

Parameters

id	factory identifier

Definition at line 54 of file protocol-factory.hpp.

Member Data Documentation

std::set<std::string> nfd::face::ProtocolFactory::providedSchemes

protectedinherited

FaceUri schemes provided by this ProtocolFactory.

Definition at line 164 of file protocol-factory.hpp.