| Wireshark 4.7.0 The Wireshark network protocol analyzer

Loading...
Searching...
No Matches
export_object.h
Go to the documentation of this file.
1
11#ifndef __EXPORT_OBJECT_H__
12#define __EXPORT_OBJECT_H__
13
14#include "tap.h"
15#include <epan/wmem_scopes.h>
16
17#ifdef __cplusplus
18 extern "C" {
19#endif /* __cplusplus */
20
21 typedef struct _export_object_entry_t {
22 uint32_t pkt_num;
23 char *hostname;
24 char *content_type;
25 char *filename;
26 size_t payload_len;
27 uint8_t *payload_data;
28} export_object_entry_t;
29
34#define EXPORT_OBJECT_MAXFILELEN 255
35
36 typedef void (*export_object_object_list_add_entry_cb)(void* gui_data, struct _export_object_entry_t *entry);
37 typedef export_object_entry_t* (*export_object_object_list_get_entry_cb)(void* gui_data, int row);
38
39 typedef struct _export_object_list_t {
40 export_object_object_list_add_entry_cb add_entry; //GUI specific handler for adding an object entry
41 export_object_object_list_get_entry_cb get_entry; //GUI specific handler for retrieving an object entry
42 void* gui_data; //GUI specific data (for UI representation)
43} export_object_list_t;
44
46 typedef struct register_eo register_eo_t;
47
48/* When a protocol needs intermediate data structures to construct the
49 export objects, then it must specify a function that cleans up all
50 those data structures. This function is passed to export_object_window
51 and called when tap reset or windows closes occurs. If no function is needed
52 a NULL value should be passed instead */
53 typedef void (*export_object_gui_reset_cb)(void);
54
57 extern void export_object_init(void);
58
67WS_DLL_PUBLIC int register_export_object(const int proto_id, tap_packet_cb export_packet_func, export_object_gui_reset_cb reset_cb);
68
74WS_DLL_PUBLIC int get_eo_proto_id(register_eo_t* eo);
75
81WS_DLL_PUBLIC const char* get_eo_tap_listener_name(register_eo_t* eo);
82
88WS_DLL_PUBLIC tap_packet_cb get_eo_packet_func(register_eo_t* eo);
89
95WS_DLL_PUBLIC export_object_gui_reset_cb get_eo_reset_func(register_eo_t* eo);
96
102WS_DLL_PUBLIC register_eo_t* get_eo_by_name(const char* name);
103
109WS_DLL_PUBLIC void eo_iterate_tables(wmem_foreach_func func, void *user_data);
110
118WS_DLL_PUBLIC GString *eo_massage_str(const char *in_str, size_t maxlen, int dup);
119
125WS_DLL_PUBLIC const char *eo_ct2ext(const char *content_type);
126
131WS_DLL_PUBLIC void eo_free_entry(export_object_entry_t *entry);
132
133#ifdef __cplusplus
134}
135#endif /* __cplusplus */
136
137#endif /* __EXPORT_OBJECT_H__ */
138
139/*
140 * Editor modelines
141 *
142 * Local Variables:
143 * c-basic-offset: 4
144 * tab-width: 8
145 * indent-tabs-mode: nil
146 * End:
147 *
148 * ex: set shiftwidth=4 tabstop=8 expandtab:
149 * :indentSize=4:tabSize=8:noTabs=true:
150 */
eo_ct2ext
WS_DLL_PUBLIC const char * eo_ct2ext(const char *content_type)
Definition export_object.c:144
get_eo_by_name
WS_DLL_PUBLIC register_eo_t * get_eo_by_name(const char *name)
Definition export_object.c:73
get_eo_tap_listener_name
WS_DLL_PUBLIC const char * get_eo_tap_listener_name(register_eo_t *eo)
Definition export_object.c:58
eo_iterate_tables
WS_DLL_PUBLIC void eo_iterate_tables(wmem_foreach_func func, void *user_data)
Definition export_object.c:78
get_eo_reset_func
WS_DLL_PUBLIC export_object_gui_reset_cb get_eo_reset_func(register_eo_t *eo)
Definition export_object.c:68
eo_massage_str
WS_DLL_PUBLIC GString * eo_massage_str(const char *in_str, size_t maxlen, int dup)
Definition export_object.c:116
export_object_init
void export_object_init(void)
Definition export_object.c:28
get_eo_proto_id
WS_DLL_PUBLIC int get_eo_proto_id(register_eo_t *eo)
Definition export_object.c:50
get_eo_packet_func
WS_DLL_PUBLIC tap_packet_cb get_eo_packet_func(register_eo_t *eo)
Definition export_object.c:63
eo_free_entry
WS_DLL_PUBLIC void eo_free_entry(export_object_entry_t *entry)
Definition export_object.c:151
register_export_object
WS_DLL_PUBLIC int register_export_object(const int proto_id, tap_packet_cb export_packet_func, export_object_gui_reset_cb reset_cb)
Definition export_object.c:34
wmem_foreach_func
bool(* wmem_foreach_func)(const void *key, void *value, void *userdata)
Function type for processing one node of a tree during a traversal.
Definition wmem_tree.h:389
_export_object_entry_t
Definition export_object.h:21
_export_object_list_t
Definition export_object.h:39
register_eo
Definition export_object.c:19
tap.h
wmem_scopes.h