Bayonne2 / Common C++ 2 Framework
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions
ost::StaticKeydata Class Reference

Bayonnne specific static keydata class. More...

#include <bayonne.h>

Inheritance diagram for ost::StaticKeydata:
Inheritance graph
[legend]
Collaboration diagram for ost::StaticKeydata:
Collaboration graph
[legend]

Public Member Functions

 StaticKeydata (const char *path, Keydata::Define *defkeys=NULL, const char *homepath=NULL)
 
const char * getString (const char *id)
 
long getValue (const char *id)
 
bool getBoolean (const char *id)
 
unsigned getIndex (char **data, unsigned max)
 Get an index array of ALL keywords that are stored by the current keydata object. More...
 
void load (const char *keypath)
 Load additional key values into the currrent object from the specfied config source (a config file/section pair). More...
 
void load (Define *pairs)
 Load default keywords into the current object. More...
 
void loadPrefix (const char *prefix, const char *keypath)
 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...
 
void unlink (void)
 Unlink the keydata object from the cache file stream. More...
 
int getCount (const char *sym)
 Get a count of the number of data "values" that is associated with a specific keyword. More...
 
unsigned getCount (void)
 Get the count of keyword indexes that are actually available so one can allocate a table to receive getIndex. More...
 
const char * getFirst (const char *sym)
 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...
 
bool isKey (const char *sym)
 Find if a given key exists. More...
 
const char * getString (const char *sym, const char *def=NULL)
 Get a string value, with an optional default if missing. More...
 
long getLong (const char *sym, long def=0)
 Get a long value, with an optional default if missing. More...
 
bool getBool (const char *key)
 Get a bool value. More...
 
double getDouble (const char *key, double def=0.)
 Get a floating value. More...
 
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...
 
void clrValue (const char *sym)
 Clear all values associated with a given keyword. More...
 
const char * operator[] (const char *keyword)
 A convient notation for accessing the keydata as an associative array of keyword/value pairs through the [] operator. More...
 

Static Public Member Functions

static void end (void)
 static member to end keydata i/o allocations. More...
 

Protected Member Functions

KeysymgetSymbol (const char *sym, bool create)
 
virtual void * first (size_t size)
 Allocate first workspace from paged memory. More...
 
char * first (char *str)
 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...
 
void purge (void)
 purge the current memory pool. More...
 
void clean (void)
 Clean for memory cleanup before exiting. More...
 
int getPages (void)
 Return the total number of pages that have been allocated for this memory pool. More...
 

Detailed Description

Bayonnne specific static keydata class.

This is used for configuration keys which cannot be reloaded at runtime.

Author
David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org Static Keydata

Definition at line 159 of file bayonne.h.

Constructor & Destructor Documentation

ost::StaticKeydata::StaticKeydata ( const char *  path,
Keydata::Define defkeys = NULL,
const char *  homepath = NULL 
)

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
sizesize 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
strstring 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
sizesize 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
strstring 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
symkeyword name.
Returns
true or false.
bool ost::StaticKeydata::getBoolean ( const char *  id)
inline

Definition at line 170 of file bayonne.h.

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
symkeyword 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
symkeyword name.
defaultif 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
symkeyword 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
datapointer of array to hold keyword strings.
maxnumber of entries the array can hold.
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
symkeyword 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
symkeyword name to fetch.
long Keydata::getLong ( const char *  sym,
long  def = 0 
)
inherited

Get a long value, with an optional default if missing.

Parameters
symkeyword name.
defaultif not present.
Returns
long value of 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.

const char* ost::StaticKeydata::getString ( const char *  id)
inline

Definition at line 164 of file bayonne.h.

const char* Keydata::getString ( const char *  sym,
const char *  def = NULL 
)
inherited

Get a string value, with an optional default if missing.

Parameters
symkeyword name.
defaultif not present.
Returns
string value of key.
Keysym* Keydata::getSymbol ( const char *  sym,
bool  create 
)
protectedinherited
long ost::StaticKeydata::getValue ( const char *  id)
inline

Definition at line 167 of file bayonne.h.

bool Keydata::isKey ( const char *  sym)
inherited

Find if a given key exists.

Parameters
symkeyword to find.
Returns
true if exists.
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)
inherited

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
pairslist 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
filepathto load from
keyssection to parse from, or NULL to parse from head
preoptional 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 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
symkeyword name to set.
datastring to store for the keyword.
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().


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