2 This file is part of GNUnet.
3 Copyright (C) 2010-2015 GNUnet e.V.
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
21 * @file ats/ats_api_connectivity.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_service.h"
31 #define LOG(kind,...) GNUNET_log_from(kind, "ats-connectivity-api", __VA_ARGS__)
35 * Handle for ATS address suggestion requests.
37 struct GNUNET_ATS_ConnectivitySuggestHandle
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_ConnectivityHandle *ch;
50 * How urgent is the request.
57 * Handle to the ATS subsystem for connectivity management.
59 struct GNUNET_ATS_ConnectivityHandle
65 const struct GNUNET_CONFIGURATION_Handle *cfg;
68 * Map with the identities of all the peers for which we would
69 * like to have address suggestions. The key is the PID, the
70 * value is currently the `struct GNUNET_ATS_ConnectivitySuggestHandle`
72 struct GNUNET_CONTAINER_MultiPeerMap *sug_requests;
75 * Connection to ATS service.
77 struct GNUNET_CLIENT_Connection *client;
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_ConnectivityHandle *ch);
106 * Re-establish the connection to the ATS service.
108 * @param cls handle to use to re-connect.
109 * @param tc scheduler context
112 reconnect_task (void *cls,
113 const struct GNUNET_SCHEDULER_TaskContext *tc)
115 struct GNUNET_ATS_ConnectivityHandle *ch = cls;
123 * Disconnect from ATS and then reconnect.
125 * @param ch our handle
128 force_reconnect (struct GNUNET_ATS_ConnectivityHandle *ch)
132 GNUNET_MQ_destroy (ch->mq);
135 if (NULL != ch->client)
137 GNUNET_CLIENT_disconnect (ch->client);
140 ch->backoff = GNUNET_TIME_STD_BACKOFF (ch->backoff);
141 ch->task = GNUNET_SCHEDULER_add_delayed (ch->backoff,
148 * We encountered an error handling the MQ to the
149 * ATS service. Reconnect.
151 * @param cls the `struct GNUNET_ATS_ConnectivityHandle`
152 * @param error details about the error
155 error_handler (void *cls,
156 enum GNUNET_MQ_Error error)
158 struct GNUNET_ATS_ConnectivityHandle *ch = cls;
160 LOG (GNUNET_ERROR_TYPE_DEBUG,
161 "ATS connection died (code %d), reconnecting\n",
163 force_reconnect (ch);
168 * Transmit request for an address suggestion.
170 * @param cls the `struct GNUNET_ATS_ConnectivityHandle`
171 * @param peer peer to ask for an address suggestion for
172 * @param value the `struct GNUNET_ATS_SuggestHandle`
173 * @return #GNUNET_OK (continue to iterate), #GNUNET_SYSERR on
174 * failure (message queue no longer exists)
177 transmit_suggestion (void *cls,
178 const struct GNUNET_PeerIdentity *peer,
181 struct GNUNET_ATS_ConnectivityHandle *ch = cls;
182 struct GNUNET_ATS_ConnectivitySuggestHandle *sh = value;
183 struct GNUNET_MQ_Envelope *ev;
184 struct RequestAddressMessage *m;
187 return GNUNET_SYSERR;
188 ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS);
189 m->strength = htonl (sh->strength);
191 GNUNET_MQ_send (ch->mq, ev);
197 * Re-establish the connection to the ATS service.
199 * @param ch handle to use to re-connect.
202 reconnect (struct GNUNET_ATS_ConnectivityHandle *ch)
204 static const struct GNUNET_MQ_MessageHandler handlers[] =
206 struct GNUNET_MQ_Envelope *ev;
207 struct ClientStartMessage *init;
209 GNUNET_assert (NULL == ch->client);
210 ch->client = GNUNET_CLIENT_connect ("ats", ch->cfg);
211 if (NULL == ch->client)
213 force_reconnect (ch);
216 ch->mq = GNUNET_MQ_queue_for_connection_client (ch->client,
220 ev = GNUNET_MQ_msg (init,
221 GNUNET_MESSAGE_TYPE_ATS_START);
222 init->start_flag = htonl (START_FLAG_CONNECTION_SUGGESTION);
223 GNUNET_MQ_send (ch->mq, ev);
226 GNUNET_CONTAINER_multipeermap_iterate (ch->sug_requests,
227 &transmit_suggestion,
233 * Initialize the ATS connectivity suggestion client handle.
235 * @param cfg configuration to use
236 * @return ats connectivity handle, NULL on error
238 struct GNUNET_ATS_ConnectivityHandle *
239 GNUNET_ATS_connectivity_init (const struct GNUNET_CONFIGURATION_Handle *cfg)
241 struct GNUNET_ATS_ConnectivityHandle *ch;
243 ch = GNUNET_new (struct GNUNET_ATS_ConnectivityHandle);
245 ch->sug_requests = GNUNET_CONTAINER_multipeermap_create (32,
253 * Function called to free all `struct GNUNET_ATS_ConnectivitySuggestHandle`s
258 * @param value the value to free
259 * @return #GNUNET_OK (continue to iterate)
262 free_sug_handle (void *cls,
263 const struct GNUNET_PeerIdentity *key,
266 struct GNUNET_ATS_ConnectivitySuggestHandle *cur = value;
274 * Client is done with ATS connectivity management, release resources.
276 * @param ch handle to release
279 GNUNET_ATS_connectivity_done (struct GNUNET_ATS_ConnectivityHandle *ch)
283 GNUNET_MQ_destroy (ch->mq);
286 if (NULL != ch->client)
288 GNUNET_CLIENT_disconnect (ch->client);
291 if (NULL != ch->task)
293 GNUNET_SCHEDULER_cancel (ch->task);
296 GNUNET_CONTAINER_multipeermap_iterate (ch->sug_requests,
299 GNUNET_CONTAINER_multipeermap_destroy (ch->sug_requests);
305 * We would like to receive address suggestions for a peer. ATS will
306 * respond with a call to the continuation immediately containing an address or
307 * no address if none is available. ATS can suggest more addresses until we call
308 * #GNUNET_ATS_connectivity_suggest_cancel().
311 * @param peer identity of the peer we need an address for
312 * @param strength how urgent is the need for such a suggestion
313 * @return suggest handle, NULL if a request is already pending
315 struct GNUNET_ATS_ConnectivitySuggestHandle *
316 GNUNET_ATS_connectivity_suggest (struct GNUNET_ATS_ConnectivityHandle *ch,
317 const struct GNUNET_PeerIdentity *peer,
320 struct GNUNET_ATS_ConnectivitySuggestHandle *s;
322 LOG (GNUNET_ERROR_TYPE_DEBUG,
323 "Requesting ATS to suggest address for `%s'\n",
325 s = GNUNET_new (struct GNUNET_ATS_ConnectivitySuggestHandle);
328 s->strength = strength;
330 GNUNET_CONTAINER_multipeermap_put (ch->sug_requests,
333 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
340 (void) transmit_suggestion (ch,
348 * We no longer care about being connected to a peer.
350 * @param sh handle to stop
353 GNUNET_ATS_connectivity_suggest_cancel (struct GNUNET_ATS_ConnectivitySuggestHandle *sh)
355 struct GNUNET_ATS_ConnectivityHandle *ch = sh->ch;
356 struct GNUNET_MQ_Envelope *ev;
357 struct RequestAddressMessage *m;
359 LOG (GNUNET_ERROR_TYPE_DEBUG,
360 "Telling ATS we no longer care for an address for `%s'\n",
361 GNUNET_i2s (&sh->id));
362 GNUNET_assert (GNUNET_OK ==
363 GNUNET_CONTAINER_multipeermap_remove (ch->sug_requests,
371 ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL);
372 m->strength = htonl (0);
374 GNUNET_MQ_send (ch->mq, ev);
379 /* end of ats_api_connectivity.c */