PropertiesStruct Struct Reference

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

#include <Properties.h>


Data Fields

int argc
 Number of argv.
char ** argv
 Pointer on the memory of the passed arguments.
const char * execName
 The executable name.
XmlBlasterPropertiesGetString getString
 Access command line settings of for "myExec -logLevel TRACE". Access a property as a string.
XmlBlasterPropertiesGetBool getBool
 Access a property converted to bool.
XmlBlasterPropertiesGetInt getInt
 Access a property converted to int.
XmlBlasterPropertiesGetLong getLong
 Access a property converted to long.
XmlBlasterPropertiesGetInt64 getInt64
 Access a property converted to a 64 bit long.

Detailed Description

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

Definition at line 34 of file Properties.h.

Field Documentation

int PropertiesStruct::argc

Number of argv.

Definition at line 35 of file Properties.h.

Referenced by createProperties(), dumpProperties(), freeProperties(), and getString().

char** PropertiesStruct::argv

Pointer on the memory of the passed arguments.

Definition at line 36 of file Properties.h.

Referenced by createProperties(), dumpProperties(), freeProperties(), and getString().

const char* PropertiesStruct::execName

The executable name.

Definition at line 37 of file Properties.h.

Referenced by createProperties().

XmlBlasterPropertiesGetString PropertiesStruct::getString

Access command line settings of for "myExec -logLevel TRACE". Access a property as a string.

If the key is not found the environment is checked, if this does not contain the key the defaultValue is returned.

Parameters:
xb The 'this' pointer
key e.g. "logLevel"
defaultValue e.g. "WARN"

Definition at line 46 of file Properties.h.

Referenced by createProperties(), getCallbackServerUnparsed(), getXmlBlasterAccessUnparsed(), getXmlBlasterConnectionUnparsed(), initConnection(), initialize(), main(), and xmlBlasterInitQueue().

XmlBlasterPropertiesGetBool PropertiesStruct::getBool

Access a property converted to bool.

Definition at line 47 of file Properties.h.

Referenced by createProperties(), freeXmlBlasterAccessUnparsed(), getXmlBlasterAccessUnparsed(), initConnection(), and main().

XmlBlasterPropertiesGetInt PropertiesStruct::getInt

Access a property converted to int.

Definition at line 48 of file Properties.h.

Referenced by createProperties(), getCallbackServerUnparsed(), initConnection(), main(), and xmlBlasterInitQueue().

XmlBlasterPropertiesGetLong PropertiesStruct::getLong

Access a property converted to long.

Definition at line 49 of file Properties.h.

Referenced by createProperties(), getXmlBlasterAccessUnparsed(), and main().

XmlBlasterPropertiesGetInt64 PropertiesStruct::getInt64

Access a property converted to a 64 bit long.

Definition at line 50 of file Properties.h.

Referenced by createProperties(), and xmlBlasterInitQueue().

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