capture.h

   1 /* capture.h
   2  * Definitions for packet capture windows
   3  *
   4  * $Id$
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@ethereal.com>
   8  * Copyright 1998 Gerald Combs
   9  *
  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.
  14  *
  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.
  19  *
  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.
  23  */
  24
  25 #ifndef __CAPTURE_H__
  26 #define __CAPTURE_H__
  27
  28 /** @file
  29  *  Capture related things.
  30  */
  31
  32 /** Name we give to the child process when doing a "-S" capture. */
  33 #define CHILD_NAME      "ethereal-capture"
  34
  35 #ifdef HAVE_LIBPCAP
  36
  37 /** Capture options coming from user interface */
  38 typedef struct capture_options_tag {
  39     /* general */
  40 #ifdef _WIN32
  41     int buffer_size;        /**< the capture buffer size (MB) */
  42 #endif
  43         gboolean has_snaplen;           /**< TRUE if maximum capture packet
  44                                            length is specified */
  45         int snaplen;                    /**< Maximum captured packet length */
  46         gboolean promisc_mode;  /**< Capture in promiscuous mode */
  47         int linktype;                   /**< Data link type to use, or -1 for
  48                                            "use default" */
  49         gboolean capture_child; /**< True if this is the child for "-S" */
  50
  51     /* GUI related */
  52         gboolean sync_mode;                     /**< Fork a child to do the capture,
  53                                            and sync between them */
  54     gboolean show_info;     /**< show the info dialog */
  55     gboolean quit_after_cap;    /** Makes a "capture only mode". Implies -k */
  56
  57     /* multiple files (and ringbuffer) */
  58     gboolean multi_files_on;    /**< TRUE if ring buffer in use */
  59
  60         gboolean has_file_duration;     /**< TRUE if ring duration specified */
  61         gint32 file_duration;     /* Switch file after n seconds */
  62         gboolean has_ring_num_files;/**< TRUE if ring num_files specified */
  63         guint32 ring_num_files;         /**< Number of multiple buffer files */
  64
  65     /* autostop conditions */
  66     gboolean has_autostop_files;/**< TRUE if maximum number of capture files
  67                                            are specified */
  68     gint32 autostop_files;      /**< Maximum number of capture files */
  69
  70     gboolean has_autostop_packets;      /**< TRUE if maximum packet count is
  71                                            specified */
  72         int autostop_packets;           /**< Maximum packet count */
  73         gboolean has_autostop_filesize; /**< TRUE if maximum capture file size
  74                                            is specified */
  75         gint32 autostop_filesize;       /**< Maximum capture file size */
  76         gboolean has_autostop_duration; /**< TRUE if maximum capture duration
  77                                            is specified */
  78         gint32 autostop_duration;       /**< Maximum capture duration */
  79 } capture_options;
  80
  81
  82 /** Open a specified file, or create a temporary file, and start a capture
  83  * to the file in question.
  84  *
  85  * @return TRUE if the capture starts successfully, FALSE otherwise. */
  86 extern gboolean do_capture(capture_options *capture_opts, const char *save_file);
  87
  88 /** Do the low-level work of a capture (start the capture child). */
  89 extern int  capture_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats);
  90
  91 /** Stop a capture from a menu item. */
  92 extern void capture_stop(gboolean sync_mode);
  93
  94 /** Terminate the capture child cleanly when exiting. */
  95 extern void kill_capture_child(gboolean sync_mode);
  96
  97 /** Do the low-level work of a capture. */
  98 extern int  capture_loop_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats);
  99
 100 /** Stop a low-level capture. */
 101 extern void capture_loop_stop(void);
 102
 103
 104
 105 /** Current Capture info. */
 106 typedef struct {
 107     /* handles */
 108     gpointer        callback_data;  /**< capture callback handle */
 109     gpointer        ui;             /**< user interfaces own handle */
 110
 111     /* capture info */
 112     packet_counts   *counts;        /**< protocol specific counters */
 113     time_t          running_time;   /**< running time since last update */
 114     gint            new_packets;    /**< packets since last update */
 115 } capture_info;
 116
 117
 118 /** Create the capture info dialog */
 119 extern void capture_info_create(
 120 capture_info    *cinfo,
 121 gchar           *iface);
 122
 123 /** Update the capture info counters in the dialog */
 124 extern void capture_info_update(
 125 capture_info    *cinfo);
 126
 127 /** Destroy the capture info dialog again */
 128 extern void capture_info_destroy(
 129 capture_info    *cinfo);
 130
 131
 132 #endif /* HAVE_LIBPCAP */
 133
 134 #endif /* capture.h */