res_cdrel_custom.h File Reference

Protected header for the CDR and CEL Custom Backends. More...

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

Go to the source code of this file.

Enumerations
enum	cdrel_backend_type { cdrel_backend_text = 0 , cdrel_backend_db , cdrel_backend_type_end }
enum	cdrel_record_type { cdrel_record_cdr = 0 , cdrel_record_cel , cdrel_record_type_end }

Functions
	AST_VECTOR (cdrel_configs, struct cdrel_config *)
struct cdrel_configs *	cdrel_load_module (enum cdrel_backend_type backend_type, enum cdrel_record_type record_type, const char *config_filename, const char *backend_name, void *logging_cb)
	Perform initial module load.
int	cdrel_logger (struct cdrel_configs *configs, void *data)
	Log a record. The module's logging_cb must call this.
int	cdrel_reload_module (enum cdrel_backend_type backend_type, enum cdrel_record_type record_type, struct cdrel_configs **configs, const char *config_filename)
	Perform module reload.
int	cdrel_unload_module (enum cdrel_backend_type backend_type, enum cdrel_record_type record_type, struct cdrel_configs *configs, const char *backend_name)
	Perform module unload.

Detailed Description

Protected header for the CDR and CEL Custom Backends.

Author

George Joseph gjose.nosp@m.ph@s.nosp@m.angom.nosp@m.a.co.nosp@m.m

Warning

This file should be included only by CDR and CEL backends.

Definition in file res_cdrel_custom.h.

Enumeration Type Documentation

cdrel_backend_type

enum cdrel_backend_type

Enumerator
cdrel_backend_text	Text file: DSV or JSON
cdrel_backend_db	Database (currently only sqlite3)
cdrel_backend_type_end	Sentinel

Definition at line 33 of file res_cdrel_custom.h.

                        {
    cdrel_backend_text = 0, /*!< Text file: DSV or JSON */
    cdrel_backend_db,       /*!< Database (currently only sqlite3) */
    cdrel_backend_type_end, /*!< Sentinel */
};

cdrel_record_type

enum cdrel_record_type

Enumerator
cdrel_record_cdr	Call Detail Records
cdrel_record_cel	Channel Event Log records
cdrel_record_type_end	Sentinel

Definition at line 40 of file res_cdrel_custom.h.

                       {
    cdrel_record_cdr = 0,   /*!< Call Detail Records */
    cdrel_record_cel,       /*!< Channel Event Log records */
    cdrel_record_type_end,  /*!< Sentinel */
};

Function Documentation

AST_VECTOR()

AST_VECTOR	(	cdrel_configs	,
		struct cdrel_config *
	)

cdrel_load_module()

struct cdrel_configs * cdrel_load_module	(	enum cdrel_backend_type	backend_type,
		enum cdrel_record_type	record_type,
		const char *	config_filename,
		const char *	backend_name,
		void *	logging_cb
	)

Perform initial module load.

Needs to be called by each "custom" module

Parameters

backend_type	One of cdrel_backend_type.
record_type	One of cdrel_record_type.
config_filename	The config file name.
backend_name	The name to register the backend as.
logging_cb	The logging callback to register with CDR or CEL.

Returns

A pointer to a VECTOR or config objects read from the config file.

Definition at line 1431 of file res/cdrel_custom/config.c.

{
    struct cdrel_configs *configs = ast_calloc(1, sizeof(*configs));
    if (!configs) {
        return NULL;
    }
    ast_debug(1, "Loading %s %s\n", RECORD_TYPE_STR(record_type), MODULE_TYPE_STR(backend_type));
 
    if (AST_VECTOR_INIT(configs, 5) != 0) {
        cdrel_unload_module(backend_type, record_type, configs, backend_name);
        return NULL;
    }
 
    if (load_config_file(backend_type, record_type, configs, filename, 0) != 0) {
        cdrel_unload_module(backend_type, record_type, configs, backend_name);
        return NULL;
    }
 
    if (register_backend(record_type, backend_name, log_cb)) {
        cdrel_unload_module(backend_type, record_type, configs, backend_name);
        return NULL;
    }
 
    return configs;
}

References ast_calloc, ast_debug, AST_VECTOR_INIT, cdrel_unload_module(), load_config_file(), MODULE_TYPE_STR, NULL, RECORD_TYPE_STR, and register_backend().

Referenced by load_module(), load_module(), load_module(), and load_module().

cdrel_logger()

int cdrel_logger	(	struct cdrel_configs *	configs,
		void *	data
	)

Log a record. The module's logging_cb must call this.

Warning

This function MUST be called with the module's config_lock held for reading to prevent reloads from happening while we're logging.

Parameters

configs	A pointer to the VECTOR of config objects returned by cdrel_load_module.
data	A pointer to an ast_cdr or ast_event object to log.

Return values

0	Success.
-1	Failure.

Definition at line 270 of file loggers.c.

{
    struct ast_channel *dummy = NULL;
    int ix = 0;
    int skip_legacy = 0;
    int res = 0;
 
    for(ix = 0; ix < AST_VECTOR_SIZE(configs); ix++) {
        struct cdrel_config *config = AST_VECTOR_GET(configs, ix);
        void *chan_or_data = NULL;
 
        if (config->config_type == cdrel_config_legacy) {
            if (skip_legacy) {
                continue;
            }
            if (!dummy) {
                dummy = config->dummy_channel_alloc(config, data);
                if (!dummy) {
                    ast_log(LOG_ERROR, "Unable to fabricate channel from CEL event for '%s'\n",
                        config->output_filename);
                    skip_legacy = 1;
                    res--;
                    continue;
                }
            }
            chan_or_data = dummy;
        } else {
            chan_or_data = data;
        }
        res += logger_callbacks[config->backend_type][config->config_type](config, chan_or_data);
    }
 
    if (dummy) {
        ast_channel_unref(dummy);
    }
    return res;
}

References ast_channel_unref, ast_log, AST_VECTOR_GET, AST_VECTOR_SIZE, cdrel_config_legacy, config, dummy(), LOG_ERROR, logger_callbacks, and NULL.

Referenced by custom_log(), custom_log(), custom_log(), and custom_log().

cdrel_reload_module()

int cdrel_reload_module	(	enum cdrel_backend_type	backend_type,
		enum cdrel_record_type	record_type,
		struct cdrel_configs **	configs,
		const char *	config_filename
	)

Perform module reload.

Needs to be called by each "custom" module

Warning

This function MUST be called with the module's config_lock held for writing to prevent reloads from happening while we're logging.

Parameters

backend_type	One of cdrel_backend_type.
record_type	One of cdrel_record_type.
configs	A pointer to the VECTOR of config objects returned by cdrel_load_module.
config_filename	The config file name.

Return values

AST_MODULE_LOAD_SUCCESS
AST_MODULE_LOAD_DECLINE

Definition at line 1391 of file res/cdrel_custom/config.c.

{
    int res = 0;
    struct cdrel_configs *old_configs = *configs;
    struct cdrel_configs *new_configs = NULL;
 
    /*
     * Save new config to a temporary vector to make sure the
     * configs are valid before swapping them in.
     */
    new_configs = ast_malloc(sizeof(*new_configs));
    if (!new_configs) {
        return AST_MODULE_LOAD_DECLINE;
    }
 
    if (AST_VECTOR_INIT(new_configs, AST_VECTOR_SIZE(old_configs)) != 0) {
        return AST_MODULE_LOAD_DECLINE;
    }
 
    res = load_config_file(output_type, record_type, new_configs, filename, 1);
    if (res != 0) {
        AST_VECTOR_RESET(new_configs, config_free);
        AST_VECTOR_PTR_FREE(new_configs);
        return AST_MODULE_LOAD_DECLINE;
    }
 
    /* Now swap the new ones in. */
    *configs = new_configs;
 
    /* Free the old ones. */
    AST_VECTOR_RESET(old_configs, config_free);
    AST_VECTOR_PTR_FREE(old_configs);
 
    return AST_MODULE_LOAD_SUCCESS;
 
 
    return -1;
}

References ast_malloc, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, AST_VECTOR_INIT, AST_VECTOR_PTR_FREE, AST_VECTOR_RESET, AST_VECTOR_SIZE, config_free(), load_config_file(), and NULL.

Referenced by reload(), reload(), reload(), and reload().

cdrel_unload_module()

int cdrel_unload_module	(	enum cdrel_backend_type	backend_type,
		enum cdrel_record_type	record_type,
		struct cdrel_configs *	configs,
		const char *	backend_name
	)

Perform module unload.

Needs to be called by each "custom" module

Warning

This function MUST be called with the module's config_lock held for writing to prevent the module from being unloaded while we're logging.

Parameters

backend_type	One of cdrel_backend_type.
record_type	One of cdrel_record_type.
configs	A pointer to the VECTOR of config objects returned by cdrel_load_module.
backend_name	The backend name to unregister.

Return values

0	Success.
-1	Failure.

Definition at line 1459 of file res/cdrel_custom/config.c.

{
    if (unregister_backend(record_type, backend_name) != 0) {
        return -1;
    }
 
    AST_VECTOR_RESET(configs, config_free);
    AST_VECTOR_PTR_FREE(configs);
 
    return 0;
}

References AST_VECTOR_PTR_FREE, AST_VECTOR_RESET, config_free(), and unregister_backend().

Referenced by cdrel_load_module(), unload_module(), unload_module(), unload_module(), and unload_module().