stat_tap_ui.h

Go to the documentation of this file.

 
#pragma once
#include "ws_symbol_export.h"
 
#include <epan/params.h>
#include <epan/stat_groups.h>
#include <epan/packet_info.h>
#include <epan/tap.h>
#include <epan/wmem_scopes.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef enum {
    PARAM_UINT,   
    PARAM_STRING, 
    PARAM_ENUM,   
    PARAM_UUID,   
    PARAM_FILTER  
} param_type;
 
 
typedef struct _tap_param {
    param_type        type;      
    const char       *name;      
    const char       *title;     
    const enum_val_t *enum_vals; 
    bool              optional;  
} tap_param;
 
 
typedef bool (*stat_tap_init_cb)(const char *opt_arg, void *userdata);
 
 
typedef struct _stat_tap_ui {
    register_stat_group_t  group;       
    const char            *title;       
    const char            *cli_string;  
    stat_tap_init_cb       tap_init_cb; 
    size_t                 nparams;     
    tap_param             *params;      
} stat_tap_ui;
 
 
typedef enum {
    TABLE_ITEM_NONE   = 0, 
    TABLE_ITEM_UINT,       
    TABLE_ITEM_INT,        
    TABLE_ITEM_STRING,     
    TABLE_ITEM_FLOAT,      
    TABLE_ITEM_ENUM        
} stat_tap_table_item_enum;
 
typedef struct _stat_tap_table_item_type
{
    stat_tap_table_item_enum type; 
    union {
        unsigned uint_value;     
        int int_value;           
        const char* string_value;
        double float_value;      
        int enum_value;          
    } value;
 
    union {
        unsigned uint_value;     
        int int_value;           
        const char* string_value;
        double float_value;      
        int enum_value;          
        void* ptr_value;         
    } user_data;
} stat_tap_table_item_type;
 
typedef enum {
    TAP_ALIGN_LEFT  = 0, 
    TAP_ALIGN_RIGHT      
} tap_alignment_type;
 
 
typedef struct _stat_tap_table_item {
    stat_tap_table_item_enum  type;         
    tap_alignment_type        align;        
    const char               *column_name;  
    const char               *field_format; 
} stat_tap_table_item;
 
 
typedef struct _stat_tap_table {
    const char               *title;         
    const char               *filter_string; 
    unsigned                  num_fields;    
    unsigned                  num_elements;  
    stat_tap_table_item_type **elements;     
} stat_tap_table;
 
 
typedef struct _stat_tap_table_ui {
    register_stat_group_t  group;      
    const char            *title;      
    const char            *tap_name;   
    const char            *cli_string; 
    void (*stat_tap_init_cb)(struct _stat_tap_table_ui *new_stat);
 
    tap_packet_cb packet_func; 
    void (*stat_tap_reset_table_cb)(stat_tap_table *table);
 
    void (*stat_tap_free_table_item_cb)(stat_tap_table *table, unsigned row, unsigned column, stat_tap_table_item_type *field_data);
 
    void (*stat_filter_check_cb)(const char *opt_arg, const char **filter, char **err);
 
    size_t                nfields;  
    stat_tap_table_item  *fields;   
    size_t                nparams;  
    tap_param            *params;   
    GArray               *tables;   
    unsigned              refcount; 
} stat_tap_table_ui;
 
 
typedef struct _stat_data_t {
    stat_tap_table_ui *stat_tap_data; 
    void              *user_data;     
} stat_data_t;
 
extern void stat_tap_init(void);
 
WS_DLL_PUBLIC void register_stat_tap_ui(stat_tap_ui *ui, void *userdata);
 
WS_DLL_PUBLIC void register_stat_tap_table_ui(stat_tap_table_ui *ui);
 
WS_DLL_PUBLIC void stat_tap_iterate_tables(wmem_foreach_func func, void *user_data);
 
WS_DLL_PUBLIC void stat_tap_get_filter(stat_tap_table_ui *new_stat, const char *opt_arg,
                                       const char **filter, char **err);
 
WS_DLL_PUBLIC stat_tap_table *stat_tap_init_table(const char *name, int num_fields,
                                                   int num_elements,
                                                   const char *filter_string);
 
WS_DLL_PUBLIC void stat_tap_add_table(stat_tap_table_ui* new_stat, stat_tap_table* table);
 
WS_DLL_PUBLIC stat_tap_table *stat_tap_find_table(stat_tap_table_ui *ui, const char *name);
 
WS_DLL_PUBLIC void stat_tap_init_table_row(stat_tap_table *stat_table,
                                           unsigned table_index,
                                           unsigned num_fields,
                                           const stat_tap_table_item_type *fields);
 
WS_DLL_PUBLIC stat_tap_table_item_type *stat_tap_get_field_data(
                                           const stat_tap_table *stat_table,
                                           unsigned table_index,
                                           unsigned field_index);
 
WS_DLL_PUBLIC void stat_tap_set_field_data(stat_tap_table *stat_table, unsigned table_index, unsigned field_index, stat_tap_table_item_type* field_data);
 
WS_DLL_PUBLIC void reset_stat_table(stat_tap_table_ui *new_stat);
 
 
WS_DLL_PUBLIC stat_tap_table_ui *stat_tap_by_name(const char *name);
 
WS_DLL_PUBLIC void free_stat_tables(stat_tap_table_ui* new_stat);
 
WS_DLL_PUBLIC bool process_stat_cmd_arg(const char *optstr);
 
WS_DLL_PUBLIC void list_stat_cmd_args(void);
 
WS_DLL_PUBLIC bool start_requested_stats(void);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
/*
 * Editor modelines
 *
 * Local Variables:
 * c-basic-offset: 4
 * tab-width: 8
 * indent-tabs-mode: nil
 * End:
 *
 * ex: set shiftwidth=4 tabstop=8 expandtab:
 * :indentSize=4:tabSize=8:noTabs=true:
 */