Wireshark  4.3.0
The Wireshark network protocol analyzer
follow.h
Go to the documentation of this file.
1 
13 #ifndef __FOLLOW_H__
14 #define __FOLLOW_H__
15 
16 #include <epan/epan.h>
17 #include <epan/packet.h>
18 #include <wsutil/inet_cidr.h>
19 #include <epan/tap.h>
20 #include <epan/wmem_scopes.h>
21 #include "ws_symbol_export.h"
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif /* __cplusplus */
26 
27 /* Show Stream */
28 typedef enum {
29  FROM_CLIENT,
30  FROM_SERVER,
31  BOTH_HOSTS
32 } show_stream_t;
33 
34 typedef union _stream_addr {
35  guint32 ipv4;
36  ws_in6_addr ipv6;
37 } stream_addr;
38 
39 struct _follow_info;
40 
41 typedef gboolean (*follow_print_line_func)(char *, size_t, gboolean, void *);
42 
43 #define SUBSTREAM_UNUSED G_GUINT64_CONSTANT(0xFFFFFFFFFFFFFFFF)
44 
45 typedef struct {
46  gboolean is_server;
47  guint32 packet_num;
48  guint32 seq; /* TCP only */
50  GByteArray *data;
52 
53 typedef struct _follow_info {
54  show_stream_t show_stream;
55  char *filter_out_filter;
56  GList *payload; /* "follow_record_t" entries, in reverse order. */
57  guint bytes_written[2]; /* Index with FROM_CLIENT or FROM_SERVER for readability. */
58  guint32 seq[2]; /* TCP only */
59  GList *fragments[2]; /* TCP only */
60  guint client_port;
61  guint server_port;
62  address client_ip;
63  address server_ip;
64  void* gui_data;
65  guint64 substream_id;
67 
68 struct register_follow;
69 typedef struct register_follow register_follow_t;
70 
71 typedef gchar* (*follow_conv_filter_func)(epan_dissect_t *edt, packet_info *pinfo, guint *stream, guint *sub_stream);
72 typedef gchar* (*follow_index_filter_func)(guint stream, guint sub_stream);
73 typedef gchar* (*follow_address_filter_func)(address* src_addr, address* dst_addr, int src_port, int dst_port);
74 typedef gchar* (*follow_port_to_display_func)(wmem_allocator_t *allocator, guint port);
75 typedef guint32 (*follow_stream_count_func)(void);
76 typedef gboolean (*follow_sub_stream_id_func)(guint stream, guint sub_stream, gboolean le, guint *sub_stream_out);
77 
78 WS_DLL_PUBLIC
79 void register_follow_stream(const int proto_id, const char* tap_listener,
80  follow_conv_filter_func conv_filter, follow_index_filter_func index_filter, follow_address_filter_func address_filter,
81  follow_port_to_display_func port_to_display, tap_packet_cb tap_handler,
82  follow_stream_count_func stream_count, follow_sub_stream_id_func sub_stream_id);
83 
89 WS_DLL_PUBLIC int get_follow_proto_id(register_follow_t* follower);
90 
96 WS_DLL_PUBLIC const char* get_follow_tap_string(register_follow_t* follower);
97 
103 WS_DLL_PUBLIC register_follow_t* get_follow_by_name(const char* proto_short_name);
104 
110 WS_DLL_PUBLIC register_follow_t* get_follow_by_proto_id(const int proto_id);
111 
117 WS_DLL_PUBLIC follow_conv_filter_func get_follow_conv_func(register_follow_t* follower);
118 
124 WS_DLL_PUBLIC follow_index_filter_func get_follow_index_func(register_follow_t* follower);
125 
131 WS_DLL_PUBLIC follow_address_filter_func get_follow_address_func(register_follow_t* follower);
132 
138 WS_DLL_PUBLIC follow_port_to_display_func get_follow_port_to_display(register_follow_t* follower);
139 
145 WS_DLL_PUBLIC tap_packet_cb get_follow_tap_handler(register_follow_t* follower);
146 
153 WS_DLL_PUBLIC follow_stream_count_func get_follow_stream_count_func(register_follow_t* follower);
154 
166 WS_DLL_PUBLIC follow_sub_stream_id_func get_follow_sub_stream_id_func(register_follow_t* follower);
167 
171 WS_DLL_PUBLIC tap_packet_status
172 follow_tvb_tap_listener(void *tapdata, packet_info *pinfo, epan_dissect_t *edt _U_, const void *data, tap_flags_t flags);
173 
179 WS_DLL_PUBLIC void follow_iterate_followers(wmem_foreach_func func, gpointer user_data);
180 
187 WS_DLL_PUBLIC gchar* follow_get_stat_tap_string(register_follow_t* follower);
188 
197 WS_DLL_PUBLIC void follow_reset_stream(follow_info_t* info);
198 
204 WS_DLL_PUBLIC void follow_info_free(follow_info_t* follow_info);
205 
206 #ifdef __cplusplus
207 }
208 #endif /* __cplusplus */
209 
210 #endif
WS_DLL_PUBLIC void follow_reset_stream(follow_info_t *info)
Definition: follow.c:150
WS_DLL_PUBLIC tap_packet_cb get_follow_tap_handler(register_follow_t *follower)
Definition: follow.c:104
WS_DLL_PUBLIC follow_address_filter_func get_follow_address_func(register_follow_t *follower)
Definition: follow.c:94
WS_DLL_PUBLIC follow_stream_count_func get_follow_stream_count_func(register_follow_t *follower)
Definition: follow.c:109
WS_DLL_PUBLIC follow_conv_filter_func get_follow_conv_func(register_follow_t *follower)
Definition: follow.c:84
WS_DLL_PUBLIC follow_sub_stream_id_func get_follow_sub_stream_id_func(register_follow_t *follower)
Definition: follow.c:114
WS_DLL_PUBLIC void follow_iterate_followers(wmem_foreach_func func, gpointer user_data)
Definition: follow.c:134
WS_DLL_PUBLIC gchar * follow_get_stat_tap_string(register_follow_t *follower)
Definition: follow.c:139
WS_DLL_PUBLIC register_follow_t * get_follow_by_name(const char *proto_short_name)
Definition: follow.c:119
WS_DLL_PUBLIC follow_index_filter_func get_follow_index_func(register_follow_t *follower)
Definition: follow.c:89
WS_DLL_PUBLIC const char * get_follow_tap_string(register_follow_t *follower)
Definition: follow.c:76
WS_DLL_PUBLIC register_follow_t * get_follow_by_proto_id(const int proto_id)
Definition: follow.c:124
WS_DLL_PUBLIC void follow_info_free(follow_info_t *follow_info)
Definition: follow.c:203
WS_DLL_PUBLIC follow_port_to_display_func get_follow_port_to_display(register_follow_t *follower)
Definition: follow.c:99
WS_DLL_PUBLIC int get_follow_proto_id(register_follow_t *follower)
Definition: follow.c:68
WS_DLL_PUBLIC tap_packet_status follow_tvb_tap_listener(void *tapdata, packet_info *pinfo, epan_dissect_t *edt _U_, const void *data, tap_flags_t flags)
Definition: follow.c:210
bool(* wmem_foreach_func)(const void *key, void *value, void *userdata)
Definition: wmem_tree.h:220
Definition: address.h:56
Definition: follow.h:53
guint64 substream_id
Definition: follow.h:65
Definition: packet_info.h:44
Definition: wmem_allocator.h:27
Definition: inet_addr.h:21
Definition: epan_dissect.h:28
Definition: follow.h:45
nstime_t abs_ts
Definition: follow.h:49
Definition: file-pcapng.h:57
Definition: nstime.h:26
Definition: follow.c:23
Definition: stream.c:41
tap_packet_status
Definition: tap.h:25
Definition: follow.h:34