Allow "capture info data" to not be a singleton.
[metze/wireshark/wip.git] / ui / capture.h
1 /* capture.h
2  * Definitions for packet capture windows
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 /* This file should only be included if libpcap is present */
24
25 #ifndef __CAPTURE_H__
26 #define __CAPTURE_H__
27
28 /** @file
29  *  Capture related things.
30  */
31
32 #include "capture_opts.h"
33 #include "capture_info.h"
34 #include "capchild/capture_session.h"
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif /* __cplusplus */
39
40 typedef enum {
41   capture_cb_capture_prepared,
42   capture_cb_capture_update_started,
43   capture_cb_capture_update_continue,
44   capture_cb_capture_update_finished,
45   capture_cb_capture_fixed_started,
46   capture_cb_capture_fixed_continue,
47   capture_cb_capture_fixed_finished,
48   capture_cb_capture_stopping,
49   capture_cb_capture_failed
50 } capture_cbs;
51
52 typedef void (*capture_callback_t) (gint event, capture_session *cap_session,
53                                     gpointer user_data);
54
55 extern void
56 capture_callback_add(capture_callback_t func, gpointer user_data);
57
58 extern void
59 capture_callback_remove(capture_callback_t func, gpointer user_data);
60
61 /**
62  * Start a capture session.
63  *
64  * @param capture_opts the numerous capture options
65  * @param cap_session a handle for the capture session
66  * @param update_cb update screen
67  * @return TRUE if the capture starts successfully, FALSE otherwise.
68  */
69 extern gboolean
70 capture_start(capture_options *capture_opts, capture_session *cap_session, info_data_t* cap_data, void(*update_cb)(void));
71
72 /** Stop a capture session (usually from a menu item). */
73 extern void
74 capture_stop(capture_session *cap_session);
75
76 /** Restart the current captured packets and start again. */
77 extern void
78 capture_restart(capture_session *cap_session);
79
80 /** Terminate the capture child cleanly when exiting. */
81 extern void
82 capture_kill_child(capture_session *cap_session);
83
84 struct if_stat_cache_s;
85 typedef struct if_stat_cache_s if_stat_cache_t;
86
87 /**
88  * Start gathering capture statistics for the interfaces specified.
89  * @param capture_opts A structure containing options for the capture.
90  * @return A pointer to the statistics state data.
91  */
92 extern if_stat_cache_t * capture_stat_start(capture_options *capture_opts);
93
94 /**
95  * Fetch capture statistics, similar to pcap_stats().
96  */
97 struct pcap_stat; /* Stub in case we don't or haven't yet included pcap.h */
98 extern gboolean capture_stats(if_stat_cache_t *sc, char *ifname, struct pcap_stat *ps);
99
100 /**
101  * Stop gathering capture statistics.
102  */
103 void capture_stat_stop(if_stat_cache_t *sc);
104
105 #ifdef __cplusplus
106 }
107 #endif /* __cplusplus */
108
109 #endif /* capture.h */
110
111 /*
112  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
113  *
114  * Local Variables:
115  * c-basic-offset: 2
116  * tab-width: 8
117  * indent-tabs-mode: nil
118  * End:
119  *
120  * vi: set shiftwidth=2 tabstop=8 expandtab:
121  * :indentSize=2:tabSize=8:noTabs=true:
122  */