2 * Definitions for packet capture windows
6 * Ethereal - Network traffic analyzer
7 * By Gerald Combs <gerald@ethereal.com>
8 * Copyright 1998 Gerald Combs
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 * Capture related things.
32 /** Name we give to the child process when doing a "-S" capture. */
33 #define CHILD_NAME "ethereal-capture"
37 /** Capture options coming from user interface */
38 typedef struct capture_options_tag {
40 void *cf; /**< handle to cfile (note: untyped handle) */
41 gchar *cfilter; /**< Capture filter string */
42 gchar *iface; /**< the network interface to capture from */
45 int buffer_size; /**< the capture buffer size (MB) */
47 gboolean has_snaplen; /**< TRUE if maximum capture packet length
49 int snaplen; /**< Maximum captured packet length */
50 gboolean promisc_mode; /**< Capture in promiscuous mode */
51 int linktype; /**< Data link type to use, or -1 for
53 gboolean capture_child; /**< True if this is the child for "-S" */
54 gchar *save_file; /**< the capture file name */
55 int save_file_fd; /**< File descriptor for saved file */
58 gboolean sync_mode; /**< Fork a child to do the capture,
59 and sync between them */
60 gboolean show_info; /**< show the info dialog */
61 gboolean quit_after_cap; /** Makes a "capture only mode". Implies -k */
63 /* multiple files (and ringbuffer) */
64 gboolean multi_files_on; /**< TRUE if ring buffer in use */
66 gboolean has_file_duration; /**< TRUE if ring duration specified */
67 gint32 file_duration; /* Switch file after n seconds */
68 gboolean has_ring_num_files;/**< TRUE if ring num_files specified */
69 guint32 ring_num_files; /**< Number of multiple buffer files */
71 /* autostop conditions */
72 gboolean has_autostop_files;/**< TRUE if maximum number of capture files
74 gint32 autostop_files; /**< Maximum number of capture files */
76 gboolean has_autostop_packets; /**< TRUE if maximum packet count is
78 int autostop_packets; /**< Maximum packet count */
79 gboolean has_autostop_filesize; /**< TRUE if maximum capture file size
81 gint32 autostop_filesize; /**< Maximum capture file size */
82 gboolean has_autostop_duration; /**< TRUE if maximum capture duration
84 gint32 autostop_duration; /**< Maximum capture duration */
86 /* internally used (don't touch from outside) */
87 int fork_child; /**< If not -1, in parent, process ID of child */
91 /* initialize the capture_options with some reasonable values */
93 capture_opts_init(capture_options *capture_opts, void *cfile);
96 capture_opt_add(capture_options *capture_opts, int opt, const char *optarg, gboolean *start_capture);
99 * Open a specified file, or create a temporary file, and start a capture
100 * to the file in question.
102 * @param capture_opts the numerous capture options
103 * @return TRUE if the capture starts successfully, FALSE otherwise.
105 extern gboolean do_capture(capture_options *capture_opts);
107 /** Do the low-level work of a capture (start the capture child). */
108 extern int capture_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats);
110 /** Stop a capture (usually from a menu item). */
111 extern void capture_stop(capture_options *capture_opts);
113 /** Terminate the capture child cleanly when exiting. */
114 extern void capture_kill_child(capture_options *capture_opts);
116 /** Do the low-level work of a capture. */
117 extern int capture_loop_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats);
119 /** Stop a low-level capture. */
120 extern void capture_loop_stop(void);
124 /** Current Capture info. */
127 gpointer callback_data; /**< capture callback handle */
128 gpointer ui; /**< user interfaces own handle */
131 packet_counts *counts; /**< protocol specific counters */
132 time_t running_time; /**< running time since last update */
133 gint new_packets; /**< packets since last update */
137 /** Create the capture info dialog */
138 extern void capture_info_create(
142 /** Update the capture info counters in the dialog */
143 extern void capture_info_update(
144 capture_info *cinfo);
146 /** Destroy the capture info dialog again */
147 extern void capture_info_destroy(
148 capture_info *cinfo);
151 #endif /* HAVE_LIBPCAP */
153 #endif /* capture.h */