capture_opts.h

   1 /* capture_opts.h
   2  * Capture options (all parameters needed to do the actual capture)
   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
  26 /** @file
  27  *
  28  *  Capture options (all parameters needed to do the actual capture)
  29  *
  30  */
  31
  32 #ifndef __CAPTURE_OPTS_H__
  33 #define __CAPTURE_OPTS_H__
  34
  35
  36 /* Current state of capture engine. XXX - differentiate states */
  37 typedef enum {
  38     CAPTURE_STOPPED,        /**< stopped */
  39     CAPTURE_PREPARING,      /**< preparing, but still no response from capture child */
  40     CAPTURE_RUNNING         /**< capture child signalled ok, capture is running now */
  41 } capture_state;
  42
  43
  44 /** Capture options coming from user interface */
  45 typedef struct capture_options_tag {
  46     /* general */
  47     void     *cf;           /**< handle to cfile (note: untyped handle) */
  48     gchar    *cfilter;      /**< Capture filter string */
  49     gchar    *iface;        /**< the network interface to capture from */
  50
  51 #ifdef _WIN32
  52     int      buffer_size;   /**< the capture buffer size (MB) */
  53 #endif
  54     gboolean has_snaplen;   /**< TRUE if maximum capture packet length
  55                                  is specified */
  56     int      snaplen;       /**< Maximum captured packet length */
  57     gboolean promisc_mode;  /**< Capture in promiscuous mode */
  58     int      linktype;      /**< Data link type to use, or -1 for
  59                                  "use default" */
  60     gboolean saving_to_file; /**< TRUE if capture is writing to a file */
  61     gchar    *save_file;    /**< the capture file name */
  62
  63     /* GUI related */
  64     gboolean real_time_mode;    /**< Update list of packets in real time */
  65     gboolean show_info;         /**< show the info dialog */
  66     gboolean quit_after_cap;    /** Makes a "capture only mode". Implies -k */
  67     gboolean restart;           /**< restart after closing is done */
  68
  69     /* multiple files (and ringbuffer) */
  70     gboolean multi_files_on;    /**< TRUE if ring buffer in use */
  71
  72     gboolean has_file_duration;    /**< TRUE if ring duration specified */
  73     gint32 file_duration;       /* Switch file after n seconds */
  74     gboolean has_ring_num_files;/**< TRUE if ring num_files specified */
  75     guint32 ring_num_files;     /**< Number of multiple buffer files */
  76
  77     /* autostop conditions */
  78     gboolean has_autostop_files;/**< TRUE if maximum number of capture files
  79                        are specified */
  80     gint32 autostop_files;      /**< Maximum number of capture files */
  81
  82     gboolean has_autostop_packets;    /**< TRUE if maximum packet count is
  83                        specified */
  84     int autostop_packets;               /**< Maximum packet count */
  85     gboolean has_autostop_filesize;     /**< TRUE if maximum capture file size
  86                                              is specified */
  87     gint32 autostop_filesize;           /**< Maximum capture file size */
  88     gboolean has_autostop_duration;     /**< TRUE if maximum capture duration
  89                                              is specified */
  90     gint32 autostop_duration;           /**< Maximum capture duration */
  91
  92     /* internally used (don't touch from outside) */
  93     int fork_child;                  /**< If not -1, in parent, process ID of child */
  94 #ifdef _WIN32
  95     int signal_pipe_write_fd;   /**< the pipe to signal the child */
  96 #endif
  97     capture_state state;        /**< current state of the capture engine */
  98     gboolean output_to_pipe;    /**< save_file is a pipe (named or stdout) */
  99 } capture_options;
 100
 101
 102 /* initialize the capture_options with some reasonable values */
 103 extern void
 104 capture_opts_init(capture_options *capture_opts, void *cfile);
 105
 106 /* set a command line option value */
 107 extern int
 108 capture_opts_add_opt(capture_options *capture_opts, int opt, const char *optarg, gboolean *start_capture);
 109
 110 /* log content of capture_opts */
 111 extern void
 112 capture_opts_log(const char *log_domain, GLogLevelFlags log_level, capture_options *capture_opts);
 113
 114 /* list link layer types */
 115 extern int
 116 capture_opts_list_link_layer_types(capture_options *capture_opts);
 117
 118 /* list interfaces */
 119 extern int
 120 capture_opts_list_interfaces(void);
 121
 122 /* trim the snaplen entry */
 123 extern void
 124 capture_opts_trim_snaplen(capture_options *capture_opts, int snaplen_min);
 125
 126 /* trim the ring_num_files entry */
 127 extern void
 128 capture_opts_trim_ring_num_files(capture_options *capture_opts);
 129
 130 /* trim the interface entry */
 131 extern gboolean
 132 capture_opts_trim_iface(capture_options *capture_opts, const char *capture_device);
 133
 134 #endif /* capture_opts.h */