aboutsummaryrefslogtreecommitdiffstats
path: root/capture.h
blob: 0b2bec89ed090fdf0debd0a1811afd799d2003f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/* capture.h
 * Definitions for packet capture windows
 *
 * $Id$
 *
 * Ethereal - Network traffic analyzer
 * 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.
 */

#ifndef __CAPTURE_H__
#define __CAPTURE_H__

/** @file
 *  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" */

    /* 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);

/** 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);

/** Stop a capture from a menu item. */
extern void capture_stop(gboolean sync_mode);

/** Terminate the capture child cleanly when exiting. */
extern void kill_capture_child(gboolean sync_mode);

/** Do the low-level work of a capture. */
extern int  capture_loop_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats);

/** Stop a low-level capture. */
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;


/** Create the capture info dialog */
extern void capture_info_create(
capture_info    *cinfo,
gchar           *iface);

/** Update the capture info counters in the dialog */
extern void capture_info_update(
capture_info    *cinfo);

/** Destroy the capture info dialog again */
extern void capture_info_destroy(
capture_info    *cinfo);


#endif /* HAVE_LIBPCAP */

#endif /* capture.h */