Browse Source

filter.h : doxygen comments

master
Alex 'AdUser' Z 8 years ago
parent
commit
47810232c2
  1. 17
      src/filter.h

17
src/filter.h

@ -10,18 +10,29 @@
#include "config.h" #include "config.h"
#include "log.h" #include "log.h"
/** filter module definition */
typedef struct f2b_filter_t { typedef struct f2b_filter_t {
void *h; void *h; /**< dlopen handler */
void *cfg; void *cfg; /**< opaque pointer of module config */
char file[PATH_MAX]; char file[PATH_MAX]; /**< path to file with patterns */
/* handlers */
/** dlsym pointer to handler of @a create command */
void *(*create) (const char *id); void *(*create) (const char *id);
/** dlsym pointer to handler of @a config command */
bool (*config) (void *cfg, const char *key, const char *value); bool (*config) (void *cfg, const char *key, const char *value);
/** dlsym pointer to handler of @a append command */
bool (*append) (void *cfg, const char *pattern); bool (*append) (void *cfg, const char *pattern);
/** dlsym pointer to handler of @a error command */
char *(*error) (void *cfg); char *(*error) (void *cfg);
/** dlsym pointer to handler of @a ready command */
bool (*ready) (void *cfg); bool (*ready) (void *cfg);
/** dlsym pointer to handler of @a flush command */
bool (*flush) (void *cfg); bool (*flush) (void *cfg);
/** dlsym pointer to handler of @a stats command */
bool (*stats) (void *cfg, int *matches, char **pattern, bool reset); bool (*stats) (void *cfg, int *matches, char **pattern, bool reset);
/** dlsym pointer to handler of @a match command */
bool (*match) (void *cfg, const char *line, char *buf, size_t buf_size); bool (*match) (void *cfg, const char *line, char *buf, size_t buf_size);
/** dlsym pointer to handler of @a destroy command */
void (*destroy) (void *cfg); void (*destroy) (void *cfg);
} f2b_filter_t; } f2b_filter_t;

Loading…
Cancel
Save