channelstorage.h File Reference

#include "asterisk.h"
#include "asterisk/channel.h"
#include "asterisk/channel_internal.h"

Include dependency graph for channelstorage.h:

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

Go to the source code of this file.

Data Structures
struct	ast_channelstorage_driver
struct	ast_channelstorage_instance

Macros
#define	AST_CHANNELSTORAGE_DEFAULT_TYPE   "ao2_legacy"
#define	CHANNELSTORAGE_API(_instance, _func, ...)    (_instance)->_func((_instance), ##__VA_ARGS__)

Functions
void	ast_channelstorage_close (struct ast_channelstorage_instance *storage_instance)
const struct ast_channelstorage_driver *	ast_channelstorage_get_driver (const char *driver_name)
int	ast_channelstorage_init (void)
struct ast_channelstorage_instance *	ast_channelstorage_open (const struct ast_channelstorage_driver *storage_driver, const char *instance_name)
int	ast_channelstorage_register_driver (const struct ast_channelstorage_driver *driver_name)
struct ast_channel *	channelstorage_by_exten (struct ast_channelstorage_instance *driver, const char *exten, const char *context, int rdlock)
struct ast_channel *	channelstorage_by_name_or_uniqueid (struct ast_channelstorage_instance *driver, const char *name, int rdlock)
struct ast_channel *	channelstorage_by_name_prefix_or_uniqueid (struct ast_channelstorage_instance *driver, const char *name, size_t name_len, int rdlock)
struct ast_channel *	channelstorage_by_uniqueid (struct ast_channelstorage_instance *driver, const char *uniqueid, int rdlock)
int	channelstorage_exten_cb (void *obj, void *arg, void *data, int flags)
int	channelstorage_name_cb (void *obj, void *arg, void *data, int flags)
int	channelstorage_uniqueid_cb (void *obj, void *arg, void *data, int flags)

Macro Definition Documentation

AST_CHANNELSTORAGE_DEFAULT_TYPE

#define AST_CHANNELSTORAGE_DEFAULT_TYPE   "ao2_legacy"

Definition at line 30 of file channelstorage.h.

CHANNELSTORAGE_API

#define CHANNELSTORAGE_API	(		_instance,
			_func,
			...
	)		(_instance)->_func((_instance), ##__VA_ARGS__)

Definition at line 72 of file channelstorage.h.

Function Documentation

ast_channelstorage_close()

void ast_channelstorage_close

(

struct ast_channelstorage_instance *

storage_instance

)

Definition at line 65 of file channelstorage.c.

{
    CHANNELSTORAGE_API(storage_instance, close_instance);
};

References CHANNELSTORAGE_API, and close_instance().

Referenced by ast_channel_close_storage(), and channels_shutdown().

ast_channelstorage_get_driver()

const struct ast_channelstorage_driver * ast_channelstorage_get_driver

(

const char *

driver_name

)

Definition at line 34 of file channelstorage.c.

{
    int i;
 
    for (i = 0; i < AST_VECTOR_SIZE(&storage_drivers); i++) {
        const struct ast_channelstorage_driver *dt =
            AST_VECTOR_GET(&storage_drivers, i);
        if (strcasecmp(driver_name, dt->driver_name) == 0) {
            return dt;
        }
    }
    return NULL;
}

References AST_VECTOR_GET, AST_VECTOR_SIZE, ast_channelstorage_driver::driver_name, NULL, and storage_drivers.

Referenced by internal_channel_set_current_storage_driver().

ast_channelstorage_init()

int ast_channelstorage_init

(

void

)

Definition at line 443 of file channelstorage.c.

{
#ifdef TEST_FRAMEWORK
    /* Tests run in the reverse order registered */
    REGISTER_STORAGE_TEST(cpp_map_name_id);
    AST_TEST_REGISTER(ao2_legacy);
#endif
    ast_register_cleanup(channelstorage_shutdown);
 
    return 0;
}

References ast_register_cleanup(), AST_TEST_REGISTER, and channelstorage_shutdown().

Referenced by ast_channels_init().

ast_channelstorage_open()

struct ast_channelstorage_instance * ast_channelstorage_open	(	const struct ast_channelstorage_driver *	storage_driver,
		const char *	instance_name
	)

Definition at line 49 of file channelstorage.c.

{
    struct ast_channelstorage_instance *storage_instance = NULL;
 
    storage_instance = storage_driver->open_instance(instance_name);
    if (!storage_instance) {
        ast_log(LOG_ERROR, "Failed to open channel storage driver '%s'\n",
            storage_driver->driver_name);
        return NULL;
    }
 
    return storage_instance;
};

References ast_log, ast_channelstorage_driver::driver_name, LOG_ERROR, NULL, and ast_channelstorage_driver::open_instance.

Referenced by ast_channel_open_storage().

ast_channelstorage_register_driver()

int ast_channelstorage_register_driver

(

const struct ast_channelstorage_driver *

driver_name

)

Definition at line 25 of file channelstorage.c.

{
    if (storage_drivers.elems == NULL) {
        AST_VECTOR_INIT(&storage_drivers, 10);
    }
    return AST_VECTOR_APPEND(&storage_drivers, driver_type);
}

References AST_VECTOR_APPEND, AST_VECTOR_INIT, driver_type, NULL, and storage_drivers.

Referenced by __startup().

channelstorage_by_exten()

struct ast_channel * channelstorage_by_exten	(	struct ast_channelstorage_instance *	driver,
		const char *	exten,
		const char *	context,
		int	rdlock
	)

Definition at line 87 of file channelstorage.c.

{
    char *l_exten = (char *) exten;
    char *l_context = (char *) context;
 
    return CHANNELSTORAGE_API(driver, callback, channelstorage_exten_cb, l_context, l_exten, 0, rdlock);
}

References callback(), CHANNELSTORAGE_API, channelstorage_exten_cb(), ast_channel::context, and ast_channel::exten.

channelstorage_by_name_or_uniqueid()

struct ast_channel * channelstorage_by_name_or_uniqueid	(	struct ast_channelstorage_instance *	driver,
		const char *	name,
		int	rdlock
	)

Definition at line 116 of file channelstorage.c.

{
    return CHANNELSTORAGE_API(driver, get_by_name_prefix_or_uniqueid, name, 0, rdlock);
}

References CHANNELSTORAGE_API, and name.

channelstorage_by_name_prefix_or_uniqueid()

struct ast_channel * channelstorage_by_name_prefix_or_uniqueid	(	struct ast_channelstorage_instance *	driver,
		const char *	name,
		size_t	name_len,
		int	rdlock
	)

Definition at line 122 of file channelstorage.c.

{
    struct ast_channel *chan = NULL;
 
    chan = CHANNELSTORAGE_API(driver, get_by_name_prefix, name, name_len, rdlock);
    if (chan) {
        return chan;
    }
 
    if (name_len == 0) {
        chan = CHANNELSTORAGE_API(driver, get_by_uniqueid, name, rdlock);
    }
 
    return chan;
}

References CHANNELSTORAGE_API, get_by_name_prefix(), get_by_uniqueid(), name, and NULL.

channelstorage_by_uniqueid()

struct ast_channel * channelstorage_by_uniqueid	(	struct ast_channelstorage_instance *	driver,
		const char *	uniqueid,
		int	rdlock
	)

Definition at line 152 of file channelstorage.c.

{
    return CHANNELSTORAGE_API(driver, callback, channelstorage_uniqueid_cb, (char *)uniqueid, NULL, 0, rdlock);
}

References callback(), CHANNELSTORAGE_API, channelstorage_uniqueid_cb(), NULL, and ast_channel::uniqueid.

channelstorage_exten_cb()

int channelstorage_exten_cb	(	void *	obj,
		void *	arg,
		void *	data,
		int	flags
	)

Definition at line 70 of file channelstorage.c.

{
    struct ast_channel *chan = (struct ast_channel *)obj;
    const char *context = (const char *)arg;
    const char *exten = (const char *)data;
    int ret = 0;
 
    ao2_lock(chan);
    if (strcasecmp(ast_channel_context(chan), context) == 0 &&
        strcasecmp(ast_channel_exten(chan), exten) == 0) {
        ret = CMP_MATCH | ((flags & OBJ_MULTIPLE) ? 0 : CMP_STOP);
    }
    ao2_unlock(chan);
 
    return ret;
}

References ao2_lock, ao2_unlock, ast_channel_context(), ast_channel_exten(), CMP_MATCH, CMP_STOP, ast_channel::context, ast_channel::data, ast_channel::exten, ast_channel::flags, and OBJ_MULTIPLE.

Referenced by channelstorage_by_exten().

channelstorage_name_cb()

int channelstorage_name_cb	(	void *	obj,
		void *	arg,
		void *	data,
		int	flags
	)

Definition at line 96 of file channelstorage.c.

{
    struct ast_channel *chan = obj;
    const char *name = arg;
    size_t name_len = *(size_t *) data;
    int ret = 0;
 
    if (name_len == 0) {
        if(strcasecmp(ast_channel_name(chan), name) == 0) {
            ret = CMP_MATCH | ((flags & OBJ_MULTIPLE) ? 0 : CMP_STOP);
        }
    } else {
        if (strncasecmp(ast_channel_name(chan), name, name_len) == 0) {
            ret = CMP_MATCH | ((flags & OBJ_MULTIPLE) ? 0 : CMP_STOP);
        }
    }
 
    return ret;
}

References ast_channel_name(), CMP_MATCH, CMP_STOP, ast_channel::data, ast_channel::flags, name, and OBJ_MULTIPLE.

channelstorage_uniqueid_cb()

int channelstorage_uniqueid_cb	(	void *	obj,
		void *	arg,
		void *	data,
		int	flags
	)

Definition at line 139 of file channelstorage.c.

{
    struct ast_channel *chan = obj;
    char *uniqueid = arg;
    int ret = 0;
 
    if(strcasecmp(ast_channel_uniqueid(chan), uniqueid) == 0) {
        ret = CMP_MATCH | CMP_STOP;
    }
 
    return ret;
}

References ast_channel_uniqueid(), CMP_MATCH, CMP_STOP, and ast_channel::uniqueid.

Referenced by channelstorage_by_uniqueid().