Bayonne specific reloaded keydata class.
More...
#include <bayonne.h>
Inheritance diagram for ost::ReconfigKeydata:
Collaboration diagram for ost::ReconfigKeydata:
Public Member Functions
const char *
getString (const char *key, char *buf, size_t size)
bool
isKey (const char *key)
const char *
getString (const char *sym, const char *def=NULL)
Get a string value, with an optional default if missing.
More...
unsigned
getIndex (char **data, unsigned max)
Get an index array of ALL keywords that are stored by the current keydata object.
More...
Load additional key values into the currrent object from the specfied config source (a config file/section pair).
More...
Load default keywords into the current object.
More...
Load additional key values into the currrent object from the specfied config source (a config file/section pair).
More...
void
loadFile (const char *filepath, const char *
keys=NULL, const char *pre=NULL)
Load additional keys into the current object using a real filename that is directly passed rather than a computed key path.
More...
Unlink the keydata object from the cache file stream.
More...
Get a count of the number of data "values" that is associated with a specific keyword.
More...
Get the count of keyword indexes that are actually available so one can allocate a table to receive getIndex.
More...
Get the first data value for a given keyword.
More...
const char *
getLast (const char *sym)
Get the last (most recently set) value for a given keyword.
More...
long
getLong (const char *sym, long def=0)
Get a long value, with an optional default if missing.
More...
double
getDouble (const char *key, double def=0.)
void
setValue (const char *sym, const char *data)
Set (replace) the value of a given keyword.
More...
const char *const *
getList (const char *sym)
Return a list of all values set for the given keyword returned in order.
More...
Clear all values associated with a given keyword.
More...
A convient notation for accessing the keydata as an associative array of keyword/value pairs through the [] operator.
More...
Static Public Member Functions
static member to end keydata i/o allocations.
More...
Protected Member Functions
virtual void *
first (size_t size)
Allocate first workspace from paged memory.
More...
Allocate a string from the memory pager pool and copy the string into it's new memory area.
More...
virtual void *
alloc (size_t size)
Allocate memory from either the currently active page, or allocate a new page for the object.
More...
char *
alloc (const char *str)
Allocate a string from the memory pager pool and copy the string inti it's new memory area.
More...
purge the current memory pool.
More...
Clean for memory cleanup before exiting.
More...
Return the total number of pages that have been allocated for this memory pool.
More...
Aquire a read lock for the current object.
More...
Aquire a write lock for the current object.
More...
Attempt read lock for current object.
More...
Attempt write lock for current object.
More...
Static Protected Member Functions
Detailed Description
Constructor & Destructor Documentation
ost::ReconfigKeydata::ReconfigKeydata
(
const char *
keypath,
)
Member Function Documentation
virtual void* MemPager::alloc
(
size_t
size )
protectedvirtualinherited
Allocate memory from either the currently active page, or allocate a new page for the object.
- Parameters
-
size size of memory to allocate.
- Returns
- pointer to allocated memory.
Reimplemented in SharedMemPager.
char* MemPager::alloc
(
const char *
str )
protectedinherited
Allocate a string from the memory pager pool and copy the string inti it's new memory area.
This checks only the last active page for available space before allocating a new page.
- Parameters
-
str string to allocate and copy into paged memory pool.
- Returns
- copy of string from allocated memory.
void MemPager::clean
(
void
)
protectedinherited
Clean for memory cleanup before exiting.
void Keydata::clrValue
(
const char *
sym )
inherited
Clear all values associated with a given keyword.
This does not de-allocate the keyword from memory, however.
- Returns
- keyword name to clear.
static void Keydata::end
(
void
)
staticinherited
static member to end keydata i/o allocations.
virtual void* MemPager::first
(
size_t
size )
protectedvirtualinherited
Allocate first workspace from paged memory.
This method scans all currently allocated blocks for available space before adding new pages and hence is both slower and more efficient.
- Parameters
-
size size of memory to allocate.
- Returns
- pointer to allocated memory.
Reimplemented in SharedMemPager.
char* MemPager::first
(
char *
str )
protectedinherited
Allocate a string from the memory pager pool and copy the string into it's new memory area.
This method allocates memory by first searching for an available page, and then allocating a new page if no space is found.
- Parameters
-
str string to allocate and copy into paged memory pool.
- Returns
- copy of string from allocated memory.
bool Keydata::getBool
(
const char *
key )
inherited
Get a bool value.
- Parameters
-
sym keyword name.
- Returns
- true or false.
bool ost::ReconfigKeydata::getBoolean
(
const char *
key )
int Keydata::getCount
(
const char *
sym )
inherited
Get a count of the number of data "values" that is associated with a specific keyword.
Each value is from an accumulation of "<code>load()</code>" requests.
- Parameters
-
sym keyword symbol name.
- Returns
- count of values associated with keyword.
unsigned Keydata::getCount
(
void
)
inherited
Get the count of keyword indexes that are actually available so one can allocate a table to receive getIndex.
- Returns
- number of keywords found.
double Keydata::getDouble
(
const char *
key,
double
def = 0.
)
inherited
Get a floating value.
- Parameters
-
sym keyword name.
default if not set.
- Returns
- value of key.
const char* Keydata::getFirst
(
const char *
sym )
inherited
Get the first data value for a given keyword.
This will typically be the /etc set global default.
- Parameters
-
sym keyword symbol name.
- Returns
- first set value for this symbol.
unsigned Keydata::getIndex
(
char **
data,
unsigned
max
)
inherited
Get an index array of ALL keywords that are stored by the current keydata object.
- Returns
- number of keywords found.
- Parameters
-
data pointer of array to hold keyword strings.
max number of entries the array can hold.
const char* ost::ReconfigKeydata::getInitial
(
const char *
id )
inline
const char* Keydata::getLast
(
const char *
sym )
inherited
Get the last (most recently set) value for a given keyword.
This is typically the value actually used.
- Parameters
-
sym keyword symbol name.
- Returns
- last set value for this symbol.
const char* const* Keydata::getList
(
const char *
sym )
inherited
Return a list of all values set for the given keyword returned in order.
- Returns
- list pointer of array holding all keyword values.
- Parameters
-
sym keyword name to fetch.
long Keydata::getLong
(
const char *
sym,
long
def = 0
)
inherited
Get a long value, with an optional default if missing.
- Parameters
-
sym keyword name.
default if not present.
- Returns
- long value of key.
timeout_t ost::ReconfigKeydata::getMsecTimer
(
const char *
key )
int MemPager::getPages
(
void
)
inlineinherited
Return the total number of pages that have been allocated for this memory pool.
- Returns
- number of pages allocated.
Definition at line 181 of file misc.h.
timeout_t ost::ReconfigKeydata::getSecTimer
(
const char *
key )
const char* ost::StaticKeydata::getString
(
const char *
id )
inlineinherited
const char* ost::ReconfigKeydata::getString
(
const char *
key,
char *
buf,
size_t
size
)
const char* Keydata::getString
(
const char *
sym,
const char *
def = NULL
)
inherited
Get a string value, with an optional default if missing.
- Parameters
-
sym keyword name.
default if not present.
- Returns
- string value of key.
Keysym* Keydata::getSymbol
(
const char *
sym,
bool
create
)
protectedinherited
long ost::ReconfigKeydata::getValue
(
const char *
key )
bool ost::ReconfigKeydata::isKey
(
const char *
key )
void Keydata::load
(
const char *
keypath )
inherited
Load additional key values into the currrent object from the specfied config source (a config file/section pair).
These values will overlay the current keywords when matches are found. This can be used typically in a derived config object class constructor to first load a /etc section, and then load a matching user specific entry from ~/. to override default system values with user specific keyword values.
- Parameters
-
keypath (filepath/section)
void Keydata::load
(
Define *
pairs )
Load default keywords into the current object.
This only loads keyword entries which have not already been defined to reduce memory usage. This form of Load is also commonly used in the constructor of a derived Keydata class.
- Parameters
-
pairs list of NULL terminated default keyword/value pairs.
void Keydata::loadFile
(
const char *
filepath,
const char *
keys = NULL,
const char *
pre = NULL
)
inherited
Load additional keys into the current object using a real filename that is directly passed rather than a computed key path.
This also uses a [keys] section as passed to the object.
- Parameters
-
filepath to load from
keys section to parse from, or NULL to parse from head
pre optional key prefix
void Keydata::loadPrefix
(
const char *
prefix,
const char *
keypath
)
inherited
Load additional key values into the currrent object from the specfied config source (a config file/section pair).
These values will overlay the current keywords when matches are found. This can be used typically in a derived config object class constructor to first load a /etc section, and then load a matching user specific entry from ~/. to override default system values with user specific keyword values. This varient puts a prefix in front of the key name.
- Parameters
-
prefix
keypath (filepath/section)
const char* Keydata::operator[]
(
const char *
keyword )
inlineinherited
A convient notation for accessing the keydata as an associative array of keyword/value pairs through the [] operator.
Definition at line 611 of file misc.h.
void MemPager::purge
(
void
)
protectedinherited
purge the current memory pool.
void ThreadLock::readLock
(
void
)
inherited
Aquire a read lock for the current object.
static void ost::DynamicKeydata::reload
(
void
)
staticinherited
void ost::ReconfigKeydata::setInitial
(
const char *
id,
const char *
val
)
inline
void Keydata::setValue
(
const char *
sym,
const char *
data
)
inherited
Set (replace) the value of a given keyword.
This new value will become the value returned from getLast(), while the prior value will still be stored and found from getList() .
- Parameters
-
sym keyword name to set.
data string to store for the keyword.
bool ThreadLock::tryReadLock
(
void
)
inherited
Attempt read lock for current object.
- Returns
- true on success.
bool ThreadLock::tryWriteLock
(
void
)
inherited
Attempt write lock for current object.
- Returns
- true on success.
void Keydata::unlink
(
void
)
inherited
Unlink the keydata object from the cache file stream.
This should be used if you plan to keepa Keydata object after it is loaded once all keydata objects have been loaded, otherwise the cfgFile stream will remain open. You can also use endKeydata().
void ThreadLock::unlock
(
void
)
inherited
virtual void ost::DynamicKeydata::updateConfig
(
Keydata *
keydata )
bool ost::ReconfigKeydata::updatedBoolean
(
const char *
id )
protected
timeout_t ost::ReconfigKeydata::updatedMsecTimer
(
const char *
id )
protected
timeout_t ost::ReconfigKeydata::updatedSecTimer
(
const char *
id )
protected
const char* ost::ReconfigKeydata::updatedString
(
const char *
id )
protected
long ost::ReconfigKeydata::updatedValue
(
const char *
id )
protected
void ThreadLock::writeLock
(
void
)
inherited
Aquire a write lock for the current object.
The documentation for this class was generated from the following file: