extcap: Sort extcap interfaces alphabetically
[metze/wireshark/wip.git] / extcap.h
1 /* extcap.h
2  * Definitions for extcap external capture
3  * Copyright 2013, Mike Ryan <mikeryan@lacklustre.net>
4  *
5  * Wireshark - Network traffic analyzer
6  * By Gerald Combs <gerald@wireshark.org>
7  * Copyright 1998 Gerald Combs
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22  */
23
24 #ifndef __EXTCAP_H__
25 #define __EXTCAP_H__
26
27 #include <config.h>
28
29 #include <glib.h>
30
31 #ifdef _WIN32
32 #include <windows.h>
33 #include <wsutil/unicode-utils.h>
34 #endif
35
36 #include <ui/capture_ui_utils.h>
37
38 #ifdef HAVE_EXTCAP
39
40 /* Prefix for the pipe interfaces */
41 #define EXTCAP_PIPE_PREFIX "wireshark_extcap"
42
43 #define EXTCAP_ARGUMENT_CONFIG                  "--extcap-config"
44 #define EXTCAP_ARGUMENT_LIST_INTERFACES "--extcap-interfaces"
45 #define EXTCAP_ARGUMENT_INTERFACE               "--extcap-interface"
46 #define EXTCAP_ARGUMENT_LIST_DLTS               "--extcap-dlts"
47
48 #define EXTCAP_ARGUMENT_RUN_CAPTURE             "--capture"
49 #define EXTCAP_ARGUMENT_CAPTURE_FILTER          "--extcap-capture-filter"
50 #define EXTCAP_ARGUMENT_RUN_PIPE                "--fifo"
51
52 #ifdef __cplusplus
53 extern "C" {
54 #endif /* __cplusplus */
55
56 /* try to get if capabilities from extcap */
57 if_capabilities_t *
58 extcap_get_if_dlts(const gchar * ifname, char ** err_str);
59
60 /* get a list of all capture interfaces */
61 GList *
62 extcap_interface_list(char **err_str);
63
64 /* returns the configuration for the given interface name, or an
65  * empty list, if no configuration has been found */
66 GList *
67 extcap_get_if_configuration(const char * ifname);
68
69 gboolean
70 extcap_has_configuration(const char * ifname, gboolean is_required);
71
72 #ifdef WIN32
73 HANDLE
74 extcap_get_win32_handle();
75 #endif
76
77 gboolean
78 extcap_init_interfaces(capture_options * capture_opts);
79
80 gboolean
81 extcap_create_pipe(char ** fifo);
82
83 void
84 extcap_cleanup(capture_options * capture_opts _U_);
85
86 #ifdef __cplusplus
87 }
88 #endif /* __cplusplus */
89
90 #endif
91
92 #endif
93
94 /*
95  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
96  *
97  * Local variables:
98  * c-basic-offset: 4
99  * tab-width: 8
100  * indent-tabs-mode: nil
101  * End:
102  *
103  * vi: set shiftwidth=4 tabstop=8 expandtab:
104  * :indentSize=4:tabSize=8:noTabs=true:
105  */