blob: ac96b867d00b2c1cecdb4ce11d6fa9ac0447494e (
plain)
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
|
/*
This file is part of GNUnet
Copyright (C) 2011 GNUnet e.V.
GNUnet 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 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.
*/
#ifndef GNUNET_NSE_SERVICE_H_
#define GNUNET_NSE_SERVICE_H_
/**
* @author Nathan Evans
*
* @file
* API to retrieve the current network size estimate
*
* @defgroup nse NSE service
* Network Size Estimation
*
* Provides an API to retrieve the current network size estimate,
* also to register for notifications whenever a new
* network size estimate is calculated.
*
* @see [Documentation](https://gnunet.org/gnunet-nse-subsystem)
*
* @{
*/
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
#include "gnunet_util_lib.h"
/**
* Version of the network size estimation API.
*/
#define GNUNET_NSE_VERSION 0x00000000
/**
* Handle for the network size estimation service.
*/
struct GNUNET_NSE_Handle;
/**
* Callback to call when network size estimate is updated.
*
* @param cls closure
* @param timestamp time when the estimate was received from the server (or created by the server)
* @param logestimate the log(Base 2) value of the current network size estimate
* @param std_dev standard deviation for the estimate
*
*/
typedef void (*GNUNET_NSE_Callback) (void *cls,
struct GNUNET_TIME_Absolute timestamp,
double logestimate, double std_dev);
/**
* Convert the logarithmic estimated returned to the 'GNUNET_NSE_Callback'
* into an absolute estimate in terms of the number of peers in the network.
*
* @param loge logarithmic estimate
* @return absolute number of peers in the network (estimated)
*/
#define GNUNET_NSE_log_estimate_to_n(loge) pow(2.0, (loge))
/**
* Connect to the network size estimation service.
*
* @param cfg the configuration to use
* @param func funtion to call with network size estimate
* @param func_cls closure to pass to @a func
* @return handle to use in #GNUNET_NSE_disconnect to stop NSE from invoking the callbacks
*/
struct GNUNET_NSE_Handle *
GNUNET_NSE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
GNUNET_NSE_Callback func, void *func_cls);
/**
* Disconnect from network size estimation service
*
* @param h handle to destroy
*/
void
GNUNET_NSE_disconnect (struct GNUNET_NSE_Handle *h);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
/** @} */ /* end of group nse */
#endif /* GNUNET_NSE_SERVICE_H_ */
|
