2 This file is part of GNUnet.
3 Copyright (C) 2009, 2010, 2011, 2016 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
23 * @brief api to get information from the network size estimation service
24 * @author Nathan Evans
27 #include "gnunet_constants.h"
28 #include "gnunet_arm_service.h"
29 #include "gnunet_hello_lib.h"
30 #include "gnunet_protocols.h"
31 #include "gnunet_util_lib.h"
32 #include "gnunet_nse_service.h"
35 #define LOG(kind,...) GNUNET_log_from (kind, "nse-api",__VA_ARGS__)
38 * Handle for talking with the NSE service.
40 struct GNUNET_NSE_Handle
43 * Configuration to use.
45 const struct GNUNET_CONFIGURATION_Handle *cfg;
48 * Message queue (if available).
50 struct GNUNET_MQ_Handle *mq;
53 * Task doing exponential back-off trying to reconnect.
55 struct GNUNET_SCHEDULER_Task *reconnect_task;
58 * Time for next connect retry.
60 struct GNUNET_TIME_Relative reconnect_delay;
63 * Callback function to call when message is received.
65 GNUNET_NSE_Callback recv_cb;
68 * Closure to pass to @e recv_cb callback.
76 * Try again to connect to network size estimation service.
78 * @param cls closure with the `struct GNUNET_NSE_Handle *`
81 reconnect (void *cls);
85 * Generic error handler, called with the appropriate
86 * error code and the same closure specified at the creation of
88 * Not every message queue implementation supports an error handler.
90 * @param cls closure with the `struct GNUNET_NSE_Handle *`
91 * @param error error code
94 mq_error_handler (void *cls,
95 enum GNUNET_MQ_Error error)
97 struct GNUNET_NSE_Handle *h = cls;
99 GNUNET_MQ_destroy (h->mq);
102 = GNUNET_SCHEDULER_add_delayed (h->reconnect_delay,
105 h->reconnect_delay = GNUNET_TIME_STD_BACKOFF (h->reconnect_delay);
110 * Type of a function to call when we receive a message
114 * @param client_msg message received
117 handle_estimate (void *cls,
118 const struct GNUNET_NSE_ClientMessage *client_msg)
120 struct GNUNET_NSE_Handle *h = cls;
122 h->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
123 h->recv_cb (h->recv_cb_cls,
124 GNUNET_TIME_absolute_ntoh (client_msg->timestamp),
125 GNUNET_ntoh_double (client_msg->size_estimate),
126 GNUNET_ntoh_double (client_msg->std_deviation));
131 * Try again to connect to network size estimation service.
133 * @param cls the `struct GNUNET_NSE_Handle *`
136 reconnect (void *cls)
138 struct GNUNET_NSE_Handle *h = cls;
139 struct GNUNET_MQ_MessageHandler handlers[] = {
140 GNUNET_MQ_hd_fixed_size (estimate,
141 GNUNET_MESSAGE_TYPE_NSE_ESTIMATE,
142 struct GNUNET_NSE_ClientMessage,
144 GNUNET_MQ_handler_end ()
146 struct GNUNET_MessageHeader *msg;
147 struct GNUNET_MQ_Envelope *env;
149 h->reconnect_task = NULL;
150 LOG (GNUNET_ERROR_TYPE_DEBUG,
151 "Connecting to network size estimation service.\n");
152 GNUNET_assert (NULL == h->mq);
153 h->mq = GNUNET_CLIENT_connect (h->cfg,
160 env = GNUNET_MQ_msg (msg,
161 GNUNET_MESSAGE_TYPE_NSE_START);
162 GNUNET_MQ_send (h->mq,
168 * Connect to the network size estimation service.
170 * @param cfg the configuration to use
171 * @param func funtion to call with network size estimate
172 * @param func_cls closure to pass to @a func
173 * @return handle to use
175 struct GNUNET_NSE_Handle *
176 GNUNET_NSE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
177 GNUNET_NSE_Callback func,
180 struct GNUNET_NSE_Handle *h;
182 GNUNET_assert (NULL != func);
183 h = GNUNET_new (struct GNUNET_NSE_Handle);
186 h->recv_cb_cls = func_cls;
187 h->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
199 * Disconnect from network size estimation service
201 * @param h handle to destroy
204 GNUNET_NSE_disconnect (struct GNUNET_NSE_Handle *h)
206 if (NULL != h->reconnect_task)
208 GNUNET_SCHEDULER_cancel (h->reconnect_task);
209 h->reconnect_task = NULL;
213 GNUNET_MQ_destroy (h->mq);
219 /* end of nse_api.c */