include/razorback/config_file.h File Reference

Razorback Configuration API. More...

#include <razorback/visibility.h>
#include <razorback/types.h>
#include <libconfig.h>

Include dependency graph for config_file.h:

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

Go to the source code of this file.

Data Structures
struct	RZBConfCallBack
	Configuration callbacks. More...
struct	ConfArray
struct	RZBConfKey_t
	Configuration file entry definition. More...
struct	ConfList
Typedefs
typedef long	conf_int_t
Enumerations
enum	RZB_CONF_KEY_TYPE_t {   RZB_CONF_KEY_TYPE_STRING = 5, RZB_CONF_KEY_TYPE_INT, RZB_CONF_KEY_TYPE_PARSED_STRING, RZB_CONF_KEY_TYPE_UUID,   RZB_CONF_KEY_TYPE_BOOL, RZB_CONF_KEY_TYPE_ARRAY, RZB_CONF_KEY_TYPE_LIST, RZB_CONF_KEY_TYPE_END }
	Avaliable types to read from the config file. More...
Functions
SO_PUBLIC bool	readMyConfig (const char *configDir, const char *configFile, RZBConfKey_t *config)
	Read a component configuration file.
SO_PUBLIC void	rzbConfCleanUp (void)
	Clean the memory allocated by readApiConfig and readMyConfig.

---

Detailed Description

Razorback Configuration API.

---

Enumeration Type Documentation

enum RZB_CONF_KEY_TYPE_t

Avaliable types to read from the config file.

Enumerator:

RZB_CONF_KEY_TYPE_STRING	A String.
RZB_CONF_KEY_TYPE_INT	A signed int.
RZB_CONF_KEY_TYPE_PARSED_STRING	A string with a callback to turn it into an int.
RZB_CONF_KEY_TYPE_UUID	A UUID in string format.
RZB_CONF_KEY_TYPE_BOOL	A Bool in string format.
RZB_CONF_KEY_TYPE_ARRAY	An array of simple items.
RZB_CONF_KEY_TYPE_LIST	An list of complex items.
RZB_CONF_KEY_TYPE_END	End of block marker.

---

Function Documentation

SO_PUBLIC bool readMyConfig	(	const char *	configDir,
		const char *	configFile,
		RZBConfKey_t *	config
	)

Read a component configuration file.

Parameters:

	*configDir	the dir to look in
	*configFile	the file read
	*config	the structure of the file.

Returns:

true on success false on error

Examples:

read_config.c.

SO_PUBLIC void rzbConfCleanUp

(

void

)

Clean the memory allocated by readApiConfig and readMyConfig.