include/v2l_config.h File Reference

Config handling functions. More...

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

Go to the source code of this file.

Data Structures
struct	v2l_Config
	VCard2LDAP configuration. Shared config for the module API. More...
Defines
#define	V2L_ADMIN   "jabberadmin"
#define	T_CONF   xmlnode
Typedefs
typedef v2l_LdapConn *	v2l_LdapConnPtr
Functions
int	v2l_config_init (v2l_Config *self, xmlnode cfgroot)
void	v2l_config_shutdown (v2l_Config *self)

---

Detailed Description

Config handling functions.

Definition in file v2l_config.h.

---

Define Documentation

#define T_CONF   xmlnode

Type of the jabberd global config. 'xmlnode' for jabberd14, 'config_t' por jabberd2.

Definition at line 36 of file v2l_config.h.

Referenced by v2l_config_init().

#define V2L_ADMIN   "jabberadmin"

The username associated with the master connection

Definition at line 28 of file v2l_config.h.

Referenced by v2l_get_master_conn().

---

Typedef Documentation

typedef struct v2l_LdapConn* v2l_LdapConnPtr

Forward declaration

Definition at line 25 of file v2l_config.h.

---

Function Documentation

int v2l_config_init	(	v2l_Config *	self,
		xmlnode	cfgroot
	)

Reads global config and initialize module config.

Precondition:

jabberd config exists and it's valid.

Postcondition:

all fields of self are set.

Parameters:

	self	Module config.
	cfgroot	Global config. T_CONF type.

Returns:

1 if no error, otherwise returns 0.

void v2l_config_shutdown

(

v2l_Config *

self

)

Shutdown function, closes all connections and frees mempools.

Precondition:

self != NULL and self->master_conn is open.

Postcondition:

self->master_conn closed, all pools freeds.

Parameters:

self

Module config.

Definition at line 148 of file v2l_config.c.

References v2l_LdapConn::ld, v2l_Config::master_conn, v2l_Config::poolref, v2l_LdapConn::poolref, and v2l_free_allconn().

Referenced by _v2l_shutdown().

Here is the call graph for this function:

Here is the caller graph for this function:

---