Fawkes API  Fawkes Development Version
fawkes::NetworkConfiguration Class Reference

Remote configuration via Fawkes net. More...

#include <>>

Inheritance diagram for fawkes::NetworkConfiguration:

Classes

class  NetConfValueIterator
 Network configuration value iterator. More...
 

Public Member Functions

 NetworkConfiguration (FawkesNetworkClient *c, unsigned int mirror_timeout_sec=15)
 Constructor. More...
 
virtual ~NetworkConfiguration ()
 Destructor. More...
 
virtual void copy (Configuration *copyconf)
 Copy all values from the given configuration. More...
 
virtual void add_change_handler (ConfigurationChangeHandler *h)
 Add a configuration change handler. More...
 
virtual void rem_change_handler (ConfigurationChangeHandler *h)
 Remove a configuration change handler. More...
 
virtual void load (const char *file_path)
 Load configuration. More...
 
virtual bool exists (const char *path)
 Check if a given value exists. More...
 
virtual bool is_float (const char *path)
 Check if a value is of type float. More...
 
virtual bool is_uint (const char *path)
 Check if a value is of type unsigned int. More...
 
virtual bool is_int (const char *path)
 Check if a value is of type int. More...
 
virtual bool is_bool (const char *path)
 Check if a value is of type bool. More...
 
virtual bool is_string (const char *path)
 Check if a value is of type string. More...
 
virtual bool is_list (const char *path)
 Check if a value is a list. More...
 
virtual bool is_default (const char *path)
 Check if a value was read from the default config. More...
 
virtual float get_float (const char *path)
 Get value from configuration which is of type float. More...
 
virtual unsigned int get_uint (const char *path)
 Get value from configuration which is of type unsigned int. More...
 
virtual int get_int (const char *path)
 Get value from configuration which is of type int. More...
 
virtual bool get_bool (const char *path)
 Get value from configuration which is of type bool. More...
 
virtual std::string get_string (const char *path)
 Get value from configuration which is of type string. More...
 
virtual std::vector< float > get_floats (const char *path)
 Get list of values from configuration which is of type float. More...
 
virtual std::vector< unsigned int > get_uints (const char *path)
 Get list of values from configuration which is of type unsigned int. More...
 
virtual std::vector< int > get_ints (const char *path)
 Get list of values from configuration which is of type int. More...
 
virtual std::vector< bool > get_bools (const char *path)
 Get list of values from configuration which is of type bool. More...
 
virtual std::vector< std::string > get_strings (const char *path)
 Get list of values from configuration which is of type string. More...
 
virtual ValueIteratorget_value (const char *path)
 Get value from configuration. More...
 
virtual std::string get_comment (const char *path)
 Get comment of value at given path. More...
 
virtual std::string get_default_comment (const char *path)
 Get comment of value at given path. More...
 
virtual std::string get_type (const char *path)
 Get type of field. More...
 
virtual void set_float (const char *path, float f)
 Set new value in configuration of type float. More...
 
virtual void set_uint (const char *path, unsigned int uint)
 Set new value in configuration of type unsigned int. More...
 
virtual void set_int (const char *path, int i)
 Set new value in configuration of type int. More...
 
virtual void set_bool (const char *path, bool b)
 Set new value in configuration of type bool. More...
 
virtual void set_string (const char *path, std::string &s)
 Set new value in configuration of type string. More...
 
virtual void set_string (const char *path, const char *s)
 Set new value in configuration of type string. More...
 
virtual void set_floats (const char *path, std::vector< float > &f)
 Set new value in configuration of type float. More...
 
virtual void set_uints (const char *path, std::vector< unsigned int > &uint)
 Set new value in configuration of type unsigned int. More...
 
virtual void set_ints (const char *path, std::vector< int > &i)
 Set new value in configuration of type int. More...
 
virtual void set_bools (const char *path, std::vector< bool > &b)
 Set new value in configuration of type bool. More...
 
virtual void set_strings (const char *path, std::vector< std::string > &s)
 Set new value in configuration of type string. More...
 
virtual void set_strings (const char *path, std::vector< const char *> &s)
 Set new value in configuration of type string. More...
 
virtual void set_comment (const char *path, std::string &comment)
 Set new comment for existing value. More...
 
virtual void set_comment (const char *path, const char *comment)
 Set new comment for existing value. More...
 
virtual void erase (const char *path)
 Erase the given value from the configuration. More...
 
virtual void set_default_float (const char *path, float f)
 Set new default value in configuration of type float. More...
 
virtual void set_default_uint (const char *path, unsigned int uint)
 Set new default value in configuration of type unsigned int. More...
 
virtual void set_default_int (const char *path, int i)
 Set new default value in configuration of type int. More...
 
virtual void set_default_bool (const char *path, bool b)
 Set new default value in configuration of type bool. More...
 
virtual void set_default_string (const char *path, std::string &s)
 Set new default value in configuration of type string. More...
 
virtual void set_default_string (const char *path, const char *s)
 Set new default value in configuration of type string. More...
 
virtual void set_default_comment (const char *path, std::string &comment)
 Set new default comment for existing default configuration value. More...
 
virtual void set_default_comment (const char *path, const char *comment)
 Set new default comment for existing default configuration value. More...
 
virtual void erase_default (const char *path)
 Erase the given default value from the configuration. More...
 
virtual void deregistered (unsigned int id) throw ()
 We are no longer registered in Fawkes network client. More...
 
virtual void inbound_received (FawkesNetworkMessage *msg, unsigned int id) throw ()
 Called for incoming messages. More...
 
virtual void connection_died (unsigned int id) throw ()
 Client connection died. More...
 
virtual void connection_established (unsigned int id) throw ()
 Client has established a connection. More...
 
virtual void set_mirror_mode (bool mirror)
 Enable or disable mirror mode. More...
 
ValueIteratoriterator ()
 Iterator for all values. More...
 
ValueIteratoriterator_default ()
 Iterator for all default values. More...
 
ValueIteratoriterator_hostspecific ()
 Iterator for all host-specific values. More...
 
ValueIteratorsearch (const char *path)
 Iterator with search results. More...
 
void lock ()
 Lock the config. More...
 
bool try_lock ()
 Try to lock the config. More...
 
void unlock ()
 Unlock the config. More...
 
virtual void try_dump ()
 Try to dump configuration. More...
 
- Public Member Functions inherited from fawkes::Configuration
virtual ~Configuration ()
 Virtual empty destructor. More...
 
- Public Member Functions inherited from fawkes::FawkesNetworkClientHandler
virtual ~FawkesNetworkClientHandler ()
 Empty virtual destructor. More...
 

Additional Inherited Members

- Protected Types inherited from fawkes::Configuration
typedef std::list< ConfigurationChangeHandler * > ChangeHandlerList
 List that contains pointers to ConfigurationChangeHandler. More...
 
typedef std::multimap< const char *, ConfigurationChangeHandler *, StringLessChangeHandlerMultimap
 Multimap string to config change handlers. More...
 
typedef std::pair< ChangeHandlerMultimap::iterator, ChangeHandlerMultimap::iterator > ChangeHandlerMultimapRange
 Config change handler multimap range. More...
 
- Protected Member Functions inherited from fawkes::Configuration
ChangeHandlerListfind_handlers (const char *path)
 Find handlers for given path. More...
 
void notify_handlers (const char *path, bool comment_changed=false)
 Notify handlers for given path. More...
 
- Protected Attributes inherited from fawkes::Configuration
ChangeHandlerMultimap _change_handlers
 Registered change handlers. More...
 
ChangeHandlerMultimapRange _ch_range
 Change handler range. More...
 

Detailed Description

Remote configuration via Fawkes net.

This implementation of the Configuration interface allows for remote access to a Fawkes process implemented using the ConfigurationManager.

The network configuration can operator in two modes. In mirror and in non-mirror mode. The non-mirror mode is recommended if only a few operations have to be carried out like getting only a very few values or setting a single value. The mirror mode is for longer usage periods and on-the-fly updates. In mirror mode the complete configuration is copied once from the Fawkes process and then all updates are incorporated into the local database. You can register change handlers to be notified as soon as someone modifies a value.

Definition at line 49 of file netconf.h.

Constructor & Destructor Documentation

◆ NetworkConfiguration()

fawkes::NetworkConfiguration::NetworkConfiguration ( FawkesNetworkClient c,
unsigned int  mirror_timeout_sec = 15 
)

Constructor.

Parameters
cFawkes network client (thread).
mirror_timeout_sectimeout in seconds for initiating mirroring

Definition at line 78 of file netconf.cpp.

References fawkes::Exception::append(), fawkes::FawkesNetworkClient::connected(), and fawkes::FawkesNetworkClient::register_handler().

◆ ~NetworkConfiguration()

fawkes::NetworkConfiguration::~NetworkConfiguration ( )
virtual

Destructor.

Definition at line 101 of file netconf.cpp.

Member Function Documentation

◆ add_change_handler()

void fawkes::NetworkConfiguration::add_change_handler ( ConfigurationChangeHandler h)
virtual

Add a configuration change handler.

The added handler is called whenever a value changes and the handler desires to get notified for the given component.

Parameters
hconfiguration change handler

Reimplemented from fawkes::Configuration.

Definition at line 1300 of file netconf.cpp.

References fawkes::Configuration::add_change_handler().

◆ connection_died()

void fawkes::NetworkConfiguration::connection_died ( unsigned int  id)
throw (
)
virtual

Client connection died.

This method is used to inform handlers that the connection has died for any reason. No more data can be send and no more messages should be enqueued because it is unclear when they would be sent.

Parameters
idthe id of the calling client

Implements fawkes::FawkesNetworkClientHandler.

Definition at line 1282 of file netconf.cpp.

◆ connection_established()

void fawkes::NetworkConfiguration::connection_established ( unsigned int  id)
throw (
)
virtual

Client has established a connection.

Whenever the client establishes a connection this is signaled to handlers with this method. You can register to a client at any time, you may even enqueue messages to a client while the connection is dead. If the client at some point gets connected again, the messages will then be send out in one go. You should use this in your application though to only send data if the connection is alive and you should let the user know about the connection status.

Parameters
idthe id of the calling client

Implements fawkes::FawkesNetworkClientHandler.

Definition at line 1292 of file netconf.cpp.

◆ copy()

void fawkes::NetworkConfiguration::copy ( Configuration copyconf)
virtual

◆ deregistered()

void fawkes::NetworkConfiguration::deregistered ( unsigned int  id)
throw (
)
virtual

We are no longer registered in Fawkes network client.

Ignored.

Parameters
idthe id of the calling client

Implements fawkes::FawkesNetworkClientHandler.

Definition at line 959 of file netconf.cpp.

◆ erase()

void fawkes::NetworkConfiguration::erase ( const char *  path)
virtual

Erase the given value from the configuration.

It is not an error if the value does not exists before deletion.

Parameters
pathpath to value

Implements fawkes::Configuration.

Definition at line 941 of file netconf.cpp.

Referenced by LaserDeadSpotCalibrator::num_detected_spots(), and ConfigChangeWatcherTool::run().

◆ erase_default()

void fawkes::NetworkConfiguration::erase_default ( const char *  path)
virtual

Erase the given default value from the configuration.

It is not an error if the value does not exists before deletion.

Parameters
pathpath to value

Implements fawkes::Configuration.

Definition at line 948 of file netconf.cpp.

Referenced by LaserDeadSpotCalibrator::num_detected_spots(), and ConfigChangeWatcherTool::run().

◆ exists()

bool fawkes::NetworkConfiguration::exists ( const char *  path)
virtual

Check if a given value exists.

Parameters
pathpath to value
Returns
true if the value exists, false otherwise

Implements fawkes::Configuration.

Definition at line 150 of file netconf.cpp.

References fawkes::Configuration::ValueIterator::valid().

◆ get_bool()

bool fawkes::NetworkConfiguration::get_bool ( const char *  path)
virtual

Get value from configuration which is of type bool.

Parameters
pathpath to value
Returns
value

Implements fawkes::Configuration.

Definition at line 427 of file netconf.cpp.

References fawkes::Exception::append(), fawkes::Exception::Exception(), and fawkes::config_descriptor_t::num_values.

◆ get_bools()

std::vector< bool > fawkes::NetworkConfiguration::get_bools ( const char *  path)
virtual

Get list of values from configuration which is of type bool.

Parameters
pathpath to value
Returns
value

Implements fawkes::Configuration.

Definition at line 556 of file netconf.cpp.

◆ get_comment()

std::string fawkes::NetworkConfiguration::get_comment ( const char *  path)
virtual

Get comment of value at given path.

The value at the given path must exist in the host-specific configuration.

Parameters
pathpath to value
Returns
comment
Exceptions
ConfigEntryNotFoundExceptionshall be thrown if value does not exist
ConfigurationExceptionshall be thrown on any other error

Implements fawkes::Configuration.

Definition at line 569 of file netconf.cpp.

References fawkes::Exception::append(), and fawkes::config_comment_msg_t::s.

◆ get_default_comment()

std::string fawkes::NetworkConfiguration::get_default_comment ( const char *  path)
virtual

Get comment of value at given path.

The value at the given path must exist in the default configuration.

Parameters
pathpath to value
Returns
comment
Exceptions
ConfigEntryNotFoundExceptionshall be thrown if value does not exist
ConfigurationExceptionshall be thrown on any other error

Implements fawkes::Configuration.

Definition at line 619 of file netconf.cpp.

References fawkes::Exception::append(), and fawkes::config_comment_msg_t::s.

◆ get_float()

float fawkes::NetworkConfiguration::get_float ( const char *  path)
virtual

Get value from configuration which is of type float.

Parameters
pathpath to value
Returns
value

Implements fawkes::Configuration.

Definition at line 262 of file netconf.cpp.

References fawkes::Exception::append(), fawkes::Exception::Exception(), and fawkes::config_descriptor_t::num_values.

◆ get_floats()

std::vector< float > fawkes::NetworkConfiguration::get_floats ( const char *  path)
virtual

Get list of values from configuration which is of type float.

Parameters
pathpath to value
Returns
value

Implements fawkes::Configuration.

Definition at line 538 of file netconf.cpp.

◆ get_int()

int fawkes::NetworkConfiguration::get_int ( const char *  path)
virtual

Get value from configuration which is of type int.

Parameters
pathpath to value
Returns
value

Implements fawkes::Configuration.

Definition at line 372 of file netconf.cpp.

References fawkes::Exception::append(), fawkes::Exception::Exception(), and fawkes::config_descriptor_t::num_values.

◆ get_ints()

std::vector< int > fawkes::NetworkConfiguration::get_ints ( const char *  path)
virtual

Get list of values from configuration which is of type int.

Parameters
pathpath to value
Returns
value

Implements fawkes::Configuration.

Definition at line 550 of file netconf.cpp.

◆ get_string()

std::string fawkes::NetworkConfiguration::get_string ( const char *  path)
virtual

Get value from configuration which is of type string.

Parameters
pathpath to value
Returns
value

Implements fawkes::Configuration.

Definition at line 482 of file netconf.cpp.

References fawkes::Exception::append(), fawkes::Exception::Exception(), fawkes::config_descriptor_t::num_values, and fawkes::config_string_value_t::s_length.

◆ get_strings()

std::vector< std::string > fawkes::NetworkConfiguration::get_strings ( const char *  path)
virtual

Get list of values from configuration which is of type string.

Parameters
pathpath to value
Returns
value

Implements fawkes::Configuration.

Definition at line 562 of file netconf.cpp.

◆ get_type()

std::string fawkes::NetworkConfiguration::get_type ( const char *  path)
virtual

Get type of field.

Parameters
pathpath
Returns
string of type

Implements fawkes::Configuration.

Definition at line 174 of file netconf.cpp.

References fawkes::Configuration::ValueIterator::type().

◆ get_uint()

unsigned int fawkes::NetworkConfiguration::get_uint ( const char *  path)
virtual

Get value from configuration which is of type unsigned int.

Parameters
pathpath to value
Returns
value

Implements fawkes::Configuration.

Definition at line 317 of file netconf.cpp.

References fawkes::Exception::append(), fawkes::Exception::Exception(), and fawkes::config_descriptor_t::num_values.

◆ get_uints()

std::vector< unsigned int > fawkes::NetworkConfiguration::get_uints ( const char *  path)
virtual

Get list of values from configuration which is of type unsigned int.

Parameters
pathpath to value
Returns
value

Implements fawkes::Configuration.

Definition at line 544 of file netconf.cpp.

◆ get_value()

Configuration::ValueIterator * fawkes::NetworkConfiguration::get_value ( const char *  path)
virtual

Get value from configuration.

Parameters
pathpath to value
Returns
value iterator for just this one value, maybe invalid if value does not exists.

Implements fawkes::Configuration.

Definition at line 670 of file netconf.cpp.

References fawkes::Exception::append(), fawkes::config_getval_msg_t::cp, fawkes::FawkesNetworkMessage::msgge(), fawkes::config_descriptor_t::num_values, fawkes::config_descriptor_t::path, and fawkes::FawkesNetworkMessage::payload().

Referenced by ConfigChangeWatcherTool::run().

◆ inbound_received()

void fawkes::NetworkConfiguration::inbound_received ( FawkesNetworkMessage m,
unsigned int  id 
)
throw (
)
virtual

Called for incoming messages.

This is called when an incoming message has been received. If this method was called one or more times then the a previously carried out wait(cid) call will continue.

Parameters
mMessage to handle
idthe id of the calling client

Implements fawkes::FawkesNetworkClientHandler.

Definition at line 965 of file netconf.cpp.

References fawkes::config_value_erased_msg_t::cp, fawkes::config_comment_msg_t::cp, fawkes::config_list_entity_header_t::cp, fawkes::ConfigListContent::has_next(), fawkes::config_descriptor_t::is_default, fawkes::LibLogger::log_warn(), fawkes::ConfigListContent::next(), fawkes::config_descriptor_t::num_values, fawkes::config_descriptor_t::path, fawkes::config_comment_msg_t::s, fawkes::config_string_value_t::s_length, and fawkes::config_list_entity_header_t::type.

◆ is_bool()

bool fawkes::NetworkConfiguration::is_bool ( const char *  path)
virtual

Check if a value is of type bool.

Parameters
pathpath to value
Returns
true if the value exists and is of type bool

Implements fawkes::Configuration.

Definition at line 213 of file netconf.cpp.

◆ is_default()

bool fawkes::NetworkConfiguration::is_default ( const char *  path)
virtual

Check if a value was read from the default config.

Parameters
pathpath to value
Returns
true if the value exists and is only stored in the default config

Implements fawkes::Configuration.

Definition at line 160 of file netconf.cpp.

References fawkes::Configuration::ValueIterator::is_default().

◆ is_float()

bool fawkes::NetworkConfiguration::is_float ( const char *  path)
virtual

Check if a value is of type float.

Parameters
pathpath to value
Returns
true if the value exists and is of type float

Implements fawkes::Configuration.

Definition at line 192 of file netconf.cpp.

◆ is_int()

bool fawkes::NetworkConfiguration::is_int ( const char *  path)
virtual

Check if a value is of type int.

Parameters
pathpath to value
Returns
true if the value exists and is of type int

Implements fawkes::Configuration.

Definition at line 206 of file netconf.cpp.

◆ is_list()

bool fawkes::NetworkConfiguration::is_list ( const char *  path)
virtual

Check if a value is a list.

Parameters
pathpath to value
Returns
true if the value exists and is a list

Implements fawkes::Configuration.

Definition at line 226 of file netconf.cpp.

References fawkes::config_getval_msg_t::cp, fawkes::Exception::Exception(), and fawkes::config_descriptor_t::path.

◆ is_string()

bool fawkes::NetworkConfiguration::is_string ( const char *  path)
virtual

Check if a value is of type string.

Parameters
pathpath to value
Returns
true if the value exists and is of type string

Implements fawkes::Configuration.

Definition at line 220 of file netconf.cpp.

◆ is_uint()

bool fawkes::NetworkConfiguration::is_uint ( const char *  path)
virtual

Check if a value is of type unsigned int.

Parameters
pathpath to value
Returns
true if the value exists and is of type unsigned int

Implements fawkes::Configuration.

Definition at line 199 of file netconf.cpp.

◆ iterator()

Configuration::ValueIterator * fawkes::NetworkConfiguration::iterator ( )
virtual

Iterator for all values.

Returns an iterator that can be used to iterate over all values in the current configuration, it will value the overlay. If a default and a host-specific value exists you will only see the host-specific value.

Returns
iterator over all values

Implements fawkes::Configuration.

Definition at line 1401 of file netconf.cpp.

References fawkes::Exception::Exception().

Referenced by ConfigChangeWatcherTool::run().

◆ iterator_default()

Configuration::ValueIterator * fawkes::NetworkConfiguration::iterator_default ( )

Iterator for all default values.

Returns an iterator that can be used to iterate over all default values in the current default configuration. Note that this might return less paths than available, because the values for which no default entry exists are not returned.

Returns
iterator over all default values

Definition at line 1419 of file netconf.cpp.

References fawkes::Exception::Exception().

Referenced by ConfigChangeWatcherTool::run().

◆ iterator_hostspecific()

Configuration::ValueIterator * fawkes::NetworkConfiguration::iterator_hostspecific ( )

Iterator for all host-specific values.

Returns an iterator that can be used to iterate over all host-specific values in the current configuration. Note that this might return less paths than available, because the default values for which no host-specific entry exists are not returned.

Returns
iterator over all host-specific values

Definition at line 1437 of file netconf.cpp.

References fawkes::Exception::Exception().

Referenced by ConfigChangeWatcherTool::run().

◆ load()

void fawkes::NetworkConfiguration::load ( const char *  file_path)
virtual

Load configuration.

Loads configuration data, or opens a file, depending on the implementation. After this call access to all other methods shall be possible.

Parameters
file_pathpath of the configuration file.

Implements fawkes::Configuration.

Definition at line 114 of file netconf.cpp.

◆ lock()

void fawkes::NetworkConfiguration::lock ( )
virtual

Lock the config.

No further changes or queries can be executed on the configuration and will block until the config is unlocked.

Implements fawkes::Configuration.

Definition at line 1374 of file netconf.cpp.

Referenced by ConfigChangeWatcherTool::run().

◆ rem_change_handler()

void fawkes::NetworkConfiguration::rem_change_handler ( ConfigurationChangeHandler h)
virtual

Remove a configuration change handler.

The handler is removed from the change handler list and no longer called on config changes.

Parameters
hconfiguration change handler

Reimplemented from fawkes::Configuration.

Definition at line 1311 of file netconf.cpp.

References fawkes::Configuration::rem_change_handler().

◆ search()

Configuration::ValueIterator * fawkes::NetworkConfiguration::search ( const char *  path)
virtual

Iterator with search results.

Returns an iterator that can be used to iterate over the search results. All values whose path start with the given strings are returned. A call like

config->search("");

is effectively the same as a call to iterator().

Parameters
pathstart of path
Returns
iterator to search results

Implements fawkes::Configuration.

Definition at line 1448 of file netconf.cpp.

References fawkes::Exception::Exception().

Referenced by LaserDeadSpotCalibrator::num_detected_spots().

◆ set_bool()

void fawkes::NetworkConfiguration::set_bool ( const char *  path,
bool  b 
)
virtual

Set new value in configuration of type bool.

Parameters
pathpath to value
bnew bool value

Implements fawkes::Configuration.

Definition at line 793 of file netconf.cpp.

Referenced by ConfigChangeWatcherTool::run().

◆ set_bools()

void fawkes::NetworkConfiguration::set_bools ( const char *  path,
std::vector< bool > &  b 
)
virtual

Set new value in configuration of type bool.

Parameters
pathpath to value
bnew bool values

Implements fawkes::Configuration.

Definition at line 869 of file netconf.cpp.

◆ set_comment() [1/2]

void fawkes::NetworkConfiguration::set_comment ( const char *  path,
std::string &  comment 
)
virtual

Set new comment for existing value.

Parameters
pathpath to value
commentnew comment string

Implements fawkes::Configuration.

Definition at line 901 of file netconf.cpp.

Referenced by ConfigChangeWatcherTool::run().

◆ set_comment() [2/2]

void fawkes::NetworkConfiguration::set_comment ( const char *  path,
const char *  comment 
)
virtual

Set new comment for existing value.

Works like the aforementioned method. Just takes an good ol' char array instead of a std::string.

Parameters
pathpath to value
commentnew comment string

Implements fawkes::Configuration.

Definition at line 889 of file netconf.cpp.

◆ set_default_bool()

void fawkes::NetworkConfiguration::set_default_bool ( const char *  path,
bool  b 
)
virtual

Set new default value in configuration of type bool.

Parameters
pathpath to value
bnew bool value

Implements fawkes::Configuration.

Definition at line 801 of file netconf.cpp.

Referenced by ConfigChangeWatcherTool::run().

◆ set_default_comment() [1/2]

void fawkes::NetworkConfiguration::set_default_comment ( const char *  path,
std::string &  comment 
)
virtual

Set new default comment for existing default configuration value.

Parameters
pathpath to value
commentnew comment string

Implements fawkes::Configuration.

Definition at line 907 of file netconf.cpp.

References fawkes::config_erase_value_msg_t::cp, fawkes::config_descriptor_t::is_default, fawkes::FawkesNetworkMessage::msg(), and fawkes::config_descriptor_t::path.

Referenced by ConfigChangeWatcherTool::run().

◆ set_default_comment() [2/2]

void fawkes::NetworkConfiguration::set_default_comment ( const char *  path,
const char *  comment 
)
virtual

Set new default comment for existing default configuration value.

Works like the aforementioned method. Just takes an good ol' char array instead of a std::string.

Parameters
pathpath to value
commentnew comment string

Implements fawkes::Configuration.

Definition at line 895 of file netconf.cpp.

◆ set_default_float()

void fawkes::NetworkConfiguration::set_default_float ( const char *  path,
float  f 
)
virtual

Set new default value in configuration of type float.

Parameters
pathpath to value
fnew float value

Implements fawkes::Configuration.

Definition at line 758 of file netconf.cpp.

Referenced by ConfigChangeWatcherTool::run().

◆ set_default_int()

void fawkes::NetworkConfiguration::set_default_int ( const char *  path,
int  i 
)
virtual

Set new default value in configuration of type int.

Parameters
pathpath to value
inew int value

Implements fawkes::Configuration.

Definition at line 786 of file netconf.cpp.

Referenced by ConfigChangeWatcherTool::run().

◆ set_default_string() [1/2]

void fawkes::NetworkConfiguration::set_default_string ( const char *  path,
std::string &  s 
)
virtual

Set new default value in configuration of type string.

Parameters
pathpath to value
snew string value

Implements fawkes::Configuration.

Definition at line 844 of file netconf.cpp.

Referenced by ConfigChangeWatcherTool::run().

◆ set_default_string() [2/2]

void fawkes::NetworkConfiguration::set_default_string ( const char *  path,
const char *  s 
)
virtual

Set new default value in configuration of type string.

Works like the aforementioned method. Just takes an good ol' char array instead of a std::string.

Parameters
pathpath to value
snew string value

Implements fawkes::Configuration.

Definition at line 823 of file netconf.cpp.

References fawkes::config_string_value_t::s_length.

◆ set_default_uint()

void fawkes::NetworkConfiguration::set_default_uint ( const char *  path,
unsigned int  uint 
)
virtual

Set new default value in configuration of type unsigned int.

Parameters
pathpath to value
uintnew unsigned int value

Implements fawkes::Configuration.

Definition at line 772 of file netconf.cpp.

Referenced by ConfigChangeWatcherTool::run().

◆ set_float()

void fawkes::NetworkConfiguration::set_float ( const char *  path,
float  f 
)
virtual

Set new value in configuration of type float.

Parameters
pathpath to value
fnew float value

Implements fawkes::Configuration.

Definition at line 751 of file netconf.cpp.

Referenced by LaserDeadSpotCalibrator::num_detected_spots(), and ConfigChangeWatcherTool::run().

◆ set_floats()

void fawkes::NetworkConfiguration::set_floats ( const char *  path,
std::vector< float > &  f 
)
virtual

Set new value in configuration of type float.

Parameters
pathpath to value
fnew float values

Implements fawkes::Configuration.

Definition at line 851 of file netconf.cpp.

◆ set_int()

void fawkes::NetworkConfiguration::set_int ( const char *  path,
int  i 
)
virtual

Set new value in configuration of type int.

Parameters
pathpath to value
inew int value

Implements fawkes::Configuration.

Definition at line 779 of file netconf.cpp.

Referenced by ConfigChangeWatcherTool::run().

◆ set_ints()

void fawkes::NetworkConfiguration::set_ints ( const char *  path,
std::vector< int > &  i 
)
virtual

Set new value in configuration of type int.

Parameters
pathpath to value
inew int values

Implements fawkes::Configuration.

Definition at line 863 of file netconf.cpp.

◆ set_mirror_mode()

void fawkes::NetworkConfiguration::set_mirror_mode ( bool  mirror)
virtual

Enable or disable mirror mode.

Parameters
mirrortrue to enable mirror mode, false to disable

Definition at line 1324 of file netconf.cpp.

References fawkes::CannotEnableMirroringException::CannotEnableMirroringException().

Referenced by LaserDeadSpotCalibrator::num_detected_spots(), and ConfigChangeWatcherTool::run().

◆ set_string() [1/2]

void fawkes::NetworkConfiguration::set_string ( const char *  path,
std::string &  s 
)
virtual

Set new value in configuration of type string.

Parameters
pathpath to value
snew string value

Implements fawkes::Configuration.

Definition at line 837 of file netconf.cpp.

Referenced by ConfigChangeWatcherTool::run().

◆ set_string() [2/2]

void fawkes::NetworkConfiguration::set_string ( const char *  path,
const char *  s 
)
virtual

Set new value in configuration of type string.

Works like the aforementioned method. Just takes an good ol' char array instead of a std::string.

Parameters
pathpath to value
snew string value

Implements fawkes::Configuration.

Definition at line 809 of file netconf.cpp.

References fawkes::config_string_value_t::s_length.

◆ set_strings() [1/2]

void fawkes::NetworkConfiguration::set_strings ( const char *  path,
std::vector< std::string > &  s 
)
virtual

Set new value in configuration of type string.

Parameters
pathpath to value
snew string values

Implements fawkes::Configuration.

Definition at line 875 of file netconf.cpp.

◆ set_strings() [2/2]

void fawkes::NetworkConfiguration::set_strings ( const char *  path,
std::vector< const char *> &  s 
)
virtual

Set new value in configuration of type string.

Works like the aforementioned method. Just takes an good ol' char array instead of a std::string.

Parameters
pathpath to value
snew string values

Implements fawkes::Configuration.

Definition at line 881 of file netconf.cpp.

◆ set_uint()

void fawkes::NetworkConfiguration::set_uint ( const char *  path,
unsigned int  uint 
)
virtual

Set new value in configuration of type unsigned int.

Parameters
pathpath to value
uintnew unsigned int value

Implements fawkes::Configuration.

Definition at line 765 of file netconf.cpp.

Referenced by ConfigChangeWatcherTool::run().

◆ set_uints()

void fawkes::NetworkConfiguration::set_uints ( const char *  path,
std::vector< unsigned int > &  uint 
)
virtual

Set new value in configuration of type unsigned int.

Parameters
pathpath to value
uintnew unsigned int values

Implements fawkes::Configuration.

Definition at line 857 of file netconf.cpp.

◆ try_dump()

void fawkes::NetworkConfiguration::try_dump ( )
virtual

Try to dump configuration.

For configuration methods that transform configuration files in a binary format this can be used to write out the text representation on shutdown of Fawkes.

Exceptions
Exceptionthrown if dumping fails

Implements fawkes::Configuration.

Definition at line 1395 of file netconf.cpp.

◆ try_lock()

bool fawkes::NetworkConfiguration::try_lock ( )
virtual

Try to lock the config.

See also
Configuration::lock()
Returns
true, if the lock has been aquired, false otherwise

Implements fawkes::Configuration.

Definition at line 1381 of file netconf.cpp.

◆ unlock()

void fawkes::NetworkConfiguration::unlock ( )
virtual

Unlock the config.

Modifications and queries are possible again.

Implements fawkes::Configuration.

Definition at line 1388 of file netconf.cpp.

Referenced by ConfigChangeWatcherTool::run().


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