Ethereal->Wireshark

[obnox/wireshark/wip.git] / capture.h

diff --git a/capture.h b/capture.h
index b90e04bbd55cad038d49fa664fd3a7b0262754f6..c362dae5e5fdfb1fa33ade970124783d20105f07 100644 (file)
--- a/capture.h
+++ b/capture.h
@@ -1,13 +1,12 @@
 /* capture.h
  * Definitions for packet capture windows
  *
- * $Id: capture.h,v 1.32 2002/08/28 21:00:05 jmayer 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
@@ -23,54 +22,64 @@
  * 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
-
-/* 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 ringbuffer_num_files;   /* Number of ring buffer files */
-} capture_options;
-
-extern capture_options capture_opts;
-
-extern int sync_pipe[2]; /* used to sync father */
-extern int quit_after_cap; /* Makes a "capture only mode". Implies -k */
-extern gboolean capture_child; /* if this is the child for "-S" */
-
-/* Open a specified file, or create a temporary file, and start a capture
-   to the file in question. */
-void   do_capture(char *capfile_name);
-
-/* Do the low-level work of a capture. */
-int    capture(gboolean *stats_known, struct pcap_stat *stats);
-
-/* Stop a capture from a menu item. */
-void   capture_stop(void);
-
-/* Terminate the capture child cleanly when exiting. */
-void   kill_capture_child(void);
-
-#endif /* HAVE_LIBPCAP */
-
-#define EMPTY_FILTER ""
+/** @file
+ *  Capture related things.
+ */
+
+#include "capture_opts.h"
+
+/** 
+ * 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);
+
+/** 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 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, 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);
+
+/**
+ * Capture child closed its side of the pipe, do the required cleanup.
+ */
+extern void capture_input_closed(capture_options *capture_opts);
+
+
 #endif /* capture.h */