Allow "capture info data" to not be a singleton.
[metze/wireshark/wip.git] / capture_info.h
1 /* capture_info.h
2  * capture info functions
3  *
4  * Wireshark - Network traffic analyzer
5  * By Gerald Combs <gerald@wireshark.org>
6  * Copyright 1998 Gerald Combs
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21  */
22
23
24 /** @file
25  *
26  * Capture info functions.
27  *
28  */
29
30 /*
31  * GTK+ only.
32  * If we add this to the Qt UI we should modernize the statistics we show.
33  * At the very least we should remove or hide IPX and VINES.
34  */
35
36 #ifndef __CAPTURE_INFO_H__
37 #define __CAPTURE_INFO_H__
38
39 #include "capture_opts.h"
40 #include <capchild/capture_session.h>
41
42 /* XXX - Should be temporary until packet_counts is removed */
43 #include <epan/packet.h>
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif /* __cplusplus */
48
49 /** Current Capture info. */
50 typedef struct {
51     /* handle */
52     gpointer        ui;             /**< user interface handle */
53
54     /* capture info */
55     packet_counts   *counts;        /**< protocol specific counters */
56     time_t          running_time;   /**< running time since last update */
57     gint            new_packets;    /**< packets since last update */
58 } capture_info;
59
60 typedef struct _info_data {
61     packet_counts     counts;     /* several packet type counters */
62     struct wtap*      wtap;       /* current wtap file */
63     capture_info      ui;         /* user interface data */
64 } info_data_t;
65
66 /* open the info - init values (wtap, counts), create dialog */
67 extern void capture_info_open(capture_session *cap_session, info_data_t* cap_info);
68
69 /* new file arrived - (eventually close old wtap), open wtap */
70 extern gboolean capture_info_new_file(const char *new_filename, info_data_t* cap_info);
71
72 /* new packets arrived - read from wtap, count */
73 extern void capture_info_new_packets(int to_read, info_data_t* cap_info);
74
75 /* close the info - close wtap, destroy dialog */
76 extern void capture_info_close(info_data_t* cap_info);
77
78 /** Create the capture info dialog */
79 extern void
80 capture_info_ui_create(capture_info *cinfo, capture_session *cap_session);
81
82 /** Update the capture info counters in the dialog */
83 extern void capture_info_ui_update(
84 capture_info    *cinfo);
85
86 /** Destroy the capture info dialog again */
87 extern void capture_info_ui_destroy(
88 capture_info    *cinfo);
89
90 #ifdef __cplusplus
91 }
92 #endif /* __cplusplus */
93
94 #endif /* capture_info.h */
95
96 /*
97  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
98  *
99  * Local variables:
100  * c-basic-offset: 4
101  * tab-width: 8
102  * indent-tabs-mode: nil
103  * End:
104  *
105  * vi: set shiftwidth=4 tabstop=8 expandtab:
106  * :indentSize=4:tabSize=8:noTabs=true:
107  */