diff options
author | ulfl <ulfl@f5534014-38df-0310-8fa8-9805f1628bb7> | 2004-06-04 17:19:01 +0000 |
---|---|---|
committer | ulfl <ulfl@f5534014-38df-0310-8fa8-9805f1628bb7> | 2004-06-04 17:19:01 +0000 |
commit | 8caacb27c118ea560ed04211224e89eaa80dc7c5 (patch) | |
tree | a61471bbf8501577ad5ae3f7609578a0b21be15b /capture.h | |
parent | 4e77eb9ff6568b97754cd4780f3c8abd2b849131 (diff) |
add more details for doxygen
git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@11107 f5534014-38df-0310-8fa8-9805f1628bb7
Diffstat (limited to 'capture.h')
-rw-r--r-- | capture.h | 83 |
1 files changed, 46 insertions, 37 deletions
@@ -1,7 +1,7 @@ /* capture.h * Definitions for packet capture windows * - * $Id: capture.h,v 1.45 2004/04/13 18:01:39 tuexen Exp $ + * $Id: capture.h,v 1.46 2004/06/04 17:19:01 ulfl Exp $ * * Ethereal - Network traffic analyzer * By Gerald Combs <gerald@ethereal.com> @@ -27,93 +27,102 @@ #ifdef HAVE_LIBPCAP -/* Name we give to the child process when doing a "-S" capture. */ +/** @file + * Capture related things. + */ + +/** Name we give to the child process when doing a "-S" capture. */ #define CHILD_NAME "ethereal-capture" +/** Capture options coming from user interface */ typedef struct { #ifdef _WIN32 - int buffer_size; /* the capture buffer size (MB) */ + int buffer_size; /**< the capture buffer size (MB) */ #endif - gboolean has_snaplen; /* TRUE if maximum capture packet + 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 linktype; /* Data link type to use, or -1 for + int snaplen; /**< Maximum captured packet length */ + int promisc_mode; /**< Capture in promiscuous mode */ + int linktype; /**< Data link type to use, or -1 for "use default" */ - int sync_mode; /* Fork a child to do the capture, + int sync_mode; /**< Fork a child to do the capture, and sync between them */ - gboolean multi_files_on; /* TRUE if ring buffer in use */ + gboolean multi_files_on; /**< TRUE if ring buffer in use */ - gboolean has_file_duration; /* TRUE if ring duration specified */ + 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 */ - gboolean has_autostop_files;/* TRUE if maximum number of capture files + gboolean has_ring_num_files;/**< TRUE if ring num_files specified */ + guint32 ring_num_files; /**< Number of multiple buffer files */ + gboolean has_autostop_files;/**< TRUE if maximum number of capture files are specified */ - gint32 autostop_files; /* Maximum number of capture files */ + gint32 autostop_files; /**< Maximum number of capture files */ - gboolean has_autostop_packets; /* TRUE if maximum packet count is + 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 + 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 + gint32 autostop_filesize; /**< Maximum capture file size */ + gboolean has_autostop_duration; /**< TRUE if maximum capture duration is specified */ - gint32 autostop_duration; /* Maximum capture duration */ + gint32 autostop_duration; /**< Maximum capture duration */ } capture_options; +/** Global capture options. */ extern capture_options capture_opts; -extern gboolean quit_after_cap; /* Makes a "capture only mode". Implies -k */ -extern gboolean capture_child; /* if this is the child for "-S" */ +/** Makes a "capture only mode". Implies -k */ +extern gboolean quit_after_cap; -/* Open a specified file, or create a temporary file, and start a capture +/** If this is the child for "-S" */ +extern gboolean capture_child; + +/** 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); -/* Do the low-level work of a capture. */ +/** Do the low-level work of a capture. */ int capture(gboolean *stats_known, struct pcap_stat *stats); -/* Stop a capture from a menu item. */ +/** Stop a capture from a menu item. */ void capture_stop(void); -/* Terminate the capture child cleanly when exiting. */ +/** Terminate the capture child cleanly when exiting. */ void kill_capture_child(void); - -/* XXX: improve this macro (put something like this into epan/packet.h?) */ +/** Number of packet counts. + * @todo improve this macro (put something like this into epan/packet.h?) */ #define CAPTURE_PACKET_COUNTS sizeof(packet_counts) / sizeof (gint) +/** Current Capture info. */ typedef struct { /* handles */ - gpointer callback_data; /* capture callback handle */ - gpointer ui; /* user interfaces own handle */ + 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 */ + packet_counts *counts; /**< protocol specific counters */ + time_t running_time; /**< running time since last update */ + gint new_packets; /**< packets since last update */ } capture_info; -/* create the capture info dialog */ +/** Create the capture info dialog */ extern void capture_info_create( capture_info *cinfo, gchar *iface); -/* Update the capture info counters in the dialog */ +/** Update the capture info counters in the dialog */ extern void capture_info_update( capture_info *cinfo); -/* destroy the capture info dialog again */ +/** Destroy the capture info dialog again */ extern void capture_info_destroy( capture_info *cinfo); #endif /* HAVE_LIBPCAP */ -#define EMPTY_FILTER "" #endif /* capture.h */ |