The SIP and WSP statistics taps register themselves; get rid of their
[metze/wireshark/wip.git] / capture.h
index b99ea0bf9b2e8c034f32154d4c9b148dc525524d..dd638870dca16afd504ae80b3cc362f4b8914e03 100644 (file)
--- a/capture.h
+++ b/capture.h
@@ -1,10 +1,10 @@
 /* capture.h
  * Definitions for packet capture windows
  *
- * $Id: capture.h,v 1.41 2004/02/28 16:21:10 ulfl Exp $
+ * $Id$
  *
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@ethereal.com>
+ * 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
  *
  * 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.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
+/* This file should only be included if libpcap is present */
+
 #ifndef __CAPTURE_H__
 #define __CAPTURE_H__
 
-#ifdef HAVE_LIBPCAP
-
-/* Name we give to the child process when doing a "-S" capture. */
-#define        CHILD_NAME      "ethereal-capture"
-
-typedef struct {
-       gboolean has_snaplen;           /* TRUE if maximum capture packet
-                                          length is specified */
-       int snaplen;                    /* Maximum captured packet length */
-       int promisc_mode;               /* Capture in promiscuous mode */
-       int sync_mode;                  /* Fork a child to do the capture,
-                                          and sync between them */
-       gboolean has_autostop_count;    /* TRUE if maximum packet count is
-                                          specified */
-       int autostop_count;             /* Maximum packet count */
-       gboolean has_autostop_duration; /* TRUE if maximum capture duration
-                                          is specified */
-       gint32 autostop_duration;       /* Maximum capture duration */
-       gboolean has_autostop_filesize; /* TRUE if maximum capture file size
-                                          is specified */
-       gint32 autostop_filesize;       /* Maximum capture file size */
-       gboolean ringbuffer_on;         /* TRUE if ring buffer in use */
-       guint32 num_files;              /* Number of multiple buffer files */
-       gboolean has_ring_duration;     /* TRUE if ring duration specified */
-       gint32 ringbuffer_duration;     /* Switch file after n seconds */
-       int linktype;                   /* Data link type to use, or -1 for
-                                          "use default" */
-} capture_options;
-
-extern capture_options capture_opts;
+/** @file
+ *  Capture related things.
+ */
 
-extern gboolean quit_after_cap; /* Makes a "capture only mode". Implies -k */
-extern gboolean capture_child; /* if this is the child for "-S" */
+#include "capture_opts.h"
+#include "capture_session.h"
 
-/* Open a specified file, or create a temporary file, and start a capture
-   to the file in question.  Returns TRUE if the capture starts
-   successfully, FALSE otherwise. */
-gboolean do_capture(const char *save_file);
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
 
-/* Do the low-level work of a capture. */
-int    capture(gboolean *stats_known, struct pcap_stat *stats);
+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_cb_capture_failed
+} capture_cbs;
 
-/* Stop a capture from a menu item. */
-void   capture_stop(void);
+typedef void (*capture_callback_t) (gint event, capture_session *cap_session,
+                                    gpointer user_data);
 
-/* Terminate the capture child cleanly when exiting. */
-void   kill_capture_child(void);
+extern void
+capture_callback_add(capture_callback_t func, gpointer user_data);
 
+extern void
+capture_callback_remove(capture_callback_t func);
 
-/* XXX: improve this macro (put something like this into epan/packet.h?) */
-#define CAPTURE_PACKET_COUNTS sizeof(packet_counts) / sizeof (gint)
+/**
+ * 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, capture_session *cap_session);
 
-typedef struct {
-    /* handles */
-    gpointer        callback_data;  /* capture callback handle */
-    gpointer        ui;             /* user interfaces own handle */
+/** Stop a capture session (usually from a menu item). */
+extern void
+capture_stop(capture_session *cap_session);
 
-    /* capture info */
-    packet_counts   *counts;        /* protocol specific counters */
-    time_t          running_time;   /* running time since last update */
-    gint            new_packets;    /* packets since last update */
-} capture_info;
+/** Restart the current captured packets and start again. */
+extern void
+capture_restart(capture_session *cap_session);
 
+/** Terminate the capture child cleanly when exiting. */
+extern void
+capture_kill_child(capture_session *cap_session);
 
-/* create the capture info dialog */
-extern void capture_info_create(
-capture_info    *cinfo);
+struct if_stat_cache_s;
+typedef struct if_stat_cache_s if_stat_cache_t;
 
-/* Update the capture info counters in the dialog */
-extern void capture_info_update(
-capture_info    *cinfo);
+/**
+ * Start gathering capture statistics for the interfaces specified.
+ * @param capture_opts A structure containing options for the capture.
+ * @return A pointer to the statistics state data.
+ */
+extern if_stat_cache_t * capture_stat_start(capture_options *capture_opts);
 
-/* destroy the capture info dialog again */
-extern void capture_info_destroy(
-capture_info    *cinfo);
+/**
+ * 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);
 
-#endif /* HAVE_LIBPCAP */
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
 
-#define EMPTY_FILTER ""
 #endif /* capture.h */