X-Git-Url: http://git.samba.org/samba.git/?a=blobdiff_plain;f=capture.h;h=a09829d58ee37e258cebc782fe08085fa20a7762;hb=9c6e25c14da7480cd444590e2205544c76357403;hp=0d1c9d83399ba77140dee33f9c99df46ac3f3aaf;hpb=281710f10d2a67eaa6668571661e9ef4250a7768;p=obnox%2Fwireshark%2Fwip.git diff --git a/capture.h b/capture.h index 0d1c9d8339..a09829d58e 100644 --- a/capture.h +++ b/capture.h @@ -3,8 +3,8 @@ * * $Id$ * - * Ethereal - Network traffic analyzer - * By Gerald Combs + * Wireshark - Network traffic analyzer + * By Gerald Combs * 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__ @@ -29,107 +31,96 @@ * Capture related things. */ -/** Name we give to the child process when doing a "-S" capture. */ -#define CHILD_NAME "ethereal-capture" - -#ifdef HAVE_LIBPCAP - -/** Capture options coming from user interface */ -typedef struct capture_options_tag { - /* general */ -#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" */ - 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 */ -} capture_options; - - -/** Open a specified file, or create a temporary file, and start a capture - * to the file in question. - * - * @return TRUE if the capture starts successfully, FALSE otherwise. */ -extern gboolean do_capture(capture_options *capture_opts, const char *save_file); +#include "capture_opts.h" -/** 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); +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; -/** Stop a capture from a menu item. */ -extern void capture_stop(gboolean sync_mode); +typedef void (*capture_callback_t) (gint event, capture_options *capture_opts, + gpointer user_data); -/** Terminate the capture child cleanly when exiting. */ -extern void kill_capture_child(gboolean sync_mode); +extern void +capture_callback_add(capture_callback_t func, gpointer user_data); -/** Do the low-level work of a capture. */ -extern int capture_loop_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats); +extern void +capture_callback_remove(capture_callback_t func); -/** Stop a low-level capture. */ -extern void capture_loop_stop(void); +/** + * 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); -/** Current Capture info. */ -typedef struct { - /* handles */ - gpointer callback_data; /**< capture callback handle */ - gpointer ui; /**< user interfaces own handle */ +/** + * Capture child told us how many dropped packets it counted. + */ +extern void capture_input_drops(capture_options *capture_opts, guint32 dropped); - /* 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 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, guint i, char *error_message); -/** Create the capture info dialog */ -extern void capture_info_create( -capture_info *cinfo, -gchar *iface); +/** + * Capture child closed its side of the pipe, report any error and + * do the required cleanup. + */ +extern void capture_input_closed(capture_options *capture_opts, gchar *msg); -/** 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 if_list 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); #endif /* capture.h */