module_mgmt.h File Reference

#include <stdbool.h>

Go to the source code of this file.

Functions
bool	mod_module_mgmt_init (bool *module_error)
const char *	mod_get_vendor_module_loaded (void)
void	mod_module_mgmt_cleanup (void)

Detailed Description

Functionality to load vendor module and register namespaces.

The namespaces have functions which can be called by the vendor module.

Definition in file module_mgmt.h.

Function Documentation

mod_get_vendor_module_loaded()

const char* mod_get_vendor_module_loaded

(

void

)

Return the name of the vendor module the plugin loaded at startup.

Returns

the name of that vendor module upon success

NULL if the plugin failed to load the vendor module at startup

Definition at line 326 of file module_mgmt.c.

                                               {
 
    return s_module_so ? amxc_string_get(&s_module_name, 0) : NULL;
}

Here is the caller graph for this function:

mod_module_mgmt_cleanup()

void mod_module_mgmt_cleanup

(

void

)

Clean up the module_mgmt part of this plugin.

The function does the reverse of mod_module_mgmt_init():

• unload the vendor module
• unregisters the namespaces 'pon_stat' and 'pon_cfg'

The plugin must call this function once when stopping.

Definition at line 340 of file module_mgmt.c.

                                   {
 
    if(s_module_so) {
        if(amxm_so_close(&s_module_so)) {
            SAH_TRACEZ_ERROR(ME, "Failed to close module");
        }
    }
 
    if(s_pon_stat_module) {
        amxm_module_deregister(&s_pon_stat_module);
    }
    if(s_pon_cfg_module) {
        amxm_module_deregister(&s_pon_cfg_module);
    }
    amxc_string_clean(&s_module_name);
}

Here is the caller graph for this function:

mod_module_mgmt_init()

bool mod_module_mgmt_init

(

bool *

module_error

)

Initialize the module_mgmt part of this plugin.

The function:

• registers the namespaces 'pon_stat' and 'pon_cfg'. The namespaces have functions which can be called by the vendor module.
• loads the vendor module.

The plugin must call this function once at startup.

Parameters

[in,out]

module_error

the function sets it to true if it encounters an error regarding (the loading of) the vendor module

Returns

true on success, else false

Definition at line 299 of file module_mgmt.c.

                                              {
 
    amxc_string_init(&s_module_name, 0);
 
    if(!register_pon_stat_module()) {
        return false;
    }
 
    if(!register_pon_cfg_module()) {
        return false;
    }
 
    if(!load_vendor_module()) {
        if(module_error) {
            *module_error = true;
        }
        return false;
    }
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function: