capture.h

   1 /* capture.h
   2  * Definitions for packet capture windows
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24
  25 /* This file should only be included if libpcap is present */
  26
  27 #ifndef __CAPTURE_H__
  28 #define __CAPTURE_H__
  29
  30 /** @file
  31  *  Capture related things.
  32  */
  33
  34 #include "capture_opts.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_options *capture_opts,
  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);
  60
  61 /**
  62  * Start a capture session.
  63  *
  64  * @param capture_opts the numerous capture options
  65  * @return TRUE if the capture starts successfully, FALSE otherwise.
  66  */
  67 extern gboolean capture_start(capture_options *capture_opts);
  68
  69 /** Stop a capture session (usually from a menu item). */
  70 extern void capture_stop(capture_options *capture_opts);
  71
  72 /** Restart the current captured packets and start again. */
  73 extern void capture_restart(capture_options *capture_opts);
  74
  75 /** Terminate the capture child cleanly when exiting. */
  76 extern void capture_kill_child(capture_options *capture_opts);
  77
  78 /**
  79  * Capture child told us we have a new (or the first) capture file.
  80  */
  81 extern gboolean capture_input_new_file(capture_options *capture_opts, gchar *new_file);
  82
  83 /**
  84  * Capture child told us we have new packets to read.
  85  */
  86 extern void capture_input_new_packets(capture_options *capture_opts, int to_read);
  87
  88 /**
  89  * Capture child told us how many dropped packets it counted.
  90  */
  91 extern void capture_input_drops(capture_options *capture_opts, guint32 dropped);
  92
  93 /**
  94  * Capture child told us that an error has occurred while starting the capture.
  95  */
  96 extern void capture_input_error_message(capture_options *capture_opts, char *error_message, char *secondary_error_msg);
  97
  98 /**
  99  * Capture child told us that an error has occurred while parsing a
 100  * capture filter when starting/running the capture.
 101  */
 102 extern void capture_input_cfilter_error_message(capture_options *capture_opts, guint i, char *error_message);
 103
 104 /**
 105  * Capture child closed its side of the pipe, report any error and
 106  * do the required cleanup.
 107  */
 108 extern void capture_input_closed(capture_options *capture_opts, gchar *msg);
 109
 110 struct if_stat_cache_s;
 111 typedef struct if_stat_cache_s if_stat_cache_t;
 112
 113 /**
 114  * Start gathering capture statistics for the interfaces specified.
 115  * @param if_list A GList of if_info_t items
 116  * @return A pointer to the statistics state data.
 117  */
 118 extern if_stat_cache_t * capture_stat_start(capture_options *capture_opts);
 119
 120 /**
 121  * Fetch capture statistics, similar to pcap_stats().
 122  */
 123 struct pcap_stat; /* Stub in case we don't or haven't yet included pcap.h */
 124 extern gboolean capture_stats(if_stat_cache_t *sc, char *ifname, struct pcap_stat *ps);
 125
 126 /**
 127  * Stop gathering capture statistics.
 128  */
 129 void capture_stat_stop(if_stat_cache_t *sc);
 130
 131 #ifdef __cplusplus
 132 }
 133 #endif /* __cplusplus */
 134
 135 #endif /* capture.h */