Directory Service Functions

Collaboration diagram for Directory Service Functions:

Functions
switch_status_t	switch_core_directory_open (switch_directory_handle_t *dh, char *module_name, char *source, char *dsn, char *passwd, switch_memory_pool_t *pool)
	Open a directory handle. More...
switch_status_t	switch_core_directory_query (switch_directory_handle_t *dh, char *base, char *query)
	Query a directory handle. More...
switch_status_t	switch_core_directory_next (switch_directory_handle_t *dh)
	Obtain the next record in a lookup. More...
switch_status_t	switch_core_directory_next_pair (switch_directory_handle_t *dh, char **var, char **val)
	Obtain the next name/value pair in the current record. More...
switch_status_t	switch_core_directory_close (switch_directory_handle_t *dh)
	Close an open directory handle. More...

Detailed Description

Function Documentation

switch_core_directory_close()

switch_status_t switch_core_directory_close

(

switch_directory_handle_t *

dh

)

Close an open directory handle.

Parameters

dh	a directory handle to close

Returns

SWITCH_STATUS_SUCCESS if handle was closed

Definition at line 76 of file switch_core_directory.c.

References switch_directory_interface::directory_close, switch_directory_handle::directory_interface, switch_directory_handle::memory_pool, switch_core_destroy_memory_pool, SWITCH_DIRECTORY_FLAG_FREE_POOL, switch_test_flag, and UNPROTECT_INTERFACE.

{
        switch_status_t status;

        status = dh->directory_interface->directory_close(dh);
        UNPROTECT_INTERFACE(dh->directory_interface);

        if (switch_test_flag(dh, SWITCH_DIRECTORY_FLAG_FREE_POOL)) {
                switch_core_destroy_memory_pool(&dh->memory_pool);
        }

        return status;
}

switch_core_directory_next()

switch_status_t switch_core_directory_next

(

switch_directory_handle_t *

dh

)

Obtain the next record in a lookup.

Parameters

dh	a directory handle to use

Returns

SWITCH_STATUS_SUCCESS if another record exists

Definition at line 66 of file switch_core_directory.c.

References switch_directory_handle::directory_interface, and switch_directory_interface::directory_next.

{
        return dh->directory_interface->directory_next(dh);
}

switch_core_directory_next_pair()

switch_status_t switch_core_directory_next_pair	(	switch_directory_handle_t *	dh,
		char **	var,
		char **	val
	)

Obtain the next name/value pair in the current record.

Parameters

dh	a directory handle to use
var	a pointer to pointer of the name to fill in
val	a pointer to pointer of the value to fill in

Returns

SWITCH_STATUS_SUCCESS if an item exists

Definition at line 71 of file switch_core_directory.c.

References switch_directory_handle::directory_interface, and switch_directory_interface::directory_next_pair.

{
        return dh->directory_interface->directory_next_pair(dh, var, val);
}

switch_core_directory_open()

switch_status_t switch_core_directory_open	(	switch_directory_handle_t *	dh,
		char *	module_name,
		char *	source,
		char *	dsn,
		char *	passwd,
		switch_memory_pool_t *	pool
	)

Open a directory handle.

Parameters

dh	a directory handle to use
module_name	the directory module to use
source	the source of the db (ip, hostname, path etc)
dsn	the username or designation of the lookup
passwd	the password
pool	the pool to use (NULL for new pool)

Returns

SWITCH_STATUS_SUCCESS if the handle is opened

Definition at line 38 of file switch_core_directory.c.

References switch_directory_handle::directory_interface, switch_directory_interface::directory_open, switch_directory_handle::memory_pool, pool, SWITCH_CHANNEL_LOG, switch_core_new_memory_pool, SWITCH_DIRECTORY_FLAG_FREE_POOL, switch_loadable_module_get_directory_interface(), SWITCH_LOG_ERROR, switch_log_printf(), switch_set_flag, SWITCH_STATUS_GENERR, SWITCH_STATUS_SUCCESS, and UNPROTECT_INTERFACE.

{
        switch_status_t status;

        if ((dh->directory_interface = switch_loadable_module_get_directory_interface(module_name)) == 0) {
                switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "Invalid directory module [%s]!\n", module_name);
                return SWITCH_STATUS_GENERR;
        }

        if (pool) {
                dh->memory_pool = pool;
        } else {
                if ((status = switch_core_new_memory_pool(&dh->memory_pool)) != SWITCH_STATUS_SUCCESS) {
                        UNPROTECT_INTERFACE(dh->directory_interface);
                        return status;
                }
                switch_set_flag(dh, SWITCH_DIRECTORY_FLAG_FREE_POOL);
        }

        return dh->directory_interface->directory_open(dh, source, dsn, passwd);
}

switch_core_directory_query()

switch_status_t switch_core_directory_query	(	switch_directory_handle_t *	dh,
		char *	base,
		char *	query
	)

Query a directory handle.

Parameters

dh	a directory handle to use
base	the base to query against
query	a string of filters or query data

Returns

SWITCH_STATUS_SUCCESS if the query is successful

Definition at line 61 of file switch_core_directory.c.

References switch_directory_handle::directory_interface, and switch_directory_interface::directory_query.

{
        return dh->directory_interface->directory_query(dh, base, query);
}