nmsg 1.3.1
Data Fields
nmsg_statsmod_plugin Struct Reference

Structure exported by statistics modules. More...

#include <statsmod_plugin.h>

Data Fields

long statsmod_version
 Module interface version.
 
nmsg_statsmod_module_init_fp module_init
 Module-wide initialization function.
 
nmsg_statsmod_module_fini_fp module_fini
 Module-wide finalization function.
 
nmsg_statsmod_add_io_fp io_add
 Add an nmsg_io_t to statsmod instrumentation.
 
nmsg_statsmod_remove_io_fp io_remove
 Remove an nmsg_io_t from statsmod instrumentation.
 

Detailed Description

Structure exported by statistics modules.

Definition at line 124 of file statsmod_plugin.h.

Field Documentation

◆ statsmod_version

long nmsg_statsmod_plugin::statsmod_version

Module interface version.

Must be set to NMSG_FLTMOD_VERSION or the module will be rejected at load time.

Definition at line 130 of file statsmod_plugin.h.

◆ module_init

nmsg_statsmod_module_init_fp nmsg_statsmod_plugin::module_init

Module-wide initialization function.

Required, must not be NULL. Called by nmsg_statsmod_init() on module startup.

Definition at line 136 of file statsmod_plugin.h.

◆ module_fini

nmsg_statsmod_module_fini_fp nmsg_statsmod_plugin::module_fini

Module-wide finalization function.

Required, must not be NULL. Called once at module shutdown by nmsg_statsmod_destroy(). This function must release any resources acquired by 'module_init'.

Definition at line 143 of file statsmod_plugin.h.

◆ io_add

nmsg_statsmod_add_io_fp nmsg_statsmod_plugin::io_add

Add an nmsg_io_t to statsmod instrumentation.

Required, must not be NULL. Called prior to nmsg_io_loop() to export statistics through the statsmod.

Definition at line 150 of file statsmod_plugin.h.

◆ io_remove

nmsg_statsmod_remove_io_fp nmsg_statsmod_plugin::io_remove

Remove an nmsg_io_t from statsmod instrumentation.

Required, must not be NULL.

Definition at line 156 of file statsmod_plugin.h.


The documentation for this struct was generated from the following file: