util/Properties.h File Reference

#include <util/basicDefs.h>

Include dependency graph for Properties.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  PropertiesStruct
 All client access to Properties goes over this struct and its function pointers. More...

Typedefs

typedef PropertiesStruct Properties
typedef const char *(*) XmlBlasterPropertiesGetString (Properties *xb, const char *key, const char *defaultValue)
typedef int(*) XmlBlasterPropertiesGetBool (Properties *xb, const char *key, int defaultValue)
typedef int(*) XmlBlasterPropertiesGetInt (Properties *xb, const char *key, int defaultValue)
typedef long(*) XmlBlasterPropertiesGetLong (Properties *xb, const char *key, long defaultValue)
typedef int64_t(*) XmlBlasterPropertiesGetInt64 (Properties *xb, const char *key, int64_t defaultValue)

Functions

PropertiescreateProperties (int argc, const char *const *argv)
 Get an instance of this Properties struct.
void freeProperties (Properties *props)
 Free your instance after accessing xmlBlaster.
void dumpProperties (Properties *props)
 Dump properties to console, for debugging only.


Typedef Documentation

typedef struct PropertiesStruct Properties

Definition at line 22 of file Properties.h.

typedef int( * ) XmlBlasterPropertiesGetBool(Properties *xb, const char *key, int defaultValue)

Definition at line 26 of file Properties.h.

typedef int( * ) XmlBlasterPropertiesGetInt(Properties *xb, const char *key, int defaultValue)

Definition at line 27 of file Properties.h.

typedef int64_t( * ) XmlBlasterPropertiesGetInt64(Properties *xb, const char *key, int64_t defaultValue)

Definition at line 29 of file Properties.h.

typedef long( * ) XmlBlasterPropertiesGetLong(Properties *xb, const char *key, long defaultValue)

Definition at line 28 of file Properties.h.

typedef const char*( * ) XmlBlasterPropertiesGetString(Properties *xb, const char *key, const char *defaultValue)

Definition at line 25 of file Properties.h.


Function Documentation

Properties* createProperties ( int  argc,
const char *const *  argv 
)

Get an instance of this Properties struct.

NOTE: Every call creates a new and independent instance

Parameters:
argc Number of argv entries
argv The first entry is expected to be the executable name, the others are tuples of form "-logLevel" "TRACE"
Returns:
NULL if bootstrapping failed. If not NULL you need to free() it when you are done usually by calling freeProperties().

void dumpProperties ( Properties props  ) 

Dump properties to console, for debugging only.

Definition at line 78 of file Properties.c.

References PropertiesStruct::argc, and PropertiesStruct::argv.

void freeProperties ( Properties props  ) 

Free your instance after accessing xmlBlaster.

Definition at line 63 of file Properties.c.

References PropertiesStruct::argc, and PropertiesStruct::argv.

Referenced by freeCallbackServerUnparsed(), freeXmlBlasterAccessUnparsed(), and freeXmlBlasterConnectionUnparsed().