tap.h

Go to the documentation of this file.

 
#ifndef __TAP_H__
#define __TAP_H__
 
#include <epan/epan.h>
#include <epan/packet_info.h>
#include "ws_symbol_export.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef enum {
    TAP_PACKET_DONT_REDRAW, 
    TAP_PACKET_REDRAW,  
    TAP_PACKET_FAILED   
} tap_packet_status;
 
typedef unsigned tap_flags_t;
 
typedef void (*tap_reset_cb)(void *tapdata);
typedef tap_packet_status (*tap_packet_cb)(void *tapdata, packet_info *pinfo, epan_dissect_t *edt, const void *data, tap_flags_t flags);
typedef void (*tap_draw_cb)(void *tapdata);
typedef void (*tap_finish_cb)(void *tapdata);
 
#define TL_REQUIRES_NOTHING         0x00000000      
#define TL_REQUIRES_PROTO_TREE      0x00000001      
#define TL_REQUIRES_COLUMNS         0x00000002      
#define TL_REQUIRES_ERROR_PACKETS   0x00000004      
#define TL_REQUIRES_PROTOCOLS       0x00000020      
#define TL_IS_DISSECTOR_HELPER      0x00000008      
#define TL_IGNORE_DISPLAY_FILTER    0x00000010      
#define TL_DISPLAY_FILTER_IGNORED   0x00100000      
#define TL_IP_AGGREGATION_NULL      0x00000100      
#define TL_IP_AGGREGATION_ORI       0x00000200      
#define TL_IP_AGGREGATION_RESERVED  0x00000400      
typedef struct {
    void (*register_tap_listener)(void);   /* routine to call to register tap listener */
} tap_plugin;
 
WS_DLL_PUBLIC void tap_register_plugin(const tap_plugin *plug);
 
/*
 * Entry in the table of built-in taps to register.
 */
typedef struct _tap_reg {
    const char *cb_name;
    void (*cb_func)(void);
} tap_reg_t;
 
/*
 * For all taps, call their register routines.
 * Must be called after plugins_init(), if plugins are supported,
 * and must be called only once in a program.
 *
 * XXX - should probably be handled by epan_init(), as the tap mechanism
 * is part of libwireshark.
 */
WS_DLL_PUBLIC void register_all_tap_listeners(tap_reg_t const *tap_reg_listeners);
 
extern void tap_init(void);
 
WS_DLL_PUBLIC int register_tap(const char *name);
 
/* Gets a GList of the tap names */
WS_DLL_PUBLIC GList* get_tap_names(void);
 
WS_DLL_PUBLIC int find_tap_id(const char *name);
 
WS_DLL_PUBLIC void tap_queue_packet(int tap_id, packet_info *pinfo, const void *tap_specific_data);
 
WS_DLL_PUBLIC void tap_build_interesting(epan_dissect_t *edt);
 
extern void tap_queue_init(epan_dissect_t *edt);
 
extern void tap_push_tapped_queue(epan_dissect_t *edt);
 
WS_DLL_PUBLIC void reset_tap_listeners(void);
 
WS_DLL_PUBLIC void draw_tap_listeners(bool draw_all);
 
WS_DLL_PUBLIC GString *register_tap_listener(const char *tapname, void *tapdata,
    const char *fstring, unsigned flags, tap_reset_cb tap_reset,
    tap_packet_cb tap_packet, tap_draw_cb tap_draw,
    tap_finish_cb tap_finish) G_GNUC_WARN_UNUSED_RESULT;
 
WS_DLL_PUBLIC GString *set_tap_dfilter(void *tapdata, const char *fstring);
 
WS_DLL_PUBLIC void tap_listeners_dfilter_recompile(void);
 
WS_DLL_PUBLIC void remove_tap_listener(void *tapdata);
 
WS_DLL_PUBLIC GString *set_tap_flags(void *tapdata, unsigned flags);
 
WS_DLL_PUBLIC bool tap_listeners_require_dissection(void);
 
WS_DLL_PUBLIC bool tap_listeners_require_columns(void);
 
WS_DLL_PUBLIC bool have_tap_listener(int tap_id);
 
WS_DLL_PUBLIC bool have_filtering_tap_listeners(void);
 
WS_DLL_PUBLIC void tap_listeners_load_field_references(epan_dissect_t *edt);
 
WS_DLL_PUBLIC unsigned union_of_tap_listener_flags(void);
 
WS_DLL_PUBLIC const void *fetch_tapped_data(int tap_id, int idx);
 
extern void tap_cleanup(void);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* __TAP_H__ */