res_resolver_unbound: Fix config documentation.
[asterisk/asterisk.git] / res / res_snmp.c
index a0be455..7eef9f8 100644 (file)
  *
  * \author Thorsten Lockert <tholo@voop.as>
  *
- * \extref Uses the Net-SNMP libraries available at
+ * Uses the Net-SNMP libraries available at
  *      http://net-snmp.sourceforge.net/
  */
 
+/*! \li \ref res_snmp.c uses the configuration file \ref res_snmp.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*!
+ * \page res_snmp.conf res_snmp.conf
+ * \verbinclude res_snmp.conf.sample
+ */
+
 /*** MODULEINFO
        <depend>netsnmp</depend>
+       <support_level>extended</support_level>
  ***/
 
 #include "asterisk.h"
 
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+ASTERISK_REGISTER_FILE()
 
 #include "asterisk/channel.h"
 #include "asterisk/module.h"
-#include "asterisk/logger.h"
-#include "asterisk/options.h"
 
 #include "snmp/agent.h"
 
@@ -36,20 +44,25 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
 int res_snmp_agentx_subagent;
 int res_snmp_dont_stop;
-int res_snmp_enabled;
+static int res_snmp_enabled;
 
 static pthread_t thread = AST_PTHREADT_NULL;
 
+/*!
+ * \brief Load res_snmp.conf config file
+ * \return 1 on load, 0 file does not exist
+*/
 static int load_config(void)
 {
        struct ast_variable *var;
        struct ast_config *cfg;
+       struct ast_flags config_flags = { 0 };
        char *cat;
 
        res_snmp_enabled = 0;
        res_snmp_agentx_subagent = 1;
-       cfg = ast_config_load("res_snmp.conf");
-       if (!cfg) {
+       cfg = ast_config_load("res_snmp.conf", config_flags);
+       if (cfg == CONFIG_STATUS_FILEMISSING || cfg == CONFIG_STATUS_FILEINVALID) {
                ast_log(LOG_WARNING, "Could not load res_snmp.conf\n");
                return 0;
        }
@@ -90,12 +103,22 @@ static int load_config(void)
        return 1;
 }
 
+/*!
+ * \brief Load the module
+ *
+ * Module loading including tests for configuration or dependencies.
+ * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
+ * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
+ * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the 
+ * configuration file or other non-critical problem return 
+ * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
+ */
 static int load_module(void)
 {
        if(!load_config())
                return AST_MODULE_LOAD_DECLINE;
 
-       ast_verbose(VERBOSE_PREFIX_1 "Loading [Sub]Agent Module\n");
+       ast_verb(1, "Loading [Sub]Agent Module\n");
 
        res_snmp_dont_stop = 1;
        if (res_snmp_enabled)
@@ -106,13 +129,14 @@ static int load_module(void)
 
 static int unload_module(void)
 {
-       ast_verbose(VERBOSE_PREFIX_1 "Unloading [Sub]Agent Module\n");
+       ast_verb(1, "Unloading [Sub]Agent Module\n");
 
        res_snmp_dont_stop = 0;
        return ((thread != AST_PTHREADT_NULL) ? pthread_join(thread, NULL) : 0);
 }
 
-AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "SNMP [Sub]Agent for Asterisk",
-               .load = load_module,
-               .unload = unload_module,
-               );
+AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "SNMP [Sub]Agent for Asterisk",
+       .support_level = AST_MODULE_SUPPORT_EXTENDED,
+       .load = load_module,
+       .unload = unload_module,
+);