Upgrade user manual

[metze/wireshark/wip.git] / summary.h

diff --git a/summary.h b/summary.h
index ed64ae669ab71e22a26a565385f5cab6905d8dde..b1cf07ea8c510defc051fa2f9f572fc98a5ba75d 100644 (file)
--- a/summary.h
+++ b/summary.h
@@ -1,13 +1,12 @@
 /* summary.h
  * Definitions for capture file summary data
  *
- * $Id: summary.h,v 1.5 2000/08/21 18:20:12 deniel Exp $
+ * $Id$
  *
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@zing.org>
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
  * 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
@@ -20,37 +19,84 @@
  *
  * 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.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #ifndef __SUMMARY_H__
 #define __SUMMARY_H__
 
-typedef struct _summary_tally {
-    guint32    bytes;          /* total bytes */
-    double     start_time;     /* seconds, with msec resolution */
-    double     stop_time;      /* seconds, with msec resolution */
-    double     elapsed_time;   /* seconds, with msec resolution,
-                                  includes time before first packet
-                                  and after last packet */
-    int                filtered_count; /* number of filtered packets */
-    int                marked_count;   /* number of marked packets */
-    int                packet_count;   /* total number of packets in trace */
-    const char *filename;
-    long       file_length;    /* file length in bytes */
-    int                encap_type;     /* wiretap encapsulation type */
-    int                snap;           /* snapshot length */
-    int         drops;         /* number of packet drops */
-    const char *iface;         /* interface name */
-    const char *dfilter;       /* display filter */
-    const char *cfilter;       /* capture filter */
-} summary_tally;
+#ifdef HAVE_LIBPCAP
+#include "capture.h"
+#endif
 
-void summary_fill_in(summary_tally *st);
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
 
-#endif /* summary.h */
+typedef struct iface_options_tag {
+    char    *name;
+    char    *descr;
+    char    *cfilter;
+    char    *isb_comment;
+    guint64  drops;          /**< number of packet drops */
+    gboolean drops_known;    /**< TRUE if number of packet drops is known */
+    gboolean has_snap;       /**< TRUE if maximum capture packet length is known */
+    int      snap;           /**< Maximum captured packet length */
+    int      encap_type;     /**< wiretap encapsulation type */
+} iface_options;
 
+typedef struct _summary_tally {
+    guint64      bytes;             /**< total bytes */
+    double       start_time;        /**< seconds, with msec resolution */
+    double       stop_time;         /**< seconds, with msec resolution */
+    double       elapsed_time;      /**< seconds, with msec resolution,
+                                         includes time before first packet
+                                         and after last packet */
+    guint32      marked_count;      /**< number of marked packets */
+    guint32      marked_count_ts;   /**< number of time-stamped marked packets */
+    guint64      marked_bytes;      /**< total bytes in the marked packets */
+    double       marked_start;      /**< time in seconds, with msec resolution */
+    double       marked_stop;       /**< time in seconds, with msec resolution */
+    guint32      ignored_count;     /**< number of ignored packets */
+    guint32      packet_count;      /**< total number of packets in trace */
+    guint32      packet_count_ts;   /**< total number of time-stamped packets in trace */
+    guint32      filtered_count;    /**< number of filtered packets */
+    guint32      filtered_count_ts; /**< number of time-stamped filtered packets */
+    guint64      filtered_bytes;    /**< total bytes in the filtered packets */
+    double       filtered_start;    /**< time in seconds, with msec resolution */
+    double       filtered_stop;     /**< time in seconds, with msec resolution */
+    const char  *filename;
+    gint64        file_length;      /**< file length in bytes */
+    int           file_type;        /**< wiretap file type */
+    int           iscompressed;     /**< TRUE if file is compressed */
+    int           file_encap_type;  /**< wiretap encapsulation type for file */
+    GArray       *packet_encap_types; /**< wiretap encapsulation types for packets */
+    gboolean      has_snap;         /**< TRUE if maximum capture packet length is known */
+    int           snap;             /**< Maximum captured packet length */
+    gboolean      drops_known;      /**< TRUE if number of packet drops is known */
+    guint64       drops;            /**< number of packet drops */
+    const char   *dfilter;          /**< display filter */
+    gboolean      is_tempfile;
+    /* from SHB, use summary_fill_shb_inf() to get values */
+    gchar        *opt_comment;      /**< comment from SHB block */
+    gchar        *shb_hardware;     /**< Capture HW from SHB block */
+    gchar        *shb_os;           /**< The OS the capture was made on from SHB block */
+    const gchar  *shb_user_appl;    /**< The application that made the capture from SHB block */
+    /* capture related, use summary_fill_in_capture() to get values */
+    GArray       *ifaces;
+    gboolean      legacy;
+} summary_tally;
 
+extern void
+summary_fill_in(capture_file *cf, summary_tally *st);
 
+#ifdef HAVE_LIBPCAP
+extern void
+summary_fill_in_capture(capture_file *cf, capture_options *capture_opts, summary_tally *st);
+#endif
 
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
 
+#endif /* summary.h */