/* capture.h
* Definitions for packet capture windows
*
- * $Id: capture.h,v 1.38 2003/11/15 08:47:28 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
* 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. */
-#define CHILD_NAME "ethereal-capture"
+#include "capture_opts.h"
-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 */
- 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;
+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;
-extern capture_options capture_opts;
+typedef void (*capture_callback_t) (gint event, capture_options *capture_opts,
+ gpointer user_data);
-extern int quit_after_cap; /* Makes a "capture only mode". Implies -k */
-extern gboolean capture_child; /* if this is the child for "-S" */
+extern void
+capture_callback_add(capture_callback_t func, gpointer user_data);
-/* 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);
+extern void
+capture_callback_remove(capture_callback_t func);
-/* Do the low-level work of a capture. */
-int capture(gboolean *stats_known, struct pcap_stat *stats);
+/**
+ * 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 from a menu item. */
-void capture_stop(void);
+/** Stop a capture session (usually from a menu item). */
+extern void capture_stop(capture_options *capture_opts);
-/* Terminate the capture child cleanly when exiting. */
-void kill_capture_child(void);
+/** 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);
-/* XXX: improve this macro (put something like this into epan/packet.h?) */
-#define CAPTURE_PACKET_COUNTS sizeof(packet_counts) / sizeof (gint)
+/**
+ * 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);
-typedef struct {
- /* handles */
- gpointer callback_data; /* capture callback handle */
- gpointer ui; /* user interfaces own handle */
+/**
+ * Capture child told us we have new packets to read.
+ */
+extern void capture_input_new_packets(capture_options *capture_opts, int to_read);
- /* 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;
+/**
+ * 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);
-/* create the capture info dialog */
-extern void capture_info_create(
-capture_info *cinfo);
+/**
+ * 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);
-/* Update the capture info counters in the dialog */
-extern void capture_info_update(
-capture_info *cinfo);
+/**
+ * Capture child closed its side of the pipe, do the required cleanup.
+ */
+extern void capture_input_closed(capture_options *capture_opts);
-/* destroy the capture info dialog again */
-extern void capture_info_destroy(
-capture_info *cinfo);
+struct if_stat_cache_s;
+typedef struct if_stat_cache_s if_stat_cache_t;
-/* ui calls this, when user wants to stop capturing */
-extern void capture_ui_stop_callback(
-gpointer callback_data);
+/**
+ * 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);
-#endif /* HAVE_LIBPCAP */
+/**
+ * Stop gathering capture statistics.
+ */
+void capture_stat_stop(if_stat_cache_t *sc);
-#define EMPTY_FILTER ""
#endif /* capture.h */
git.samba.org / obnox / wireshark / wip.git / blobdiff