/* capture.h
* Definitions for packet capture windows
*
- * $Id: capture.h,v 1.31 2002/02/24 09:25:34 guy Exp $
+ * $Id$
*
* Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@zing.org>
+ * By Gerald Combs <gerald@ethereal.com>
* 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.
+ */
-/* Name we give to the child process when doing a "-S" capture. */
+/** 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
+
+/* Current state of capture engine. XXX - differentiate states */
+typedef enum {
+ CAPTURE_STOPPED, /**< stopped */
+ CAPTURE_PREPARING, /**< preparing, but still no response from capture child */
+ CAPTURE_RUNNING /**< capture child signalled ok, capture is running now */
+} capture_state;
+
+
+/** Capture options coming from user interface */
+typedef struct capture_options_tag {
+ /* general */
+ void *cf; /**< handle to cfile (note: untyped handle) */
+ gchar *cfilter; /**< Capture filter string */
+ gchar *iface; /**< the network interface to capture from */
+
+#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" */
+ gchar *save_file; /**< the capture file name */
+
+ /* GUI related */
+ gboolean real_time_mode; /**< Update list of packets in real time */
+ gboolean show_info; /**< show the info dialog */
+ gboolean quit_after_cap; /** Makes a "capture only mode". Implies -k */
+ gboolean restart; /**< restart after closing is done */
+
+ /* 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_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 */
+ 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 */
+#ifdef _WIN32
+ int signal_pipe_fd; /**< the pipe to signal the child */
+#endif
+ capture_state state; /**< current state of the capture engine */
} 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" */
+/* initialize the capture_options with some reasonable values */
+extern void
+capture_opts_init(capture_options *capture_opts, void *cfile);
+
+extern void
+capture_opts_add_opt(capture_options *capture_opts, const char *appname, int opt, const char *optarg, gboolean *start_capture);
+
+/* log content of capture_opts */
+extern void
+capture_opts_log(const char *log_domain, GLogLevelFlags log_level, capture_options *capture_opts);
+
+
+
+/**
+ * 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 closed it's side ot the pipe, do the required cleanup.
+ */
+extern void capture_input_closed(capture_options *capture_opts);
+
+
+
+/** Do the low-level work of a capture (start the capture child).
+ * Returns TRUE if it succeeds, FALSE otherwise. */
+extern int capture_loop_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats);
+
+/** Stop a low-level capture (stops the capture child). */
+extern void capture_loop_stop(void);
+
+
+
+/** Current Capture info. */
+typedef struct {
+ /* handles */
+ gpointer callback_data; /**< capture callback handle */
+ gpointer ui; /**< user interfaces own handle */
+
+ /* 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;
-/* 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);
+/** Create the capture info dialog */
+extern void capture_info_create(
+capture_info *cinfo,
+gchar *iface);
-/* Stop a capture from a menu item. */
-void capture_stop(void);
+/** Update the capture info counters in the dialog */
+extern void capture_info_update(
+capture_info *cinfo);
-/* Terminate the capture child cleanly when exiting. */
-void kill_capture_child(void);
+/** Destroy the capture info dialog again */
+extern void capture_info_destroy(
+capture_info *cinfo);
-#endif /* HAVE_LIBPCAP */
-#define EMPTY_FILTER ""
#endif /* capture.h */
git.samba.org / obnox / wireshark / wip.git / blobdiff