Wireshark  2.9.0-477-g68ec514b
The Wireshark network protocol analyzer
stat_groups.h
Go to the documentation of this file.
1 /* stat_groups.h
2  * Definitions of groups for statistics
3  *
4  * Wireshark - Network traffic analyzer
5  * By Gerald Combs <gerald@wireshark.org>
6  * Copyright 1998 Gerald Combs
7  *
8  * SPDX-License-Identifier: GPL-2.0-or-later
9  */
10 
11 #ifndef __STAT_GROUPS_H__
12 #define __STAT_GROUPS_H__
13 
14 #ifdef __cplusplus
15 extern "C" {
16 #endif /* __cplusplus */
17 
22 /*
23  * Menu statistics group definitions. Used by ui/qt/tap_parameter_dialog.h
24  * and ui/gtk/tap_param_dlg.h.
25  *
26  * XXX - stats should be able to register additional menu groups, although
27  * the question then would be "in what order should they appear in the menu?"
28  *
29  * NOTE: the enum below is parsed by epan/wslua/make-init-lua.pl in order
30  * to generate usable values for Lua scripts to use, so they can add to
31  * the menus in the GUI. The perl script's regex is such that the following
32  * prefixes must only appear once in this list:
33  * REGISTER_ANALYZE_GROUP_CONVERSATION
34  * REGISTER_STAT_GROUP_CONVERSATION
35  * REGISTER_STAT_GROUP_RESPONSE
36  * REGISTER_STAT_GROUP_ENDPOINT
37  * In other words, because there is a REGISTER_STAT_GROUP_RESPONSE_TIME, you cannot
38  * add a REGISTER_STAT_GROUP_RESPONSE nor a REGISTER_STAT_GROUP_RESPONSE_FOOBAR
39  * because they use the same "REGISTER_STAT_GROUP_RESPONSE" prefix.
40  * Also, do NOT change the names in the enum - you can add, but not remove.
41  * If you do, legacy scripts will break. (which is why the perl script regex isn't better)
42  */
43 
45 typedef enum {
46  REGISTER_ANALYZE_GROUP_UNSORTED, /* unsorted analyze stuff */
47  REGISTER_ANALYZE_GROUP_CONVERSATION_FILTER, /* conversation filters. Unused? */
48  REGISTER_STAT_GROUP_UNSORTED, /* unsorted statistic function */
49  REGISTER_STAT_GROUP_GENERIC, /* generic statistic function, not specific to a protocol */
50  REGISTER_STAT_GROUP_CONVERSATION_LIST, /* member of the conversation list */
51  REGISTER_STAT_GROUP_ENDPOINT_LIST, /* member of the endpoint list */
52  REGISTER_STAT_GROUP_RESPONSE_TIME, /* member of the service response time list */
53  REGISTER_STAT_GROUP_TELEPHONY, /* telephony specific */
54  REGISTER_STAT_GROUP_TELEPHONY_ANSI, /* name says it all */
55  REGISTER_STAT_GROUP_TELEPHONY_GSM, /* GSM (and UMTS?) */
56  REGISTER_STAT_GROUP_TELEPHONY_LTE, /* name says it all */
57  REGISTER_STAT_GROUP_TELEPHONY_MTP3, /* name says it all */
58  REGISTER_STAT_GROUP_TELEPHONY_SCTP, /* name says it all */
59  REGISTER_TOOLS_GROUP_UNSORTED /* unsorted tools */
61 
63 /* XXX Is there a more appropriate place to define this? */
64 typedef enum _st_format_type {
65  ST_FORMAT_PLAIN, ST_FORMAT_CSV, ST_FORMAT_XML, ST_FORMAT_YAML
67 
68 #ifdef __cplusplus
69 }
70 #endif /* __cplusplus */
71 
72 #endif /* __STAT_GROUPS_H__ */
_st_format_type
Definition: stat_groups.h:64
enum _st_format_type st_format_type
register_stat_group_t
Definition: stat_groups.h:45