ndn::autoconfig::Stage Class Reference

A discovery stage. More...

#include <tools/ndn-autoconfig/stage.hpp>

Inheritance diagram for ndn::autoconfig::Stage:

Collaboration diagram for ndn::autoconfig::Stage:

Classes
class	Error

Public Member Functions
virtual	~Stage ()=default
virtual const std::string &	getName () const =0
	Get stage name. More...
void	start ()
	Start running this stage. More...

Public Attributes
util::Signal< Stage, std::string >	onFailure
	Signal when discovery fails. More...
util::Signal< Stage, FaceUri >	onSuccess
	Signal 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

A discovery stage.

Definition at line 38 of file stage.hpp.

Constructor & Destructor Documentation

~Stage()

virtual ndn::autoconfig::Stage::~Stage ( )

virtualdefault

Member Function Documentation

fail()

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

protected

Definition at line 63 of file stage.cpp.

getName()

virtual const std::string& ndn::autoconfig::Stage::getName ( ) const

pure virtual

Get stage name.

Returns

stage name as a phrase, typically starting with lower case

Implemented in ndn::autoconfig::NdnFchDiscovery, ndn::autoconfig::GuessFromSearchDomains, ndn::autoconfig::GuessFromIdentityName, and ndn::autoconfig::MulticastDiscovery.

provideHubFaceUri()

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

protected

Parse HUB FaceUri from string and declare success.

Definition at line 43 of file stage.cpp.

start()

void ndn::autoconfig::Stage::start

(

)

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 )

protected

Definition at line 55 of file stage.cpp.

Member Data Documentation

onFailure

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

Signal when discovery fails.

Argument is error message.

Definition at line 89 of file stage.hpp.

onSuccess

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

Signal when a HUB FaceUri is found.

Argument is HUB FaceUri, may not be canonical.

Definition at line 83 of file stage.hpp.