/**
 * collectd - src/utils_latency.h
 * Copyright (C) 2013       Florian Forster
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 * Authors:
 *   Florian Forster <ff at octo.it>
 **/

#ifndef UTILS_LATENCY_LATENCY_H
#define UTILS_LATENCY_LATENCY_H 1

#include "collectd.h"

#include "utils_time.h"

#ifndef HISTOGRAM_NUM_BINS
#define HISTOGRAM_NUM_BINS 1000
#endif

struct latency_counter_s;
typedef struct latency_counter_s latency_counter_t;

latency_counter_t *latency_counter_create(void);
void latency_counter_destroy(latency_counter_t *lc);

void latency_counter_add(latency_counter_t *lc, cdtime_t latency);
void latency_counter_reset(latency_counter_t *lc);

cdtime_t latency_counter_get_min(latency_counter_t *lc);
cdtime_t latency_counter_get_max(latency_counter_t *lc);
cdtime_t latency_counter_get_sum(latency_counter_t *lc);
size_t latency_counter_get_num(latency_counter_t *lc);
cdtime_t latency_counter_get_average(latency_counter_t *lc);
cdtime_t latency_counter_get_percentile(latency_counter_t *lc, double percent);

/*
 * NAME
 *  latency_counter_get_rate(counter,lower,upper,now)
 *
 * DESCRIPTION
 *   Calculates rate of latency values fall within requested interval.
 *   Interval specified as (lower,upper], i.e. the lower boundary is exclusive,
 *   the upper boundary is inclusive.
 *   When lower is zero, then the interval is (0, upper].
 *   When upper is zero, then the interval is (lower, infinity).
 */
double latency_counter_get_rate(const latency_counter_t *lc, cdtime_t lower,
                                cdtime_t upper, const cdtime_t now);

#endif /* UTILS_LATENCY_LATENCY_H */