Structure exported by filter modules. More...

#include <fltmod_plugin.h>

Data Fields
long	fltmod_version
	Module interface version.

nmsg_fltmod_module_init_fp	module_init
	Module-wide initialization function.

nmsg_fltmod_module_fini_fp	module_fini
	Module-wide finalization function.

nmsg_fltmod_thread_init_fp	thread_init
	Per-thread initialization function.

nmsg_fltmod_thread_fini_fp	thread_fini
	Per-thread finalization function.

nmsg_fltmod_filter_message_fp	filter_message
	Message filter function.

Detailed Description

Structure exported by filter modules.

Definition at line 190 of file fltmod_plugin.h.

Field Documentation

◆ fltmod_version

long nmsg_fltmod_plugin::fltmod_version

Module interface version.

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

Definition at line 196 of file fltmod_plugin.h.

◆ module_init

nmsg_fltmod_module_init_fp nmsg_fltmod_plugin::module_init

Module-wide initialization function.

Optional, may be NULL. If this function exists, it will be called once at module startup by nmsg_fltmod_init().

Definition at line 203 of file fltmod_plugin.h.

◆ module_fini

nmsg_fltmod_module_fini_fp nmsg_fltmod_plugin::module_fini

Module-wide finalization function.

Optional, may be NULL. If this function exists, it will be called once at module shutdown by nmsg_fltmod_destroy(). This function should clean up any resources acquired by 'module_init'.

Definition at line 211 of file fltmod_plugin.h.

◆ thread_init

nmsg_fltmod_thread_init_fp nmsg_fltmod_plugin::thread_init

Per-thread initialization function.

Optional, may be NULL. If this function exists, it will be called by each thread that wants to perform message filtering via nmsg_fltmod_thread_init().

Definition at line 218 of file fltmod_plugin.h.

◆ thread_fini

nmsg_fltmod_thread_fini_fp nmsg_fltmod_plugin::thread_fini

Per-thread finalization function.

Optional, may be NULL. If this function exists, it will be called by each thread that has called 'thread_init' before the thread exits by nmsg_fltmod_thread_fini(). This function should clean up any resources acquired by 'thread_init'.

Definition at line 227 of file fltmod_plugin.h.

◆ filter_message

nmsg_fltmod_filter_message_fp nmsg_fltmod_plugin::filter_message

Message filter function.

Required, must not be NULL. This function is called by nmsg_fltmod_filter_message().

Definition at line 233 of file fltmod_plugin.h.

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

fltmod_plugin.h

Data Fields