blob: 56cacfbbb853ed3dd2e64b9396341a4f5b4a01b2 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
/*
This file is part of GNUnet.
Copyright (C) 2010 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
* @addtogroup libgnunetutil
* @{
*
* @author Christian Grothoff
*
* @file
* Functions related to load calculations
*
* @defgroup load Load library
* Load calculations.
* @{
*/
#ifndef GNUNET_LOAD_LIB_H
#define GNUNET_LOAD_LIB_H
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
#include "gnunet_common.h"
#include "gnunet_time_lib.h"
/**
* Opaque load handle.
*/
struct GNUNET_LOAD_Value;
/**
* Create a new load value.
*
* @param autodecline speed at which this value should automatically
* decline in the absence of external events; at the given
* frequency, 0-load values will be added to the load
* @return the new load value
*/
struct GNUNET_LOAD_Value *
GNUNET_LOAD_value_init (struct GNUNET_TIME_Relative autodecline);
/**
* Change the value by which the load automatically declines.
*
* @param load load to update
* @param autodecline frequency of load decline
*/
void
GNUNET_LOAD_value_set_decline (struct GNUNET_LOAD_Value *load,
struct GNUNET_TIME_Relative autodecline);
/**
* Free a load value.
*
* @param lv value to free
*/
#define GNUNET_LOAD_value_free(lv) GNUNET_free (lv)
/**
* Get the current load.
*
* @param load load handle
* @return zero for below-average load, otherwise
* number of std. devs we are above average;
* 100 if the latest updates were so large
* that we could not do proper calculations
*/
double
GNUNET_LOAD_get_load (struct GNUNET_LOAD_Value *load);
/**
* Get the average value given to update so far.
*
* @param load load handle
* @return zero if update was never called
*/
double
GNUNET_LOAD_get_average (struct GNUNET_LOAD_Value *load);
/**
* Update the current load.
*
* @param load to update
* @param data latest measurement value (for example, delay)
*/
void
GNUNET_LOAD_update (struct GNUNET_LOAD_Value *load, uint64_t data);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
/* ifndef GNUNET_LOAD_LIB_H */
#endif
/** @} */ /* end of group */
/** @} */ /* end of group addition to libgnunetutil */
/* end of gnunet_load_lib.h */
|
