2 This file is part of GNUnet.
3 Copyright (C) 2010-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
21 * @file ats/ats_api2_application.c
22 * @brief enable clients to ask ATS about establishing connections to peers
23 * @author Christian Grothoff
24 * @author Matthias Wachs
27 #include "gnunet_ats_application_service.h"
31 #define LOG(kind,...) GNUNET_log_from(kind, "ats-application-api", __VA_ARGS__)
35 * Handle for ATS address suggestion requests.
37 struct GNUNET_ATS_ApplicationSuggestHandle
40 * ID of the peer for which address suggestion was requested.
42 struct GNUNET_PeerIdentity id;
45 * Connecitivity handle this suggestion handle belongs to.
47 struct GNUNET_ATS_ApplicationHandle *ch;
50 * What preference is being expressed?
52 enum GNUNET_MQ_PreferenceKind pk;
55 * How much bandwidth does the client expect?
57 struct GNUNET_BANDWIDTH_Value32NBO bw;
62 * Handle to the ATS subsystem for application management.
64 struct GNUNET_ATS_ApplicationHandle
70 const struct GNUNET_CONFIGURATION_Handle *cfg;
73 * Map with the identities of all the peers for which we would
74 * like to have address suggestions. The key is the PID, the
75 * value is currently the `struct GNUNET_ATS_ApplicationSuggestHandle`
77 struct GNUNET_CONTAINER_MultiPeerMap *sug_requests;
80 * Message queue for sending requests to the ATS service.
82 struct GNUNET_MQ_Handle *mq;
85 * Task to trigger reconnect.
87 struct GNUNET_SCHEDULER_Task *task;
90 * Reconnect backoff delay.
92 struct GNUNET_TIME_Relative backoff;
97 * Re-establish the connection to the ATS service.
99 * @param ch handle to use to re-connect.
102 reconnect (struct GNUNET_ATS_ApplicationHandle *ch);
106 * Re-establish the connection to the ATS service.
108 * @param cls handle to use to re-connect.
111 reconnect_task (void *cls)
113 struct GNUNET_ATS_ApplicationHandle *ch = cls;
121 * Disconnect from ATS and then reconnect.
123 * @param ch our handle
126 force_reconnect (struct GNUNET_ATS_ApplicationHandle *ch)
130 GNUNET_MQ_destroy (ch->mq);
133 ch->backoff = GNUNET_TIME_STD_BACKOFF (ch->backoff);
134 ch->task = GNUNET_SCHEDULER_add_delayed (ch->backoff,
141 * We encountered an error handling the MQ to the
142 * ATS service. Reconnect.
144 * @param cls the `struct GNUNET_ATS_ApplicationHandle`
145 * @param error details about the error
148 error_handler (void *cls,
149 enum GNUNET_MQ_Error error)
151 struct GNUNET_ATS_ApplicationHandle *ch = cls;
153 LOG (GNUNET_ERROR_TYPE_DEBUG,
154 "ATS connection died (code %d), reconnecting\n",
156 force_reconnect (ch);
161 * Transmit request for an address suggestion.
163 * @param cls the `struct GNUNET_ATS_ApplicationHandle`
164 * @param peer peer to ask for an address suggestion for
165 * @param value the `struct GNUNET_ATS_SuggestHandle`
166 * @return #GNUNET_OK (continue to iterate), #GNUNET_SYSERR on
167 * failure (message queue no longer exists)
170 transmit_suggestion (void *cls,
171 const struct GNUNET_PeerIdentity *peer,
174 struct GNUNET_ATS_ApplicationHandle *ch = cls;
175 struct GNUNET_ATS_ApplicationSuggestHandle *sh = value;
176 struct GNUNET_MQ_Envelope *ev;
177 struct ExpressPreferenceMessage *m;
180 return GNUNET_SYSERR;
181 ev = GNUNET_MQ_msg (m,
182 GNUNET_MESSAGE_TYPE_ATS_SUGGEST);
183 m->pk = htonl ((uint32_t) sh->pk);
186 GNUNET_MQ_send (ch->mq, ev);
192 * Re-establish the connection to the ATS service.
194 * @param ch handle to use to re-connect.
197 reconnect (struct GNUNET_ATS_ApplicationHandle *ch)
199 static const struct GNUNET_MQ_MessageHandler handlers[] = {
203 GNUNET_assert (NULL == ch->mq);
204 ch->mq = GNUNET_CLIENT_connect (ch->cfg,
211 force_reconnect (ch);
214 GNUNET_CONTAINER_multipeermap_iterate (ch->sug_requests,
215 &transmit_suggestion,
221 * Initialize the ATS application suggestion client handle.
223 * @param cfg configuration to use
224 * @return ats application handle, NULL on error
226 struct GNUNET_ATS_ApplicationHandle *
227 GNUNET_ATS_application_init (const struct GNUNET_CONFIGURATION_Handle *cfg)
229 struct GNUNET_ATS_ApplicationHandle *ch;
231 ch = GNUNET_new (struct GNUNET_ATS_ApplicationHandle);
233 ch->sug_requests = GNUNET_CONTAINER_multipeermap_create (32,
241 * Function called to free all `struct GNUNET_ATS_ApplicationSuggestHandle`s
246 * @param value the value to free
247 * @return #GNUNET_OK (continue to iterate)
250 free_sug_handle (void *cls,
251 const struct GNUNET_PeerIdentity *key,
254 struct GNUNET_ATS_ApplicationSuggestHandle *cur = value;
262 * Client is done with ATS application management, release resources.
264 * @param ch handle to release
267 GNUNET_ATS_application_done (struct GNUNET_ATS_ApplicationHandle *ch)
271 GNUNET_MQ_destroy (ch->mq);
274 if (NULL != ch->task)
276 GNUNET_SCHEDULER_cancel (ch->task);
279 GNUNET_CONTAINER_multipeermap_iterate (ch->sug_requests,
282 GNUNET_CONTAINER_multipeermap_destroy (ch->sug_requests);
288 * We would like to receive address suggestions for a peer. ATS will
289 * respond with a call to the continuation immediately containing an address or
290 * no address if none is available. ATS can suggest more addresses until we call
291 * #GNUNET_ATS_application_suggest_cancel().
294 * @param peer identity of the peer we need an address for
295 * @param pk what kind of application will the application require (can be
296 * #GNUNET_MQ_PREFERENCE_NONE, we will still try to connect)
297 * @param bw desired bandwith, can be zero (we will still try to connect)
298 * @return suggest handle, NULL if a request is already pending
300 struct GNUNET_ATS_ApplicationSuggestHandle *
301 GNUNET_ATS_application_suggest (struct GNUNET_ATS_ApplicationHandle *ch,
302 const struct GNUNET_PeerIdentity *peer,
303 enum GNUNET_MQ_PreferenceKind pk,
304 struct GNUNET_BANDWIDTH_Value32NBO bw)
306 struct GNUNET_ATS_ApplicationSuggestHandle *s;
308 s = GNUNET_new (struct GNUNET_ATS_ApplicationSuggestHandle);
313 (void) GNUNET_CONTAINER_multipeermap_put (ch->sug_requests,
316 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
317 LOG (GNUNET_ERROR_TYPE_DEBUG,
318 "Requesting ATS to suggest address for `%s'\n",
322 GNUNET_assert (GNUNET_OK ==
323 transmit_suggestion (ch,
331 * We no longer care about being connected to a peer.
333 * @param sh handle to stop
336 GNUNET_ATS_application_suggest_cancel (struct GNUNET_ATS_ApplicationSuggestHandle *sh)
338 struct GNUNET_ATS_ApplicationHandle *ch = sh->ch;
339 struct GNUNET_MQ_Envelope *ev;
340 struct ExpressPreferenceMessage *m;
342 LOG (GNUNET_ERROR_TYPE_DEBUG,
343 "Telling ATS we no longer care for an address for `%s'\n",
344 GNUNET_i2s (&sh->id));
345 GNUNET_assert (GNUNET_OK ==
346 GNUNET_CONTAINER_multipeermap_remove (ch->sug_requests,
354 ev = GNUNET_MQ_msg (m,
355 GNUNET_MESSAGE_TYPE_ATS_SUGGEST_CANCEL);
356 m->pk = htonl ((uint32_t) sh->pk);
359 GNUNET_MQ_send (ch->mq,
365 /* end of ats_api2_application.c */