func_srv.c File Reference

SRV Functions. More...

#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/srv.h"
#include "asterisk/pbx.h"
#include "asterisk/app.h"
#include "asterisk/datastore.h"
#include "asterisk/channel.h"

Include dependency graph for func_srv.c:

Go to the source code of this file.

Data Structures
struct	srv_result_datastore

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static int	load_module (void)
static void	srds_destroy_cb (void *data)
static struct srv_context *	srv_datastore_setup (const char *service, struct ast_channel *chan)
static int	srv_query_read (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
static int	srv_result_read (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "SRV related dialplan functions" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct ast_custom_function	srv_query_function
static const struct ast_datastore_info	srv_result_datastore_info
static struct ast_custom_function	srv_result_function

Detailed Description

SRV Functions.

Author

Mark Michelson mmich.nosp@m.elso.nosp@m.n@dig.nosp@m.ium..nosp@m.com

Definition in file func_srv.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 295 of file func_srv.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 295 of file func_srv.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 295 of file func_srv.c.

load_module()

static int load_module ( void  )

static

Definition at line 281 of file func_srv.c.

{
    int res = ast_custom_function_register(&srv_query_function);
    if (res < 0) {
        return AST_MODULE_LOAD_DECLINE;
    }
    res = ast_custom_function_register(&srv_result_function);
    if (res < 0) {
        return AST_MODULE_LOAD_DECLINE;
    }
 
    return AST_MODULE_LOAD_SUCCESS;;
}

References ast_custom_function_register, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, srv_query_function, and srv_result_function.

srds_destroy_cb()

static void srds_destroy_cb ( void *  data )

static

Definition at line 97 of file func_srv.c.

{
    struct srv_result_datastore *datastore = data;
    ast_srv_cleanup(&datastore->context);
    ast_free(datastore);
}

References ast_free, ast_srv_cleanup(), and srv_result_datastore::context.

srv_datastore_setup()

static struct srv_context * srv_datastore_setup ( const char *  service, struct ast_channel *  chan  )

static

Definition at line 109 of file func_srv.c.

{
    struct srv_result_datastore *srds;
    struct ast_datastore *datastore;
    const char *host;
    unsigned short port;
 
    if (!(srds = ast_calloc(1, sizeof(*srds) + strlen(service)))) {
        return NULL;
    }
 
    ast_autoservice_start(chan);
    if (ast_srv_lookup(&srds->context, service, &host, &port) < 0) {
        ast_autoservice_stop(chan);
        ast_log(LOG_NOTICE, "Error performing lookup of service '%s'\n", service);
        ast_free(srds);
        return NULL;
    }
    ast_autoservice_stop(chan);
 
    strcpy(srds->id, service);
 
    if (!(datastore = ast_datastore_alloc(&srv_result_datastore_info, srds->id))) {
        ast_srv_cleanup(&srds->context);
        ast_free(srds);
        return NULL;
    }
 
    datastore->data = srds;
    ast_channel_lock(chan);
    ast_channel_datastore_add(chan, datastore);
    ast_channel_unlock(chan);
    return srds->context;
}

References ast_autoservice_start(), ast_autoservice_stop(), ast_calloc, ast_channel_datastore_add(), ast_channel_lock, ast_channel_unlock, ast_datastore_alloc, ast_free, ast_log, ast_srv_cleanup(), ast_srv_lookup(), srv_result_datastore::context, ast_datastore::data, srv_result_datastore::id, LOG_NOTICE, NULL, service, and srv_result_datastore_info.

Referenced by srv_query_read(), and srv_result_read().

srv_query_read()

static int srv_query_read ( struct ast_channel *  chan, const char *  cmd, char *  data, char *  buf, size_t  len  )

static

Definition at line 144 of file func_srv.c.

{
    struct ast_datastore *datastore;
 
    if (!chan) {
        ast_log(LOG_WARNING, "%s cannot be used without a channel\n", cmd);
        return -1;
    }
 
    if (ast_strlen_zero(data)) {
        ast_log(LOG_WARNING, "%s requires a service as an argument\n", cmd);
        return -1;
    }
 
    /* If they already called SRVQUERY for this service once,
     * we need to kill the old datastore.
     */
    ast_channel_lock(chan);
    datastore = ast_channel_datastore_find(chan, &srv_result_datastore_info, data);
    ast_channel_unlock(chan);
 
    if (datastore) {
        ast_channel_datastore_remove(chan, datastore);
        ast_datastore_free(datastore);
    }
 
    if (!srv_datastore_setup(data, chan)) {
        return -1;
    }
 
    ast_copy_string(buf, data, len);
 
    return 0;
}

References ast_channel_datastore_find(), ast_channel_datastore_remove(), ast_channel_lock, ast_channel_unlock, ast_copy_string(), ast_datastore_free(), ast_log, ast_strlen_zero(), buf, ast_datastore::data, len(), LOG_WARNING, srv_datastore_setup(), and srv_result_datastore_info.

srv_result_read()

static int srv_result_read ( struct ast_channel *  chan, const char *  cmd, char *  data, char *  buf, size_t  len  )

static

Definition at line 184 of file func_srv.c.

{
    struct srv_result_datastore *srds;
    struct ast_datastore *datastore;
    struct srv_context *srv_context;
    char *parse;
    const char *host;
    unsigned short port, priority, weight;
    unsigned int num;
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(id);
        AST_APP_ARG(resultnum);
        AST_APP_ARG(field);
    );
 
    if (!chan) {
        ast_log(LOG_WARNING, "%s cannot be used without a channel\n", cmd);
        return -1;
    }
 
    if (ast_strlen_zero(data)) {
        ast_log(LOG_WARNING, "%s requires two arguments (id and resultnum)\n", cmd);
        return -1;
    }
 
    parse = ast_strdupa(data);
 
    AST_STANDARD_APP_ARGS(args, parse);
 
    ast_channel_lock(chan);
    datastore = ast_channel_datastore_find(chan, &srv_result_datastore_info, args.id);
    ast_channel_unlock(chan);
 
    if (!datastore) {
        /* They apparently decided to call SRVRESULT without first calling SRVQUERY.
         * No problem, we'll do the SRV lookup now.
         */
        srv_context = srv_datastore_setup(args.id, chan);
        if (!srv_context) {
            return -1;
        }
    } else {
        srds = datastore->data;
        srv_context = srds->context;
    }
 
    if (!strcasecmp(args.resultnum, "getnum")) {
        snprintf(buf, len, "%u", ast_srv_get_record_count(srv_context));
        return 0;
    }
 
    if (ast_strlen_zero(args.field)) {
        ast_log(LOG_ERROR, "A field must be provided when requesting SRV data\n");
        return -1;
    }
 
    if (sscanf(args.resultnum, "%30u", &num) != 1) {
        ast_log(LOG_ERROR, "Invalid value '%s' for resultnum to %s\n", args.resultnum, cmd);
        return -1;
    }
 
    if (ast_srv_get_nth_record(srv_context, num, &host, &port, &priority, &weight)) {
        ast_log(LOG_ERROR, "Failed to get record number %u for %s\n", num, cmd);
        return -1;
    }
 
    if (!strcasecmp(args.field, "host")) {
        ast_copy_string(buf, host, len);
    } else if (!strcasecmp(args.field, "port")) {
        snprintf(buf, len, "%d", port);
    } else if (!strcasecmp(args.field, "priority")) {
        snprintf(buf, len, "%d", priority);
    } else if (!strcasecmp(args.field, "weight")) {
        snprintf(buf, len, "%d", weight);
    } else {
        ast_log(LOG_WARNING, "Unrecognized SRV field '%s'\n", args.field);
        return -1;
    }
 
    return 0;
}

References args, AST_APP_ARG, ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, ast_copy_string(), AST_DECLARE_APP_ARGS, ast_log, ast_srv_get_nth_record(), ast_srv_get_record_count(), AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), buf, srv_result_datastore::context, ast_datastore::data, len(), LOG_ERROR, LOG_WARNING, priority, srv_datastore_setup(), srv_result_datastore_info, and weight.

unload_module()

static int unload_module ( void  )

static

Definition at line 271 of file func_srv.c.

{
    int res = 0;
 
    res |= ast_custom_function_unregister(&srv_query_function);
    res |= ast_custom_function_unregister(&srv_result_function);
 
    return res;
}

References ast_custom_function_unregister(), srv_query_function, and srv_result_function.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "SRV related dialplan functions" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }

static

Definition at line 295 of file func_srv.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 295 of file func_srv.c.

srv_query_function

struct ast_custom_function srv_query_function

static

Initial value:

= {
    .name = "SRVQUERY",
    .read = srv_query_read,
}

Definition at line 179 of file func_srv.c.

Referenced by load_module(), and unload_module().

srv_result_datastore_info

const struct ast_datastore_info srv_result_datastore_info

static

Initial value:

= {
    .type = "SRVQUERY",
    .destroy = srds_destroy_cb,
}

Definition at line 104 of file func_srv.c.

Referenced by srv_datastore_setup(), srv_query_read(), and srv_result_read().

srv_result_function

struct ast_custom_function srv_result_function

static

Initial value:

= {
    .name = "SRVRESULT",
    .read = srv_result_read,
}

Definition at line 266 of file func_srv.c.

Referenced by load_module(), and unload_module().