Wed Oct 28 11:53:10 2009

Asterisk developer's documentation


res_snmp.c File Reference

SNMP Agent / SubAgent support for Asterisk. More...

#include "asterisk.h"
#include "asterisk/channel.h"
#include "asterisk/module.h"
#include "snmp/agent.h"

Include dependency graph for res_snmp.c:

Go to the source code of this file.

Defines

#define MODULE_DESCRIPTION   "SNMP [Sub]Agent for Asterisk"

Functions

static void __reg_module (void)
static void __unreg_module (void)
static int load_config (void)
 Load res_snmp.conf config file.
static int load_module (void)
static int unload_module (void)

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS , .description = "SNMP [Sub]Agent for Asterisk" , .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, }
static struct ast_module_infoast_module_info = &__mod_info
int res_snmp_agentx_subagent
int res_snmp_dont_stop
int res_snmp_enabled
static pthread_t thread = AST_PTHREADT_NULL


Detailed Description

SNMP Agent / SubAgent support for Asterisk.

Author:
Thorsten Lockert <tholo@voop.as>
ExtRef:
Uses the Net-SNMP libraries available at http://net-snmp.sourceforge.net/

Definition in file res_snmp.c.


Define Documentation

#define MODULE_DESCRIPTION   "SNMP [Sub]Agent for Asterisk"

Definition at line 33 of file res_snmp.c.


Function Documentation

static void __reg_module ( void   )  [static]

Definition at line 121 of file res_snmp.c.

static void __unreg_module ( void   )  [static]

Definition at line 121 of file res_snmp.c.

static int load_config ( void   )  [static]

Load res_snmp.conf config file.

Returns:
1 on load, 0 file does not exist

Definition at line 45 of file res_snmp.c.

References ast_category_browse(), ast_config_destroy(), ast_config_load, ast_false(), ast_log(), ast_true(), ast_variable_browse(), LOG_ERROR, LOG_WARNING, ast_variable::name, ast_variable::next, ast_variable::value, and var.

00046 {
00047    struct ast_variable *var;
00048    struct ast_config *cfg;
00049    struct ast_flags config_flags = { 0 };
00050    char *cat;
00051 
00052    res_snmp_enabled = 0;
00053    res_snmp_agentx_subagent = 1;
00054    cfg = ast_config_load("res_snmp.conf", config_flags);
00055    if (!cfg) {
00056       ast_log(LOG_WARNING, "Could not load res_snmp.conf\n");
00057       return 0;
00058    }
00059    cat = ast_category_browse(cfg, NULL);
00060    while (cat) {
00061       var = ast_variable_browse(cfg, cat);
00062 
00063       if (strcasecmp(cat, "general") == 0) {
00064          while (var) {
00065             if (strcasecmp(var->name, "subagent") == 0) {
00066                if (ast_true(var->value))
00067                   res_snmp_agentx_subagent = 1;
00068                else if (ast_false(var->value))
00069                   res_snmp_agentx_subagent = 0;
00070                else {
00071                   ast_log(LOG_ERROR, "Value '%s' does not evaluate to true or false.\n", var->value);
00072                   ast_config_destroy(cfg);
00073                   return 1;
00074                }
00075             } else if (strcasecmp(var->name, "enabled") == 0) {
00076                res_snmp_enabled = ast_true(var->value);
00077             } else {
00078                ast_log(LOG_ERROR, "Unrecognized variable '%s' in category '%s'\n", var->name, cat);
00079                ast_config_destroy(cfg);
00080                return 1;
00081             }
00082             var = var->next;
00083          }
00084       } else {
00085          ast_log(LOG_ERROR, "Unrecognized category '%s'\n", cat);
00086          ast_config_destroy(cfg);
00087          return 1;
00088       }
00089 
00090       cat = ast_category_browse(cfg, cat);
00091    }
00092    ast_config_destroy(cfg);
00093    return 1;
00094 }

static int load_module ( void   )  [static]

Definition at line 96 of file res_snmp.c.

References AST_MODULE_LOAD_DECLINE, ast_pthread_create_background, ast_verb, and load_config().

00097 {
00098    if(!load_config())
00099       return AST_MODULE_LOAD_DECLINE;
00100 
00101    ast_verb(1, "Loading [Sub]Agent Module\n");
00102 
00103    res_snmp_dont_stop = 1;
00104    if (res_snmp_enabled)
00105       return ast_pthread_create_background(&thread, NULL, agent_thread, NULL);
00106    else
00107       return 0;
00108 }

static int unload_module ( void   )  [static]

Definition at line 110 of file res_snmp.c.

References AST_PTHREADT_NULL, and ast_verb.

00111 {
00112    ast_verb(1, "Unloading [Sub]Agent Module\n");
00113 
00114    res_snmp_dont_stop = 0;
00115    return ((thread != AST_PTHREADT_NULL) ? pthread_join(thread, NULL) : 0);
00116 }


Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS , .description = "SNMP [Sub]Agent for Asterisk" , .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, } [static]

Definition at line 121 of file res_snmp.c.

Definition at line 121 of file res_snmp.c.

Definition at line 35 of file res_snmp.c.

Definition at line 36 of file res_snmp.c.

Definition at line 37 of file res_snmp.c.

pthread_t thread = AST_PTHREADT_NULL [static]

Definition at line 39 of file res_snmp.c.


Generated on Wed Oct 28 11:53:11 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6