From Harald Welte:
[obnox/wireshark/wip.git] / capture.h
index 2123a7c9ee6bb79cfe387becb482af95dd22f107..93ea812ba2ae77b3a1b267d1160186463789e7e0 100644 (file)
--- a/capture.h
+++ b/capture.h
 /* capture.h
  * Definitions for packet capture windows
  *
- * $Id: capture.h,v 1.16 1999/09/30 06:11:44 guy Exp $
+ * $Id$
  *
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@zing.org>
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
  * Copyright 1998 Gerald Combs
  *
- * 
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
  * of the License, or (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  */
 
+/* This file should only be included if libpcap is present */
+
 #ifndef __CAPTURE_H__
 #define __CAPTURE_H__
 
-#ifdef HAVE_LIBPCAP
+/** @file
+ *  Capture related things.
+ */
+
+#include "capture_opts.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+typedef enum {
+    capture_cb_capture_prepared,
+    capture_cb_capture_update_started,
+    capture_cb_capture_update_continue,
+    capture_cb_capture_update_finished,
+    capture_cb_capture_fixed_started,
+    capture_cb_capture_fixed_continue,
+    capture_cb_capture_fixed_finished,
+    capture_cb_capture_stopping
+} capture_cbs;
+
+typedef void (*capture_callback_t) (gint event, capture_options *capture_opts,
+                                    gpointer user_data);
+
+extern void
+capture_callback_add(capture_callback_t func, gpointer user_data);
+
+extern void
+capture_callback_remove(capture_callback_t func);
+
+/**
+ * Start a capture session.
+ *
+ * @param capture_opts the numerous capture options
+ * @return TRUE if the capture starts successfully, FALSE otherwise.
+ */
+extern gboolean capture_start(capture_options *capture_opts);
+
+/** Stop a capture session (usually from a menu item). */
+extern void capture_stop(capture_options *capture_opts);
 
-#ifndef lib_pcap_h
-#include <pcap.h>
-#endif
+/** Restart the current captured packets and start again. */
+extern void capture_restart(capture_options *capture_opts);
 
-/* The version of pcap.h that comes with some systems is missing these
- * #defines.
+/** Terminate the capture child cleanly when exiting. */
+extern void capture_kill_child(capture_options *capture_opts);
+
+/**
+ * Capture child told us we have a new (or the first) capture file.
+ */
+extern gboolean capture_input_new_file(capture_options *capture_opts, gchar *new_file);
+
+/**
+ * Capture child told us we have new packets to read.
+ */
+extern void capture_input_new_packets(capture_options *capture_opts, int to_read);
+
+/**
+ * Capture child told us how many dropped packets it counted.
+ */
+extern void capture_input_drops(capture_options *capture_opts, guint32 dropped);
+
+/**
+ * Capture child told us that an error has occurred while starting the capture.
  */
+extern void capture_input_error_message(capture_options *capture_opts, char *error_message, char *secondary_error_msg);
 
-#ifndef DLT_RAW
-#define DLT_RAW 12
-#endif
+/**
+ * Capture child told us that an error has occurred while parsing a
+ * capture filter when starting/running the capture.
+ */
+extern void capture_input_cfilter_error_message(capture_options *capture_opts, guint i, char *error_message);
+
+/**
+ * Capture child closed its side of the pipe, report any error and
+ * do the required cleanup.
+ */
+extern void capture_input_closed(capture_options *capture_opts, gchar *msg);
 
-#ifndef DLT_SLIP_BSDOS
-#define DLT_SLIP_BSDOS 13
-#endif
+struct if_stat_cache_s;
+typedef struct if_stat_cache_s if_stat_cache_t;
 
-#ifndef DLT_PPP_BSDOS
-#define DLT_PPP_BSDOS 14
-#endif
+/**
+ * Start gathering capture statistics for the interfaces specified.
+ * @param if_list A GList of if_info_t items
+ * @return A pointer to the statistics state data.
+ */
+extern if_stat_cache_t * capture_stat_start(capture_options *capture_opts);
 
-/* Name we give to the child process when doing a "-S" or "-F" capture. */
-#define        CHILD_NAME      "ethereal-capture"
+/**
+ * Fetch capture statistics, similar to pcap_stats().
+ */
+struct pcap_stat; /* Stub in case we don't or haven't yet included pcap.h */
+extern gboolean capture_stats(if_stat_cache_t *sc, char *ifname, struct pcap_stat *ps);
+
+/**
+ * Stop gathering capture statistics.
+ */
+void capture_stat_stop(if_stat_cache_t *sc);
 
-void   do_capture(void);
-void   capture(void);
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
 
-#endif /* HAVE_LIBPCAP */
 #endif /* capture.h */