NetBurner 3.5.6
PDF Version
config_obj.h File Reference

Configuration object header file. More...

#include <buffers.h>
#include <nbstring.h>
#include <string.h>
#include <utils.h>
#include <limits.h>
#include <float.h>
#include <plat_cfg_types.h>

Go to the source code of this file.

Classes

class  config_obj
 Base class used to create configuration objects. More...
 
class  config_value
 Base class used to create a configuration value. More...
 
class  config_uint
 Unsigned 32-bit Integer Configuration Variable. More...
 
class  config_int
 Signed 32-bit Integer Configuration Variable. More...
 
class  config_double
 Double Float Configuration Variable. More...
 
class  config_bool
 Boolean Configuration Variable. More...
 
class  config_string
 String Configuration Variable. More...
 
class  config_pass
 Password string Configuration Variable. More...
 
class  config_IPADDR4
 Configuration Variable for IPADDR4 (IPv4) object types. More...
 
class  config_IPADDR
 Configuration Variable for IPADDR (IPv6) object type. More...
 
class  config_MACADR
 Configuration Variable for MACADR object type. More...
 
class  config_chooser
 Chooser Configuration Variable - Select From a List of Items. More...
 
class  config_int_limit
 A config_int with minimum and/or maximum values Attempting to set a value lower than the minimum or greater than the maximum will fail with an error both programmatically and in the Config Web UI. More...
 
class  config_uint_limit
 A config_uint with minimum and/or maximum values Attempting to set a value lower than the minimum or greater than the maximum will fail with an error both programmatically and in the Config Web UI. More...
 
class  config_double_limit
 A config_double with minimum and/or maximum values Attempting to set a value lower than the minimum or greater than the maximum will fail with an error both programmatically and in the Config Web UI. More...
 
class  config_string_limit
 A config_string with minimum and/or maximum lengths Attempting to set a value shorter than the minimum or longer than the maximum will fail with an error both programmatically and in the Config Web UI. More...
 
class  config_pass_limit
 A config_pass with minimum and/or maximum lengths Attempting to set a value shorter than the minimum or longer than the maximum will fail with an error both programmatically and in the Config Web UI. More...
 

Functions

void SaveConfigToStorage ()
 Save configuration to flash storage.
 
void OverrideConfig ()
 Create this function to override config settings.
 

Variables

const uint32_t fConfigValueLeaf = 0x01
 Value is a leaf.
 
const uint32_t fConfigReadOnly = 0x02
 Variable is read-only.
 
const uint32_t fConfigModified = 0x04
 Variable has been modified, but not yet saved.
 
const uint32_t fConfigHidden = 0x08
 Not visible to configuration web server display.
 
const uint32_t fConfigNoSave = 0x10
 Do not save to flash memory when save functions are called.
 
const uint32_t fConfigNoObscure = 0x20
 Do not obscure the value.
 
const uint32_t fConfigNeedReboot = 0x40
 System reboot required for changes to take effect.
 
const uint32_t fConfigNoReload = 0x80
 Disable reloading value from flash during a call to ReloadFromFlash.
 
const uint32_t fConfigDetached = 0x100
 Disable reloading value from flash during a call to ReloadFromFlash.
 
const uint32_t fConfigIsDefault = 0x200
 Value is unchanged from the default, i.e. wes never set.
 
const uint32_t fMaskDoingSave = 0x40000000
 We're currently executing a config save to non-volatile storage.
 

Detailed Description

Configuration object header file.