preludedb-plugin-format: libpreludedb Reference Manual

## preludedb-plugin-format preludedb-plugin-format |

## Functions

int | (*preludedb_plugin_format_get_values_func_t) ()
int | (*preludedb_plugin_format_get_alert_idents_func_t) ()
int | (*preludedb_plugin_format_delete_alert_func_t) ()
int | preludedb_plugin_format_new ()
int | (*preludedb_plugin_format_get_heartbeat_idents_func_t) ()
size_t | (*preludedb_plugin_format_get_message_ident_count_func_t) ()
int | (*preludedb_plugin_format_get_alert_func_t) ()
int | (*preludedb_plugin_format_get_heartbeat_func_t) ()
void | (*preludedb_plugin_format_destroy_values_resource_func_t) ()
int | (*preludedb_plugin_format_insert_message_func_t) ()
int | (*preludedb_plugin_format_check_schema_version_func_t) ()
void | (*preludedb_plugin_format_destroy_message_idents_resource_func_t) ()
int | (*preludedb_plugin_format_delete_heartbeat_func_t) ()
ssize_t | (*preludedb_plugin_format_delete_alert_from_list_func_t) ()
ssize_t | (*preludedb_plugin_format_delete_alert_from_result_idents_func_t) ()
ssize_t | (*preludedb_plugin_format_delete_heartbeat_from_list_func_t) ()
ssize_t | (*preludedb_plugin_format_delete_heartbeat_from_result_idents_func_t) ()
void | preludedb_plugin_format_set_delete_alert_from_list_func ()
void | preludedb_plugin_format_set_delete_alert_from_result_idents_func ()
void | preludedb_plugin_format_set_delete_heartbeat_from_list_func ()
void | preludedb_plugin_format_set_delete_heartbeat_from_result_idents_func ()
void | preludedb_plugin_format_set_check_schema_version_func ()
void | preludedb_plugin_format_set_get_alert_idents_func ()
void | preludedb_plugin_format_set_get_heartbeat_idents_func ()
void | preludedb_plugin_format_set_get_message_ident_count_func ()
void | preludedb_plugin_format_set_destroy_message_idents_resource_func ()
void | preludedb_plugin_format_set_get_alert_func ()
void | preludedb_plugin_format_set_get_heartbeat_func ()
void | preludedb_plugin_format_set_delete_alert_func ()
void | preludedb_plugin_format_set_delete_heartbeat_func ()
void | preludedb_plugin_format_set_insert_message_func ()
void | preludedb_plugin_format_set_get_values_func ()
void | preludedb_plugin_format_set_destroy_values_resource_func ()

## Types and Values

struct | preludedb_plugin_format
typedef | preludedb_plugin_format_t

## Description

## Functions

### preludedb_plugin_format_get_values_func_t ()

    int
    (*preludedb_plugin_format_get_values_func_t)
                                   (preludedb_t *db,
                                    preludedb_path_selection_t *selection,
                                    idmef_criteria_t *criteria,
                                    int distinct,
                                    int limit,
                                    int offset,
                                    void **res);

### preludedb_plugin_format_get_alert_idents_func_t ()

    int
    (*preludedb_plugin_format_get_alert_idents_func_t)
                                   (preludedb_t *db,
                                    idmef_criteria_t *criteria,
                                    int limit,
                                    int offset,
                                    const preludedb_path_selection_t *order,
                                    void **res);

### preludedb_plugin_format_delete_alert_func_t ()

    int
    (*preludedb_plugin_format_delete_alert_func_t)
                                   (preludedb_t *db,
                                    uint64_t ident);

### preludedb_plugin_format_new ()

    int
    preludedb_plugin_format_new (preludedb_plugin_format_t **ret);

### preludedb_plugin_format_get_heartbeat_idents_func_t ()

    int
    (*preludedb_plugin_format_get_heartbeat_idents_func_t)
                                   (preludedb_t *db,
                                    idmef_criteria_t *criteria,
                                    int limit,
                                    int offset,
                                    const preludedb_path_selection_t *order,
                                    void **res);

### preludedb_plugin_format_get_message_ident_count_func_t ()

    size_t
    (*preludedb_plugin_format_get_message_ident_count_func_t)
                                   (void *res);

### preludedb_plugin_format_get_alert_func_t ()

    int
    (*preludedb_plugin_format_get_alert_func_t)
                                   (preludedb_t *db,
                                    uint64_t ident,
                                    idmef_message_t **message);

### preludedb_plugin_format_get_heartbeat_func_t ()

    int
    (*preludedb_plugin_format_get_heartbeat_func_t)
                                   (preludedb_t *db,
                                    uint64_t ident,
                                    idmef_message_t **message);

### preludedb_plugin_format_destroy_values_resource_func_t ()

    void
    (*preludedb_plugin_format_destroy_values_resource_func_t)
                                   (void *res);

### preludedb_plugin_format_insert_message_func_t ()

    int
    (*preludedb_plugin_format_insert_message_func_t)
                                   (preludedb_t *db,
                                    idmef_message_t *message);

### preludedb_plugin_format_check_schema_version_func_t ()

    int
    (*preludedb_plugin_format_check_schema_version_func_t)
                                   (const char *version);

### preludedb_plugin_format_destroy_message_idents_resource_func_t ()

    void
    (*preludedb_plugin_format_destroy_message_idents_resource_func_t)
                                   (void *res);

### preludedb_plugin_format_delete_heartbeat_func_t ()

    int
    (*preludedb_plugin_format_delete_heartbeat_func_t)
                                   (preludedb_t *db,
                                    uint64_t ident);

### preludedb_plugin_format_delete_alert_from_list_func_t ()

    ssize_t
    (*preludedb_plugin_format_delete_alert_from_list_func_t)
                                   (preludedb_t *db,
                                    uint64_t *idents,
                                    size_t size);

### preludedb_plugin_format_delete_alert_from_result_idents_func_t ()

    ssize_t
    (*preludedb_plugin_format_delete_alert_from_result_idents_func_t)
                                   (preludedb_t *db,
                                    preludedb_result_idents_t *results);

### preludedb_plugin_format_delete_heartbeat_from_list_func_t ()

    ssize_t
    (*preludedb_plugin_format_delete_heartbeat_from_list_func_t)
                                   (preludedb_t *db,
                                    uint64_t *idents,
                                    size_t size);

### preludedb_plugin_format_delete_heartbeat_from_result_idents_func_t ()

    ssize_t
    (*preludedb_plugin_format_delete_heartbeat_from_result_idents_func_t)
                                   (preludedb_t *db,
                                    preludedb_result_idents_t *results);

### preludedb_plugin_format_set_delete_alert_from_list_func ()

    void
    preludedb_plugin_format_set_delete_alert_from_list_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_delete_alert_from_list_func_t func);

### preludedb_plugin_format_set_delete_alert_from_result_idents_func ()

    void
    preludedb_plugin_format_set_delete_alert_from_result_idents_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_delete_alert_from_result_idents_func_t func);

### preludedb_plugin_format_set_delete_heartbeat_from_list_func ()

    void
    preludedb_plugin_format_set_delete_heartbeat_from_list_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_delete_heartbeat_from_list_func_t func);

### preludedb_plugin_format_set_delete_heartbeat_from_result_idents_func ()

    void
    preludedb_plugin_format_set_delete_heartbeat_from_result_idents_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_delete_heartbeat_from_result_idents_func_t func);

### preludedb_plugin_format_set_check_schema_version_func ()

    void
    preludedb_plugin_format_set_check_schema_version_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_check_schema_version_func_t func);

### preludedb_plugin_format_set_get_alert_idents_func ()

    void
    preludedb_plugin_format_set_get_alert_idents_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_get_alert_idents_func_t func);

### preludedb_plugin_format_set_get_heartbeat_idents_func ()

    void
    preludedb_plugin_format_set_get_heartbeat_idents_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_get_heartbeat_idents_func_t func);

### preludedb_plugin_format_set_get_message_ident_count_func ()

    void
    preludedb_plugin_format_set_get_message_ident_count_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_get_message_ident_count_func_t func);

### preludedb_plugin_format_set_destroy_message_idents_resource_func ()

    void
    preludedb_plugin_format_set_destroy_message_idents_resource_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_destroy_message_idents_resource_func_t func);

### preludedb_plugin_format_set_get_alert_func ()

    void
    preludedb_plugin_format_set_get_alert_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_get_alert_func_t func);

### preludedb_plugin_format_set_get_heartbeat_func ()

    void
    preludedb_plugin_format_set_get_heartbeat_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_get_heartbeat_func_t func);

### preludedb_plugin_format_set_delete_alert_func ()

    void
    preludedb_plugin_format_set_delete_alert_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_delete_alert_func_t func);

### preludedb_plugin_format_set_delete_heartbeat_func ()

    void
    preludedb_plugin_format_set_delete_heartbeat_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_delete_heartbeat_func_t func);

### preludedb_plugin_format_set_insert_message_func ()

    void
    preludedb_plugin_format_set_insert_message_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_insert_message_func_t func);

### preludedb_plugin_format_set_get_values_func ()

    void
    preludedb_plugin_format_set_get_values_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_get_values_func_t func);

### preludedb_plugin_format_set_destroy_values_resource_func ()

    void
    preludedb_plugin_format_set_destroy_values_resource_func
                                   (preludedb_plugin_format_t *plugin,
                                    preludedb_plugin_format_destroy_values_resource_func_t func);

## Types and Values

### struct preludedb_plugin_format

    struct preludedb_plugin_format {
            PRELUDE_PLUGIN_GENERIC;

            preludedb_plugin_format_check_schema_version_func_t check_schema_version;
            preludedb_plugin_format_get_alert_idents_func_t get_alert_idents;
            preludedb_plugin_format_get_heartbeat_idents_func_t get_heartbeat_idents;
            preludedb_plugin_format_get_message_ident_count_func_t get_message_ident_count;
            preludedb_plugin_format_get_message_ident_func_t get_message_ident;
            preludedb_plugin_format_destroy_message_idents_resource_func_t destroy_message_idents_resource;
            preludedb_plugin_format_get_alert_func_t get_alert;
            preludedb_plugin_format_get_heartbeat_func_t get_heartbeat;
            preludedb_plugin_format_delete_func_t delete;
            preludedb_plugin_format_delete_alert_func_t delete_alert;
            preludedb_plugin_format_delete_alert_from_list_func_t delete_alert_from_list;
            preludedb_plugin_format_delete_alert_from_result_idents_func_t delete_alert_from_result_idents;
            preludedb_plugin_format_delete_heartbeat_func_t delete_heartbeat;
            preludedb_plugin_format_delete_heartbeat_from_list_func_t delete_heartbeat_from_list;
            preludedb_plugin_format_delete_heartbeat_from_result_idents_func_t delete_heartbeat_from_result_idents;
            preludedb_plugin_format_insert_message_func_t insert_message;
            preludedb_plugin_format_get_values_func_t get_values;
            preludedb_plugin_format_get_result_values_count_func_t get_result_values_count;
            preludedb_plugin_format_get_result_values_row_func_t get_result_values_row;
            preludedb_plugin_format_get_result_values_field_func_t get_result_values_field;
            preludedb_plugin_format_destroy_values_resource_func_t destroy_values_resource;
            preludedb_plugin_format_update_func_t update;
            preludedb_plugin_format_update_from_list_func_t update_from_list;
            preludedb_plugin_format_update_from_result_idents_func_t update_from_result_idents;
            preludedb_plugin_format_get_path_column_count_func_t get_path_column_count;
            preludedb_plugin_format_path_resolve_func_t path_resolve;
            preludedb_plugin_format_init_func_t init;
            preludedb_plugin_format_init_func_t optimize;
            preludedb_plugin_format_destroy_func_t destroy_func;
    };

### preludedb_plugin_format_t

    typedef struct preludedb_plugin_format preludedb_plugin_format_t;