2 This file is part of GNUnet.
3 Copyright (C) 2010-2015 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, 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"
32 * Handle for ATS address suggestion requests.
34 struct GNUNET_ATS_ConnectivitySuggestHandle
37 * ID of the peer for which address suggestion was requested.
39 struct GNUNET_PeerIdentity id;
42 * Connecitivity handle this suggestion handle belongs to.
44 struct GNUNET_ATS_ConnectivityHandle *ch;
49 * Handle to the ATS subsystem for connectivity management.
51 struct GNUNET_ATS_ConnectivityHandle
57 const struct GNUNET_CONFIGURATION_Handle *cfg;
60 * Map with the identities of all the peers for which we would
61 * like to have address suggestions. The key is the PID, the
62 * value is currently the `struct GNUNET_ATS_ConnectivitySuggestHandle`
64 struct GNUNET_CONTAINER_MultiPeerMap *sug_requests;
67 * Connection to ATS service.
69 struct GNUNET_CLIENT_Connection *client;
72 * Message queue for sending requests to the ATS service.
74 struct GNUNET_MQ_Handle *mq;
77 * Task to trigger reconnect.
79 struct GNUNET_SCHEDULER_Task *task;
82 * Reconnect backoff delay.
84 struct GNUNET_TIME_Relative backoff;
89 * Re-establish the connection to the ATS service.
91 * @param ch handle to use to re-connect.
94 reconnect (struct GNUNET_ATS_ConnectivityHandle *ch);
98 * Re-establish the connection to the ATS service.
100 * @param cls handle to use to re-connect.
101 * @param tc scheduler context
104 reconnect_task (void *cls,
105 const struct GNUNET_SCHEDULER_TaskContext *tc)
107 struct GNUNET_ATS_ConnectivityHandle *ch = cls;
115 * Disconnect from ATS and then reconnect.
117 * @param ch our handle
120 force_reconnect (struct GNUNET_ATS_ConnectivityHandle *ch)
124 GNUNET_MQ_destroy (ch->mq);
127 if (NULL != ch->client)
129 GNUNET_CLIENT_disconnect (ch->client);
132 ch->backoff = GNUNET_TIME_STD_BACKOFF (ch->backoff);
133 ch->task = GNUNET_SCHEDULER_add_delayed (ch->backoff,
140 * We encountered an error handling the MQ to the
141 * ATS service. Reconnect.
143 * @param cls the `struct GNUNET_ATS_ConnectivityHandle`
144 * @param error details about the error
147 error_handler (void *cls,
148 enum GNUNET_MQ_Error error)
150 struct GNUNET_ATS_ConnectivityHandle *ch = cls;
152 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
153 "ATS connection died (code %d), reconnecting\n",
155 force_reconnect (ch);
160 * Transmit request for an address suggestion.
162 * @param cls the `struct GNUNET_ATS_ConnectivityHandle`
163 * @param peer peer to ask for an address suggestion for
164 * @param value the `struct GNUNET_ATS_SuggestHandle`
165 * @return #GNUNET_OK (continue to iterate), #GNUNET_SYSERR on
166 * failure (message queue no longer exists)
169 transmit_suggestion (void *cls,
170 const struct GNUNET_PeerIdentity *peer,
173 struct GNUNET_ATS_ConnectivityHandle *ch = cls;
174 struct GNUNET_MQ_Envelope *ev;
175 struct RequestAddressMessage *m;
178 return GNUNET_SYSERR;
179 ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS);
180 m->reserved = htonl (0);
182 GNUNET_MQ_send (ch->mq, ev);
188 * Re-establish the connection to the ATS service.
190 * @param ch handle to use to re-connect.
193 reconnect (struct GNUNET_ATS_ConnectivityHandle *ch)
195 static const struct GNUNET_MQ_MessageHandler handlers[] =
197 struct GNUNET_MQ_Envelope *ev;
198 struct ClientStartMessage *init;
200 GNUNET_assert (NULL == ch->client);
201 ch->client = GNUNET_CLIENT_connect ("ats", ch->cfg);
202 if (NULL == ch->client)
204 force_reconnect (ch);
207 ch->mq = GNUNET_MQ_queue_for_connection_client (ch->client,
211 ev = GNUNET_MQ_msg (init,
212 GNUNET_MESSAGE_TYPE_ATS_START);
213 init->start_flag = htonl (START_FLAG_CONNECTION_SUGGESTION);
214 GNUNET_MQ_send (ch->mq, ev);
217 GNUNET_CONTAINER_multipeermap_iterate (ch->sug_requests,
218 &transmit_suggestion,
224 * Initialize the ATS connectivity suggestion client handle.
226 * @param cfg configuration to use
227 * @return ats connectivity handle, NULL on error
229 struct GNUNET_ATS_ConnectivityHandle *
230 GNUNET_ATS_connectivity_init (const struct GNUNET_CONFIGURATION_Handle *cfg)
232 struct GNUNET_ATS_ConnectivityHandle *ch;
234 ch = GNUNET_new (struct GNUNET_ATS_ConnectivityHandle);
236 ch->sug_requests = GNUNET_CONTAINER_multipeermap_create (32,
244 * Function called to free all `struct GNUNET_ATS_SuggestHandles`
249 * @param value the value to free
250 * @return #GNUNET_OK (continue to iterate)
253 free_sug_handle (void *cls,
254 const struct GNUNET_PeerIdentity *key,
257 struct GNUNET_ATS_ConnectivitySuggestHandle *cur = value;
265 * Client is done with ATS connectivity management, release resources.
267 * @param ch handle to release
270 GNUNET_ATS_connectivity_done (struct GNUNET_ATS_ConnectivityHandle *ch)
274 GNUNET_MQ_destroy (ch->mq);
277 if (NULL != ch->client)
279 GNUNET_CLIENT_disconnect (ch->client);
282 if (NULL != ch->task)
284 GNUNET_SCHEDULER_cancel (ch->task);
287 GNUNET_CONTAINER_multipeermap_iterate (ch->sug_requests,
290 GNUNET_CONTAINER_multipeermap_destroy (ch->sug_requests);
296 * We would like to receive address suggestions for a peer. ATS will
297 * respond with a call to the continuation immediately containing an address or
298 * no address if none is available. ATS can suggest more addresses until we call
299 * #GNUNET_ATS_connectivity_suggest_cancel().
302 * @param peer identity of the peer we need an address for
303 * @return suggest handle, NULL if a request is already pending
305 struct GNUNET_ATS_ConnectivitySuggestHandle *
306 GNUNET_ATS_connectivity_suggest (struct GNUNET_ATS_ConnectivityHandle *ch,
307 const struct GNUNET_PeerIdentity *peer)
309 struct GNUNET_ATS_ConnectivitySuggestHandle *s;
311 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
312 "Requesting ATS to suggest address for `%s'\n",
314 s = GNUNET_new (struct GNUNET_ATS_ConnectivitySuggestHandle);
318 GNUNET_CONTAINER_multipeermap_put (ch->sug_requests,
321 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
328 (void) transmit_suggestion (ch,
336 * We no longer care about being connected to a peer.
338 * @param sh handle to stop
341 GNUNET_ATS_connectivity_suggest_cancel (struct GNUNET_ATS_ConnectivitySuggestHandle *sh)
343 struct GNUNET_ATS_ConnectivityHandle *ch = sh->ch;
344 struct GNUNET_MQ_Envelope *ev;
345 struct RequestAddressMessage *m;
347 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
348 "Telling ATS we no longer care for an address for `%s'\n",
349 GNUNET_i2s (&sh->id));
350 GNUNET_assert (GNUNET_OK ==
351 GNUNET_CONTAINER_multipeermap_remove (ch->sug_requests,
359 ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL);
360 m->reserved = htonl (0);
362 GNUNET_MQ_send (ch->mq, ev);
367 /* end of ats_api_connectivity.c */