plugin-filter

Name

plugin-filter -- 

Synopsis



enum        filter_category_t;
typedef     filter_entry_t;
typedef     plugin_filter_t;
#define     plugin_run_func                 (p)
#define     plugin_close_func               (p)
#define     plugin_set_running_func         (p, f)
#define     plugin_set_closing_func         (p, f)
int         filter_plugins_available        (filter_category_t type);
int         filter_plugins_init             (const char *dirname,
                                             int argc,
                                             char **argv);
int         filter_plugins_run_by_category  (const idmef_message_t *msg,
                                             filter_category_t cat);
int         filter_plugins_run_by_plugin    (const idmef_message_t *message,
                                             plugin_generic_t *plugin);
plugin_generic_t* plugin_init               (int argc,
                                             char **argv);

Description

Details

enum filter_category_t

typedef enum {
        FILTER_CATEGORY_REPORTING = 0,
        FILTER_CATEGORY_DATABASE  = 1, /* soon to go with reporting thought libpreludedb */
        FILTER_CATEGORY_RELAYING  = 2,
        FILTER_CATEGORY_PLUGIN    = 3,
        FILTER_CATEGORY_END       = 4, /* should be the latest, do not remove */
} filter_category_t;


filter_entry_t

typedef struct {
        /*
         * What category/plugin should this entry be hooked at.
         */
        filter_category_t category;
        plugin_generic_t *plugin;
        
        /*
         * private data associated with an entry.
         */
        void *private_data;
} filter_entry_t;


plugin_filter_t

typedef struct {
        PLUGIN_GENERIC;
        filter_entry_t *category;
        int (*run)(const idmef_message_t *message, void *data);
} plugin_filter_t;


plugin_run_func()

#define     plugin_run_func(p)

p :


plugin_close_func()

#define     plugin_close_func(p)

p :


plugin_set_running_func()

#define     plugin_set_running_func(p, f)

p :

f :


plugin_set_closing_func()

#define     plugin_set_closing_func(p, f)

p :

f :


filter_plugins_available ()

int         filter_plugins_available        (filter_category_t type);

type :

Returns :


filter_plugins_init ()

int         filter_plugins_init             (const char *dirname,
                                             int argc,
                                             char **argv);

dirname :

argc :

argv :

Returns :


filter_plugins_run_by_category ()

int         filter_plugins_run_by_category  (const idmef_message_t *msg,
                                             filter_category_t cat);

msg :

cat :

Returns :


filter_plugins_run_by_plugin ()

int         filter_plugins_run_by_plugin    (const idmef_message_t *message,
                                             plugin_generic_t *plugin);

message :

plugin :

Returns :


plugin_init ()

plugin_generic_t* plugin_init               (int argc,
                                             char **argv);

argc :

argv :

Returns :