epan/timestats.h

   1 /* timestats.h
   2  * Routines and definitions for time statistics
   3  * Copyright 2003 Lars Roland
   4  *
   5  * Wireshark - Network traffic analyzer
   6  * By Gerald Combs <gerald@wireshark.org>
   7  * Copyright 1998 Gerald Combs
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * as published by the Free Software Foundation; either version 2
  12  * of the License, or (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22  */
  23
  24 #ifndef __TIMESTATS_H__
  25 #define __TIMESTATS_H__
  26
  27 #include <glib.h>
  28 #include "epan/packet_info.h"
  29 #include "wsutil/nstime.h"
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif /* __cplusplus */
  34
  35  /* Summary of time statistics*/
  36 typedef struct _timestat_t {
  37         guint32 num;     /* number of samples */
  38         guint32 min_num; /* frame number of minimum */
  39         guint32 max_num; /* frame number of maximum */
  40         nstime_t min;
  41         nstime_t max;
  42         nstime_t tot;
  43         gdouble variance;
  44 } timestat_t;
  45
  46 /* functions */
  47
  48 /* Initialize a timestat_t struct */
  49 WS_DLL_PUBLIC void time_stat_init(timestat_t *stats);
  50
  51 /* Update a timestat_t struct with a new sample */
  52 WS_DLL_PUBLIC void time_stat_update(timestat_t *stats, const nstime_t *delta, packet_info *pinfo);
  53
  54 WS_DLL_PUBLIC gdouble get_average(const nstime_t *sum, guint32 num);
  55
  56 #ifdef __cplusplus
  57 }
  58 #endif /* __cplusplus */
  59
  60 #endif /* __TIMESTATS_H__ */