ModuleInfo Struct Reference

#include <module.h>

Data Fields

char * name
char * version
char * author
long abi
int(* mod_register )(void)
void(* mod_unregister )(void)

Detailed Description

ModInfo - This structure holds module specific information, this is information that is not held to be true at all times, since the modules interact with it given that it is only used for basic checks :)

Parameters:
name - The module name -> This is just for personal referance as the core relies on aboslute paths to find and remove modules.
version - The modules version in free form
abi - The Binary interface version, this is the version of the API used to interact with this module.
mod_register - The function called by the core when loading the module, and takes place in the registeration phase of the load.

NOTE: this is a required function - Modules will fail to load if this is not specified.

Parameters:
mod_unregister - The function used when unloading a module from the core, takes place before the dlclose function is called, in the un-register phase

NOTE: This function is not required modules, however will not unload if this is not specified.

Definition at line 193 of file module.h.


Field Documentation

long abi

Definition at line 200 of file module.h.

char* author

Definition at line 198 of file module.h.

int(* mod_register)(void)

Definition at line 202 of file module.h.

Referenced by module_open().

void(* mod_unregister)(void)

Definition at line 204 of file module.h.

Referenced by module_close(), and purge_modules().

char* name

Definition at line 194 of file module.h.

char* version

Definition at line 196 of file module.h.


The documentation for this struct was generated from the following file:
Generated on Mon Jul 19 21:53:05 2010 for Omega Security Services by  doxygen 1.6.3