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/>.
19 * @file ats/ats_api_connectivity.c
20 * @brief enable clients to ask ATS about establishing connections to peers
21 * @author Christian Grothoff
22 * @author Matthias Wachs
25 #include "gnunet_ats_service.h"
29 #define LOG(kind,...) GNUNET_log_from(kind, "ats-connectivity-api", __VA_ARGS__)
33 * Handle for ATS address suggestion requests.
35 struct GNUNET_ATS_ConnectivitySuggestHandle
38 * ID of the peer for which address suggestion was requested.
40 struct GNUNET_PeerIdentity id;
43 * Connecitivity handle this suggestion handle belongs to.
45 struct GNUNET_ATS_ConnectivityHandle *ch;
48 * How urgent is the request.
55 * Handle to the ATS subsystem for connectivity management.
57 struct GNUNET_ATS_ConnectivityHandle
63 const struct GNUNET_CONFIGURATION_Handle *cfg;
66 * Map with the identities of all the peers for which we would
67 * like to have address suggestions. The key is the PID, the
68 * value is currently the `struct GNUNET_ATS_ConnectivitySuggestHandle`
70 struct GNUNET_CONTAINER_MultiPeerMap *sug_requests;
73 * Message queue for sending requests to the ATS service.
75 struct GNUNET_MQ_Handle *mq;
78 * Task to trigger reconnect.
80 struct GNUNET_SCHEDULER_Task *task;
83 * Reconnect backoff delay.
85 struct GNUNET_TIME_Relative backoff;
90 * Re-establish the connection to the ATS service.
92 * @param ch handle to use to re-connect.
95 reconnect (struct GNUNET_ATS_ConnectivityHandle *ch);
99 * Re-establish the connection to the ATS service.
101 * @param cls handle to use to re-connect.
104 reconnect_task (void *cls)
106 struct GNUNET_ATS_ConnectivityHandle *ch = cls;
114 * Disconnect from ATS and then reconnect.
116 * @param ch our handle
119 force_reconnect (struct GNUNET_ATS_ConnectivityHandle *ch)
123 GNUNET_MQ_destroy (ch->mq);
126 ch->backoff = GNUNET_TIME_STD_BACKOFF (ch->backoff);
127 ch->task = GNUNET_SCHEDULER_add_delayed (ch->backoff,
134 * We encountered an error handling the MQ to the
135 * ATS service. Reconnect.
137 * @param cls the `struct GNUNET_ATS_ConnectivityHandle`
138 * @param error details about the error
141 error_handler (void *cls,
142 enum GNUNET_MQ_Error error)
144 struct GNUNET_ATS_ConnectivityHandle *ch = cls;
146 LOG (GNUNET_ERROR_TYPE_DEBUG,
147 "ATS connection died (code %d), reconnecting\n",
149 force_reconnect (ch);
154 * Transmit request for an address suggestion.
156 * @param cls the `struct GNUNET_ATS_ConnectivityHandle`
157 * @param peer peer to ask for an address suggestion for
158 * @param value the `struct GNUNET_ATS_SuggestHandle`
159 * @return #GNUNET_OK (continue to iterate), #GNUNET_SYSERR on
160 * failure (message queue no longer exists)
163 transmit_suggestion (void *cls,
164 const struct GNUNET_PeerIdentity *peer,
167 struct GNUNET_ATS_ConnectivityHandle *ch = cls;
168 struct GNUNET_ATS_ConnectivitySuggestHandle *sh = value;
169 struct GNUNET_MQ_Envelope *ev;
170 struct RequestAddressMessage *m;
173 return GNUNET_SYSERR;
174 ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS);
175 m->strength = htonl (sh->strength);
177 GNUNET_MQ_send (ch->mq, ev);
183 * Re-establish the connection to the ATS service.
185 * @param ch handle to use to re-connect.
188 reconnect (struct GNUNET_ATS_ConnectivityHandle *ch)
190 static const struct GNUNET_MQ_MessageHandler handlers[] =
192 struct GNUNET_MQ_Envelope *ev;
193 struct ClientStartMessage *init;
195 GNUNET_assert (NULL == ch->mq);
196 ch->mq = GNUNET_CLIENT_connect (ch->cfg,
203 force_reconnect (ch);
206 ev = GNUNET_MQ_msg (init,
207 GNUNET_MESSAGE_TYPE_ATS_START);
208 init->start_flag = htonl (START_FLAG_CONNECTION_SUGGESTION);
209 GNUNET_MQ_send (ch->mq, ev);
212 GNUNET_CONTAINER_multipeermap_iterate (ch->sug_requests,
213 &transmit_suggestion,
219 * Initialize the ATS connectivity suggestion client handle.
221 * @param cfg configuration to use
222 * @return ats connectivity handle, NULL on error
224 struct GNUNET_ATS_ConnectivityHandle *
225 GNUNET_ATS_connectivity_init (const struct GNUNET_CONFIGURATION_Handle *cfg)
227 struct GNUNET_ATS_ConnectivityHandle *ch;
229 ch = GNUNET_new (struct GNUNET_ATS_ConnectivityHandle);
231 ch->sug_requests = GNUNET_CONTAINER_multipeermap_create (32,
239 * Function called to free all `struct GNUNET_ATS_ConnectivitySuggestHandle`s
244 * @param value the value to free
245 * @return #GNUNET_OK (continue to iterate)
248 free_sug_handle (void *cls,
249 const struct GNUNET_PeerIdentity *key,
252 struct GNUNET_ATS_ConnectivitySuggestHandle *cur = value;
260 * Client is done with ATS connectivity management, release resources.
262 * @param ch handle to release
265 GNUNET_ATS_connectivity_done (struct GNUNET_ATS_ConnectivityHandle *ch)
269 GNUNET_MQ_destroy (ch->mq);
272 if (NULL != ch->task)
274 GNUNET_SCHEDULER_cancel (ch->task);
277 GNUNET_CONTAINER_multipeermap_iterate (ch->sug_requests,
280 GNUNET_CONTAINER_multipeermap_destroy (ch->sug_requests);
286 * We would like to receive address suggestions for a peer. ATS will
287 * respond with a call to the continuation immediately containing an address or
288 * no address if none is available. ATS can suggest more addresses until we call
289 * #GNUNET_ATS_connectivity_suggest_cancel().
292 * @param peer identity of the peer we need an address for
293 * @param strength how urgent is the need for such a suggestion
294 * @return suggest handle, NULL if a request is already pending
296 struct GNUNET_ATS_ConnectivitySuggestHandle *
297 GNUNET_ATS_connectivity_suggest (struct GNUNET_ATS_ConnectivityHandle *ch,
298 const struct GNUNET_PeerIdentity *peer,
301 struct GNUNET_ATS_ConnectivitySuggestHandle *s;
303 s = GNUNET_new (struct GNUNET_ATS_ConnectivitySuggestHandle);
306 s->strength = strength;
308 GNUNET_CONTAINER_multipeermap_put (ch->sug_requests,
311 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
313 LOG (GNUNET_ERROR_TYPE_DEBUG,
314 "Not requesting ATS to suggest address for `%s', request already pending\n",
319 LOG (GNUNET_ERROR_TYPE_DEBUG,
320 "Requesting ATS to suggest address for `%s'\n",
324 (void) transmit_suggestion (ch,
332 * We no longer care about being connected to a peer.
334 * @param sh handle to stop
337 GNUNET_ATS_connectivity_suggest_cancel (struct GNUNET_ATS_ConnectivitySuggestHandle *sh)
339 struct GNUNET_ATS_ConnectivityHandle *ch = sh->ch;
340 struct GNUNET_MQ_Envelope *ev;
341 struct RequestAddressMessage *m;
343 LOG (GNUNET_ERROR_TYPE_DEBUG,
344 "Telling ATS we no longer care for an address for `%s'\n",
345 GNUNET_i2s (&sh->id));
346 GNUNET_assert (GNUNET_OK ==
347 GNUNET_CONTAINER_multipeermap_remove (ch->sug_requests,
355 ev = GNUNET_MQ_msg (m,
356 GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL);
357 m->strength = htonl (0);
359 GNUNET_MQ_send (ch->mq, ev);
364 /* end of ats_api_connectivity.c */