If we have pcap_open, call it instead of pcap_open_live, otherwise we might
[obnox/wireshark/wip.git] / capture.h
index e52582aa80e51a37e573c6d25bad29b1ebbd732d..79084bd8334210d96af30cc6a2a36c07b58f3535 100644 (file)
--- a/capture.h
+++ b/capture.h
@@ -3,8 +3,8 @@
  *
  * $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
@@ -22,6 +22,8 @@
  * 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__
 
  *  Capture related things.
  */
 
-/** Name we give to the child process when doing a "-S" capture. */
-#define        CHILD_NAME      "ethereal-capture"
-
-#ifdef HAVE_LIBPCAP
+#include "capture_opts.h"
 
-/** Capture options coming from user interface */
-typedef struct capture_options_tag {
-    /* general */
-    void *cf;               /**< handle to cfile (note: untyped handle) */
-#ifdef _WIN32
-    int buffer_size;        /**< the capture buffer size (MB) */
-#endif
-       gboolean has_snaplen;           /**< TRUE if maximum capture packet
-                                          length is specified */
-       int snaplen;                    /**< Maximum captured packet length */
-       gboolean promisc_mode;  /**< Capture in promiscuous mode */
-       int linktype;                   /**< Data link type to use, or -1 for
-                                          "use default" */
-       gboolean capture_child; /**< True if this is the child for "-S" */
-    gchar    *save_file;    /**< File the capture was saved in */
-    int      save_file_fd;  /**< File descriptor for saved file */
-
-    /* GUI related */
-       gboolean sync_mode;                     /**< Fork a child to do the capture,
-                                          and sync between them */
-    gboolean show_info;     /**< show the info dialog */
-    gboolean quit_after_cap;    /** Makes a "capture only mode". Implies -k */
-
-    /* multiple files (and ringbuffer) */
-    gboolean multi_files_on;    /**< TRUE if ring buffer in use */
-
-       gboolean has_file_duration;     /**< TRUE if ring duration specified */
-       gint32 file_duration;     /* Switch file after n seconds */
-       gboolean has_ring_num_files;/**< TRUE if ring num_files specified */
-       guint32 ring_num_files;         /**< Number of multiple buffer files */
-
-    /* autostop conditions */
-    gboolean has_autostop_files;/**< TRUE if maximum number of capture files
-                                          are specified */
-    gint32 autostop_files;      /**< Maximum number of capture files */
-
-    gboolean has_autostop_packets;     /**< TRUE if maximum packet count is
-                                          specified */
-       int autostop_packets;           /**< Maximum packet count */
-       gboolean has_autostop_filesize; /**< TRUE if maximum capture file size
-                                          is specified */
-       gint32 autostop_filesize;       /**< Maximum capture file size */
-       gboolean has_autostop_duration; /**< TRUE if maximum capture duration
-                                          is specified */
-       gint32 autostop_duration;       /**< Maximum capture duration */
-
-    /* internally used (don't touch from outside) */
-    int fork_child;                /**< If not -1, in parent, process ID of child */
-} capture_options;
-
-
-/** 
- * Open a specified file, or create a temporary file, and start a capture
- * to the file in question.  
+/**
+ * Start a capture session.
  *
  * @param capture_opts the numerous capture options
- * @param save_file the name of the capture file, or NULL for a temporary file
  * @return TRUE if the capture starts successfully, FALSE otherwise.
  */
-extern gboolean do_capture(capture_options *capture_opts, const char *save_file);
+extern gboolean capture_start(capture_options *capture_opts);
 
-/** Do the low-level work of a capture (start the capture child). */
-extern int  capture_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats);
-
-/** Stop a capture (usually from a menu item). */
+/** Stop a capture session (usually from a menu item). */
 extern void capture_stop(capture_options *capture_opts);
 
+/** Restart the current captured packets and start again. */
+extern void capture_restart(capture_options *capture_opts);
+
 /** Terminate the capture child cleanly when exiting. */
-extern void kill_capture_child(capture_options *capture_opts);
+extern void capture_kill_child(capture_options *capture_opts);
 
-/** Do the low-level work of a capture. */
-extern int  capture_loop_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats);
+/**
+ * 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);
 
-/** Stop a low-level capture. */
-extern void capture_loop_stop(void);
+/**
+ * Capture child told us how many dropped packets it counted.
+ */
+extern void capture_input_drops(capture_options *capture_opts, int 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);
 
+/**
+ * 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, char *error_message);
 
-/** Current Capture info. */
-typedef struct {
-    /* handles */
-    gpointer        callback_data;  /**< capture callback handle */
-    gpointer        ui;             /**< user interfaces own handle */
+/**
+ * Capture child closed its side of the pipe, do the required cleanup.
+ */
+extern void capture_input_closed(capture_options *capture_opts);
 
-    /* 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;
+#ifdef HAVE_LIBPCAP
+/**
+ * Fetch the interface list from a child process.
+ */
+extern GList *capture_interface_list(int *err, char **err_str);
 
+/**
+ * Fetch the linktype list for the specified interface from a child process.
+ */
+extern GList *capture_pcap_linktype_list(const char *devname, char **err_str);
 
-/** Create the capture info dialog */
-extern void capture_info_create(
-capture_info    *cinfo,
-gchar           *iface);
 
-/** Update the capture info counters in the dialog */
-extern void capture_info_update(
-capture_info    *cinfo);
+struct if_stat_cache_s;
+typedef struct if_stat_cache_s if_stat_cache_t;
 
-/** Destroy the capture info dialog again */
-extern void capture_info_destroy(
-capture_info    *cinfo);
+/**
+ * Start gathering capture statistics for the interfaces specified.
+ * @param A GList of if_info_t items
+ * @return A pointer to the statistics state data.
+ */
+extern if_stat_cache_t * capture_stat_start(GList *if_list);
 
+/**
+ * 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 */
 
 #endif /* capture.h */