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 typedef struct _extcap_info {
  53     gchar * basename;
  54     gchar * full_path;
  55     gchar * version;
  56 } extcap_info;
  57
  58 #ifdef __cplusplus
  59 extern "C" {
  60 #endif /* __cplusplus */
  61
  62 /* try to get if capabilities from extcap */
  63 if_capabilities_t *
  64 extcap_get_if_dlts(const gchar * ifname, char ** err_str);
  65
  66 /* get a list of all capture interfaces */
  67 GList *
  68 extcap_interface_list(char **err_str);
  69
  70 /* get a list of all available extcap tools */
  71 GHashTable *
  72 extcap_tools_list(void);
  73
  74 /* returns the configuration for the given interface name, or an
  75  * empty list, if no configuration has been found */
  76 GList *
  77 extcap_get_if_configuration(const char * ifname);
  78
  79 gboolean
  80 extcap_has_configuration(const char * ifname, gboolean is_required);
  81
  82 #ifdef WIN32
  83 HANDLE
  84 extcap_get_win32_handle();
  85 #endif
  86
  87 gboolean
  88 extcap_init_interfaces(capture_options * capture_opts);
  89
  90 gboolean
  91 extcap_create_pipe(char ** fifo);
  92
  93 void
  94 extcap_cleanup(capture_options * capture_opts _U_);
  95
  96 #ifdef __cplusplus
  97 }
  98 #endif /* __cplusplus */
  99
 100 #endif
 101
 102 #endif
 103
 104 /*
 105  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
 106  *
 107  * Local variables:
 108  * c-basic-offset: 4
 109  * tab-width: 8
 110  * indent-tabs-mode: nil
 111  * End:
 112  *
 113  * vi: set shiftwidth=4 tabstop=8 expandtab:
 114  * :indentSize=4:tabSize=8:noTabs=true:
 115  */