ndn::tools::autoconfig::Stage Class Referenceabstract

a discovery stage More...

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

+ Inheritance diagram for ndn::tools::autoconfig::Stage:
+ Collaboration diagram for ndn::tools::autoconfig::Stage:


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 42 of file stage.hpp.

Constructor & Destructor Documentation

◆ ~Stage()

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

Member Function Documentation

◆ fail()

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

Definition at line 65 of file stage.cpp.

◆ getName()

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

◆ provideHubFaceUri()

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

parse HUB FaceUri from string and declare success

Definition at line 45 of file stage.cpp.

◆ start()

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

start running this stage

Errorstage is already running

Definition at line 33 of file stage.cpp.

◆ succeed()

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

Definition at line 57 of file stage.cpp.

Member Data Documentation

◆ onFailure

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

signal when discovery fails

Argument is error message.

Definition at line 96 of file stage.hpp.

◆ onSuccess

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

signal when a HUB FaceUri is found

Argument is HUB FaceUri, may not be canonical.

Definition at line 90 of file stage.hpp.