ui/summary.h

   1 /* summary.h
   2  * Definitions for capture file summary data
   3  *
   4  * Wireshark - Network traffic analyzer
   5  * By Gerald Combs <gerald@wireshark.org>
   6  * Copyright 1998 Gerald Combs
   7  *
   8  * SPDX-License-Identifier: GPL-2.0-or-later
   9  */
  10
  11 #ifndef __SUMMARY_H__
  12 #define __SUMMARY_H__
  13
  14 #ifdef HAVE_LIBPCAP
  15 #include "ui/capture.h"
  16 #endif
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif /* __cplusplus */
  21
  22 typedef struct iface_options_tag {
  23   char     *name;
  24   char     *descr;
  25   char     *cfilter;
  26   char     *isb_comment;
  27   guint64   drops;                 /**< number of packet drops */
  28   gboolean  drops_known;           /**< TRUE if number of packet drops is known */
  29   int       snap;                  /**< Maximum captured packet length; 0 if not known */
  30   int       encap_type;            /**< wiretap encapsulation type */
  31 } iface_options;
  32
  33 typedef struct _summary_tally {
  34   guint64      bytes;              /**< total bytes */
  35   double       start_time;         /**< seconds, with msec resolution */
  36   double       stop_time;          /**< seconds, with msec resolution */
  37   double       elapsed_time;       /**< seconds, with msec resolution,
  38                                      includes time before first packet
  39                                      and after last packet */
  40   guint32      marked_count;       /**< number of marked packets */
  41   guint32      marked_count_ts;    /**< number of time-stamped marked packets */
  42   guint64      marked_bytes;       /**< total bytes in the marked packets */
  43   double       marked_start;       /**< time in seconds, with msec resolution */
  44   double       marked_stop;        /**< time in seconds, with msec resolution */
  45   guint32      ignored_count;      /**< number of ignored packets */
  46   guint32      packet_count;       /**< total number of packets in trace */
  47   guint32      packet_count_ts;    /**< total number of time-stamped packets in trace */
  48   guint32      filtered_count;     /**< number of filtered packets */
  49   guint32      filtered_count_ts;  /**< number of time-stamped filtered packets */
  50   guint64      filtered_bytes;     /**< total bytes in the filtered packets */
  51   double       filtered_start;     /**< time in seconds, with msec resolution */
  52   double       filtered_stop;      /**< time in seconds, with msec resolution */
  53   const char  *filename;
  54   gint64       file_length;        /**< file length in bytes */
  55   int          file_type;          /**< wiretap file type */
  56   int          iscompressed;       /**< TRUE if file is compressed */
  57   int          file_encap_type;    /**< wiretap encapsulation type for file */
  58   GArray      *packet_encap_types; /**< wiretap encapsulation types for packets */
  59   int          snap;               /**< Maximum captured packet length; 0 if not known */
  60   gboolean     drops_known;        /**< TRUE if number of packet drops is known */
  61   guint64      drops;              /**< number of packet drops */
  62   const char  *dfilter;            /**< display filter */
  63   gboolean     is_tempfile;
  64   /* capture related, use summary_fill_in_capture() to get values */
  65   GArray      *ifaces;
  66   gboolean     legacy;
  67 } summary_tally;
  68
  69 extern void
  70 summary_fill_in(capture_file *cf, summary_tally *st);
  71
  72 #ifdef HAVE_LIBPCAP
  73 extern void
  74 summary_fill_in_capture(capture_file *cf, capture_options *capture_opts, summary_tally *st);
  75 #endif
  76
  77 #ifdef __cplusplus
  78 }
  79 #endif /* __cplusplus */
  80
  81 #endif /* summary.h */
  82
  83 /*
  84  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
  85  *
  86  * Local Variables:
  87  * c-basic-offset: 2
  88  * tab-width: 8
  89  * indent-tabs-mode: nil
  90  * End:
  91  *
  92  * vi: set shiftwidth=2 tabstop=8 expandtab:
  93  * :indentSize=2:tabSize=8:noTabs=true:
  94  */