conversation_filter.h

Go to the documentation of this file.

/* conversation_filter.h
 * Routines for dissector-generated conversation filters for use as
 * display and color filters
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
#pragma once
#include <glib.h>
 
#include "ws_symbol_export.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
extern void conversation_filters_init(void);
 
typedef bool (*is_filter_valid_func)(struct _packet_info *pinfo, void *user_data);
 
typedef char* (*build_filter_string_func)(struct _packet_info *pinfo, void *user_data);
 
WS_DLL_PUBLIC void register_conversation_filter(const char *proto_name, const char *display_name,
                                                      is_filter_valid_func is_filter_valid, build_filter_string_func build_filter_string, void *user_data);
 
WS_DLL_PUBLIC void register_log_conversation_filter(const char *proto_name, const char *display_name,
                                                      is_filter_valid_func is_filter_valid, build_filter_string_func build_filter_string, void *user_data);
WS_DLL_PUBLIC void add_conversation_filter_protocol(const char *proto_name);
 
extern void conversation_filters_cleanup(void);
 
WS_DLL_PUBLIC char *conversation_filter_from_packet(struct _packet_info *pinfo);
 
WS_DLL_PUBLIC char *conversation_filter_from_log(struct _packet_info *pinfo);
 
/*** THE FOLLOWING SHOULD NOT BE USED BY ANY DISSECTORS!!! ***/
 
typedef struct conversation_filter_s {
    const char              *proto_name;          
    const char              *display_name;         
    is_filter_valid_func     is_filter_valid;      
    build_filter_string_func build_filter_string;  
    void                    *user_data;            
} conversation_filter_t;
 
WS_DLL_PUBLIC GList *packet_conv_filter_list;
WS_DLL_PUBLIC GList *log_conv_filter_list;
 
#ifdef __cplusplus
}
#endif /* __cplusplus */