summary.h

   1 /* summary.h
   2  * Definitions for capture file summary data
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   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 __SUMMARY_H__
  26 #define __SUMMARY_H__
  27
  28 #ifdef HAVE_LIBPCAP
  29 #include "capture.h"
  30 #endif
  31
  32 typedef struct iface_options_tag {
  33     char        *name;
  34     char        *descr;
  35     char        *cfilter;
  36     guint64     drops;          /* number of packet drops */
  37     gboolean    drops_known;    /* TRUE if number of packet drops is known */
  38     gboolean    has_snap;       /* TRUE if maximum capture packet length is known */
  39     int         snap;           /* Maximum captured packet length */
  40     int         linktype;       /* wiretap encapsulation type */
  41 } iface_options;
  42
  43 typedef struct _summary_tally {
  44     guint64     bytes;                  /**< total bytes */
  45     double      start_time;             /**< seconds, with msec resolution */
  46     double      stop_time;              /**< seconds, with msec resolution */
  47     double      elapsed_time;           /**< seconds, with msec resolution,
  48                                            includes time before first packet
  49                                            and after last packet */
  50     guint32     marked_count;           /**< number of marked packets */
  51     guint32     marked_count_ts;        /**< number of time-stamped marked packets */
  52     guint64     marked_bytes;           /**< total bytes in the marked packets */
  53     double      marked_start;           /**< time in seconds, with msec resolution */
  54     double      marked_stop;            /**< time in seconds, with msec resolution */
  55     guint32     ignored_count;          /**< number of ignored packets */
  56     guint32     packet_count;           /**< total number of packets in trace */
  57     guint32     packet_count_ts;        /**< total number of time-stamped packets in trace */
  58     guint32     filtered_count;         /**< number of filtered packets */
  59     guint32     filtered_count_ts;      /**< number of time-stamped filtered packets */
  60     guint64     filtered_bytes;         /**< total bytes in the filtered packets */
  61     double      filtered_start;         /**< time in seconds, with msec resolution */
  62     double      filtered_stop;          /**< time in seconds, with msec resolution */
  63     const char  *filename;
  64     gint64      file_length;            /**< file length in bytes */
  65     int         file_type;              /**< wiretap file type */
  66     int         encap_type;             /**< wiretap encapsulation type */
  67     gboolean    has_snap;               /**< TRUE if maximum capture packet length is known */
  68     int         snap;                   /**< Maximum captured packet length */
  69     gboolean    drops_known;            /**< TRUE if number of packet drops is known */
  70     guint64     drops;                  /**< number of packet drops */
  71     const char  *dfilter;               /**< display filter */
  72     gboolean    is_tempfile;
  73         /* from SHB, use summary_fill_shb_inf() to get values */
  74     gchar       *opt_comment;           /**< comment from SHB block */
  75     gchar       *shb_hardware;          /**< Capture HW from SHB block */
  76     gchar       *shb_os;                /**< The OS the capture was made on from SHB block */
  77     gchar       *shb_user_appl;         /**< The application that made the capture from SHB block */
  78     /* capture related, use summary_fill_in_capture() to get values */
  79     GArray      *ifaces;
  80     gboolean    legacy;
  81 } summary_tally;
  82
  83 extern void
  84 summary_fill_in(capture_file *cf, summary_tally *st);
  85
  86 #ifdef HAVE_LIBPCAP
  87 extern void
  88 summary_fill_in_capture(capture_file *cf, capture_options *capture_opts, summary_tally *st);
  89 #endif
  90
  91 #endif /* summary.h */
  92
  93
  94
  95
  96