epan/timestats.h

   1 /** @file
   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  * SPDX-License-Identifier: GPL-2.0-or-later
  10  */
  11
  12 #ifndef __TIMESTATS_H__
  13 #define __TIMESTATS_H__
  14
  15 #include "epan/packet_info.h"
  16 #include "wsutil/nstime.h"
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif /* __cplusplus */
  21
  22  /* Summary of time statistics*/
  23 typedef struct _timestat_t {
  24         uint32_t num;    /* number of samples */
  25         uint32_t        min_num; /* frame number of minimum */
  26         uint32_t        max_num; /* frame number of maximum */
  27         nstime_t min;
  28         nstime_t max;
  29         nstime_t tot;
  30         double variance;
  31 } timestat_t;
  32
  33 /* functions */
  34
  35 /* Initialize a timestat_t struct */
  36 WS_DLL_PUBLIC void time_stat_init(timestat_t *stats);
  37
  38 /* Update a timestat_t struct with a new sample */
  39 WS_DLL_PUBLIC void time_stat_update(timestat_t *stats, const nstime_t *delta, packet_info *pinfo);
  40
  41 WS_DLL_PUBLIC double get_average(const nstime_t *sum, uint32_t num);
  42
  43 #ifdef __cplusplus
  44 }
  45 #endif /* __cplusplus */
  46
  47 #endif /* __TIMESTATS_H__ */