ndn::autoconfig::NdnFchDiscovery Class Reference

Discover NDN hub using NDN-FCH protocol. More...

#include <tools/ndn-autoconfig/ndn-fch-discovery.hpp>

Inheritance diagram for ndn::autoconfig::NdnFchDiscovery:

Collaboration diagram for ndn::autoconfig::NdnFchDiscovery:

Public Member Functions
	NdnFchDiscovery (const std::string &url)
	Create stage to discover NDN hub using NDN-FCH protocol. More...
const std::string &	getName () const override
	Get stage name. More...
void	start ()
	Start running this stage. More...

Public Attributes
signal::Signal< Stage, std::string >	onFailure
	Signal emitted when discovery fails. More...
signal::Signal< Stage, FaceUri >	onSuccess
	Signal emitted when a HUB FaceUri is found. More...

Protected Member Functions
void	fail (const std::string &msg)
void	provideHubFaceUri (const std::string &s)
	Parse HUB FaceUri from string and declare success. More...
void	succeed (const FaceUri &hubFaceUri)

Detailed Description

Discover NDN hub using NDN-FCH protocol.

See also

https://github.com/named-data/ndn-fch/blob/master/README.md

Definition at line 38 of file ndn-fch-discovery.hpp.

Constructor & Destructor Documentation

NdnFchDiscovery()

ndn::autoconfig::NdnFchDiscovery::NdnFchDiscovery ( const std::string &  url )

explicit

Create stage to discover NDN hub using NDN-FCH protocol.

Definition at line 133 of file ndn-fch-discovery.cpp.

Member Function Documentation

fail()

void ndn::autoconfig::Stage::fail ( const std::string &  msg )

protectedinherited

Definition at line 63 of file stage.cpp.

getName()

const std::string& ndn::autoconfig::NdnFchDiscovery::getName ( ) const

inlineoverridevirtual

Get stage name.

Returns

stage name as a phrase, typically starting with lower case

Implements ndn::autoconfig::Stage.

Definition at line 48 of file ndn-fch-discovery.hpp.

provideHubFaceUri()

void ndn::autoconfig::Stage::provideHubFaceUri ( const std::string &  s )

protectedinherited

Parse HUB FaceUri from string and declare success.

Definition at line 43 of file stage.cpp.

start()

void ndn::autoconfig::Stage::start ( )

inherited

Start running this stage.

Exceptions

Error

stage is already running

Definition at line 31 of file stage.cpp.

succeed()

void ndn::autoconfig::Stage::succeed ( const FaceUri &  hubFaceUri )

protectedinherited

Definition at line 55 of file stage.cpp.

Member Data Documentation

onFailure

signal::Signal<Stage, std::string> ndn::autoconfig::Stage::onFailure

inherited

Signal emitted when discovery fails.

Argument is error message.

Definition at line 92 of file stage.hpp.

onSuccess

signal::Signal<Stage, FaceUri> ndn::autoconfig::Stage::onSuccess

inherited

Signal emitted when a HUB FaceUri is found.

Argument is HUB FaceUri, may not be canonical.

Definition at line 85 of file stage.hpp.