Fawkes API  Fawkes Development Version
ConfigChangeWatcherTool Class Reference

Tool to watch and output config changes. More...

Inheritance diagram for ConfigChangeWatcherTool:

List of all members.

Public Member Functions

 ConfigChangeWatcherTool (Configuration *config, FawkesNetworkClient *c)
 Constructor.
virtual void handle_signal (int signal)
 Signal hanlding method.
virtual void config_tag_changed (const char *new_tag)
 Called whenever the tag has changed.
virtual void config_value_changed (const Configuration::ValueIterator *v)
 Called whenever a watched value has changed.
virtual void config_comment_changed (const Configuration::ValueIterator *v)
 Called whenever a comment of a watched value has changed.
virtual void config_value_erased (const char *path)
 Called whenever a value has been erased from the config.
void run ()
 Run.

Detailed Description

Tool to watch and output config changes.


Constructor & Destructor Documentation

ConfigChangeWatcherTool::ConfigChangeWatcherTool ( Configuration config,
FawkesNetworkClient c 
) [inline]

Constructor.

Parameters:
configConfiguration to watch
cnetwork client, thread is cancelled on signal

Definition at line 47 of file main.cpp.

References fawkes::Configuration::add_change_handler().


Member Function Documentation

virtual void ConfigChangeWatcherTool::config_comment_changed ( const Configuration::ValueIterator v) [inline, virtual]

Called whenever a comment of a watched value has changed.

Parameters:
vvalue iterator for the specific value

Implements fawkes::ConfigurationChangeHandler.

Definition at line 73 of file main.cpp.

References fawkes::Configuration::ValueIterator::is_default(), fawkes::Configuration::ValueIterator::path(), and fawkes::Configuration::ValueIterator::get_comment().

virtual void ConfigChangeWatcherTool::config_tag_changed ( const char *  new_tag) [inline, virtual]

Called whenever the tag has changed.

This function can be used to detect when data from another tag has been loaded.

Parameters:
new_tagnew tag

Implements fawkes::ConfigurationChangeHandler.

Definition at line 62 of file main.cpp.

virtual void ConfigChangeWatcherTool::config_value_changed ( const Configuration::ValueIterator v) [inline, virtual]

Called whenever a watched value has changed.

Parameters:
vvalue iterator for the specific value

Implements fawkes::ConfigurationChangeHandler.

Definition at line 67 of file main.cpp.

References fawkes::Configuration::ValueIterator::is_default(), fawkes::Configuration::ValueIterator::path(), fawkes::Configuration::ValueIterator::type(), and fawkes::Configuration::ValueIterator::get_as_string().

virtual void ConfigChangeWatcherTool::config_value_erased ( const char *  path) [inline, virtual]

Called whenever a value has been erased from the config.

Parameters:
pathpath of value

Implements fawkes::ConfigurationChangeHandler.

Definition at line 79 of file main.cpp.

virtual void ConfigChangeWatcherTool::handle_signal ( int  signum) [inline, virtual]

Signal hanlding method.

Implement this method with the action you want to perform on the registered signals.

Parameters:
signumsignal number of triggered signal
Author:
Tim Niemueller

Implements fawkes::SignalHandler.

Definition at line 56 of file main.cpp.

References fawkes::Configuration::rem_change_handler().

void ConfigChangeWatcherTool::run ( ) [inline]

Run.

This joins the network thread.

Definition at line 89 of file main.cpp.


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