Collaboration diagram for LDAP Database Driver:

Data Structures

struct ld_cmd
Extension structure of db_cmd adding LDAP specific data. More...
struct ld_con
A structure representing a connection to a LDAP server. More...
struct ld_uri
LDAP driver specific payload to attach to db_uri structures. More...
struct sbuf
Reallocatable string buffer. More...

Files

file ld_cmd.c
Implementation of functions related to database commands.
file ld_cmd.h
Declaration of ld_cmd data structure that contains LDAP specific data stored in db_cmd structures and related functions.
file ld_con.c
Functions related to connections to LDAP servers.
file ld_con.h
Implementation of LDAP per-connection related data structures and functions.
file ld_fld.c
Data field conversion and type checking functions.
file ld_fld.h
Implementation of ld_fld data structure representing LDAP fields and related functions.
file ld_mod.c
LDAP module interface.
file ld_mod.h
LDAP module interface.
file ld_res.c
Functions working with result structures received from LDAP servers.
file ld_res.h
Data structures and functions to convert results obtained from LDAP servers.
file ld_uri.c
The implementation of parser parsing ldap:.
file ld_uri.h
The functions parsing and interpreting ldap: URIs.

Defines

#define cmpstr(s1, s2, f) ((s1)!=(s2)) && ((s1)==0 || (s2)==0 || (f)((s1), (s2))!=0)
compare s1 & s2 with a function f (which should return 0 if ==); s1 & s2 can be null return 0 if match, 1 if not

Enumerations

enum ld_con_flags { LD_CONNECTED = (1 << 0) }
Per-connection flags for LDAP connections.
More...

Functions

static int dupl_string (char **dst, const char *begin, const char *end)
Duplicate a string.
int ld_cmd (db_cmd_t *cmd)
Creates a new ld_cmd data structure.
int ld_cmd_exec (db_res_t *res, db_cmd_t *cmd)
The main execution function in ldap SER driver.
static void ld_cmd_free (db_cmd_t *cmd, struct ld_cmd *payload)
Destroys a ld_cmd structure.
int ld_con (db_con_t *con)
Create a new ld_con structure.
int ld_con_connect (db_con_t *con)
Establish a new connection to server.
void ld_con_disconnect (db_con_t *con)
Disconnected from LDAP server.
static void ld_con_free (db_con_t *con, struct ld_con *payload)
Free all memory allocated for a ld_con structure.
int ld_fld (db_fld_t *fld, char *table)
Creates a new LDAP specific payload.
static void ld_fld_free (db_fld_t *fld, struct ld_fld *payload)
Frees memory used by a ld_fld structure.
int ld_uri (db_uri_t *uri)
Create a new ld_uri structure and parse the URI in parameter.
static unsigned char ld_uri_cmp (db_uri_t *uri1, db_uri_t *uri2)
Compares two LDAP connection URIs.
static char * pkgstrdup (str *s)
Duplicate a string.

Enumeration Type Documentation

enum ld_con_flags

Enumerator:

LD_CONNECTED

The connection has been connected successfully.

Definition at line 46 of file ld_con.h.

Function Documentation

int ld_cmd ( db_cmd_t * cmd )

This function allocates and initializes memory for a new ld_cmd data structure. The data structure is then attached to the generic db_cmd structure in cmd parameter.

Parameters:

cmd

A generic db_cmd structure to which the newly created ld_cmd structure will be attached.

int ld_cmd_exec	(	db_res_t *	res,
		db_cmd_t *	cmd
	)

This is the main execution function in this driver. It is executed whenever a SER module calls db_exec and the target database of the commands is ldap.

Parameters:

res

A pointer to (optional) result structure if the command returns a result.

Return values:

	0	if executed successfully
	A	negative number if the database server failed to execute command
	A	positive number if there was an error on client side (SER)

static void ld_cmd_free	(	db_cmd_t *	cmd,
		struct ld_cmd *	payload
	)			`[static]`

This function frees all memory used by ld_cmd structure.

Parameters:

	cmd	A pointer to generic db_cmd command being freed.
	payload	A pointer to ld_cmd structure to be freed.

Definition at line 53 of file ld_cmd.c.

References ld_cmd::gen, and ld_cmd::result.

int ld_con ( db_con_t * con )

This function creates a new ld_con structure and attachs the structure to the generic db_con structure in the parameter.

Parameters:

con

A generic db_con structure to be extended with LDAP payload

Return values:

	0	on success
	A	negative number on error

int ld_con_connect ( db_con_t * con )

This function is called when a SER module calls db_connect to establish a new connection to the database server.

Parameters:

con

A structure representing database connection.

Return values:

	0	on success.
	A	negative number on error.

void ld_con_disconnect ( db_con_t * con )

Disconnects a previously connected connection to LDAP server.

Parameters:

con

A structure representing the connection to be disconnected.

static void ld_con_free	(	db_con_t *	con,
		struct ld_con *	payload
	)			`[static]`

This function function frees all memory that is in use by a ld_con structure.

Parameters:

	con	A generic db_con connection structure.
	payload	LDAP specific payload to be freed.

Definition at line 51 of file ld_con.c.

References ld_uri::uri.

int ld_fld	(	db_fld_t *	fld,
		char *	table
	)

This function creates a new LDAP specific payload structure and attaches the structure to the generic db_fld structure.

Parameters:

	fld	A generic db_fld structure to be exended.
	table	Name of the table on the server.

Return values:

	0	on success.
	A	negative number on error.

static void ld_fld_free	(	db_fld_t *	fld,
		struct ld_fld *	payload
	)			`[static]`

This function frees all memory used by a ld_fld structure

Parameters:

	fld	Generic db_fld_t* structure being freed.
	payload	The ldap extension structure to be freed

Definition at line 150 of file ld_fld.c.

int ld_uri ( db_uri_t * uri )

This function builds a new ld_uri structure from the body of the generic URI given to it in parameter.

Parameters:

uri

A generic db_uri structure.

Return values:

	0	on success
	A	negative number on error.

static unsigned char ld_uri_cmp	(	db_uri_t *	uri1,
		db_uri_t *	uri2
	)			`[static]`

This function is called whenever the database abstraction layer in SER needs to compare to URIs with the ldap scheme. The function compares hosts and port numbers of both URIs (host part comparison is case insensitive). The URI comparison is mainly used to by the connection pool to determine if a connection to a given server already exists.

Definition at line 57 of file ld_uri.c.

References cmpstr, and ld_uri::ldap_url.

LDAP Database Driver [Database Abstraction Layer]

Data Structures

Files

Defines

Enumerations

Functions

Enumeration Type Documentation

Function Documentation

LDAP Database Driver
[Database Abstraction Layer]