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"
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;
52 * Handle to the ATS subsystem for connectivity management.
54 struct GNUNET_ATS_ConnectivityHandle
60 const struct GNUNET_CONFIGURATION_Handle *cfg;
63 * Map with the identities of all the peers for which we would
64 * like to have address suggestions. The key is the PID, the
65 * value is currently the `struct GNUNET_ATS_ConnectivitySuggestHandle`
67 struct GNUNET_CONTAINER_MultiPeerMap *sug_requests;
70 * Connection to ATS service.
72 struct GNUNET_CLIENT_Connection *client;
75 * Message queue for sending requests to the ATS service.
77 struct GNUNET_MQ_Handle *mq;
80 * Task to trigger reconnect.
82 struct GNUNET_SCHEDULER_Task *task;
85 * Reconnect backoff delay.
87 struct GNUNET_TIME_Relative backoff;
92 * Re-establish the connection to the ATS service.
94 * @param ch handle to use to re-connect.
97 reconnect (struct GNUNET_ATS_ConnectivityHandle *ch);
101 * Re-establish the connection to the ATS service.
103 * @param cls handle to use to re-connect.
104 * @param tc scheduler context
107 reconnect_task (void *cls,
108 const struct GNUNET_SCHEDULER_TaskContext *tc)
110 struct GNUNET_ATS_ConnectivityHandle *ch = cls;
118 * Disconnect from ATS and then reconnect.
120 * @param ch our handle
123 force_reconnect (struct GNUNET_ATS_ConnectivityHandle *ch)
127 GNUNET_MQ_destroy (ch->mq);
130 if (NULL != ch->client)
132 GNUNET_CLIENT_disconnect (ch->client);
135 ch->backoff = GNUNET_TIME_STD_BACKOFF (ch->backoff);
136 ch->task = GNUNET_SCHEDULER_add_delayed (ch->backoff,
143 * We encountered an error handling the MQ to the
144 * ATS service. Reconnect.
146 * @param cls the `struct GNUNET_ATS_ConnectivityHandle`
147 * @param error details about the error
150 error_handler (void *cls,
151 enum GNUNET_MQ_Error error)
153 struct GNUNET_ATS_ConnectivityHandle *ch = cls;
155 LOG (GNUNET_ERROR_TYPE_WARNING,
156 "ATS connection died (code %d), reconnecting\n",
158 force_reconnect (ch);
163 * Transmit request for an address suggestion.
165 * @param cls the `struct GNUNET_ATS_ConnectivityHandle`
166 * @param peer peer to ask for an address suggestion for
167 * @param value the `struct GNUNET_ATS_SuggestHandle`
168 * @return #GNUNET_OK (continue to iterate), #GNUNET_SYSERR on
169 * failure (message queue no longer exists)
172 transmit_suggestion (void *cls,
173 const struct GNUNET_PeerIdentity *peer,
176 struct GNUNET_ATS_ConnectivityHandle *ch = cls;
177 struct GNUNET_MQ_Envelope *ev;
178 struct RequestAddressMessage *m;
181 return GNUNET_SYSERR;
182 ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS);
183 m->reserved = htonl (0);
185 GNUNET_MQ_send (ch->mq, ev);
191 * Re-establish the connection to the ATS service.
193 * @param ch handle to use to re-connect.
196 reconnect (struct GNUNET_ATS_ConnectivityHandle *ch)
198 static const struct GNUNET_MQ_MessageHandler handlers[] =
200 struct GNUNET_MQ_Envelope *ev;
201 struct ClientStartMessage *init;
203 GNUNET_assert (NULL == ch->client);
204 ch->client = GNUNET_CLIENT_connect ("ats", ch->cfg);
205 if (NULL == ch->client)
207 force_reconnect (ch);
210 ch->mq = GNUNET_MQ_queue_for_connection_client (ch->client,
214 ev = GNUNET_MQ_msg (init,
215 GNUNET_MESSAGE_TYPE_ATS_START);
216 init->start_flag = htonl (START_FLAG_CONNECTION_SUGGESTION);
217 GNUNET_MQ_send (ch->mq, ev);
220 GNUNET_CONTAINER_multipeermap_iterate (ch->sug_requests,
221 &transmit_suggestion,
227 * Initialize the ATS connectivity suggestion client handle.
229 * @param cfg configuration to use
230 * @return ats connectivity handle, NULL on error
232 struct GNUNET_ATS_ConnectivityHandle *
233 GNUNET_ATS_connectivity_init (const struct GNUNET_CONFIGURATION_Handle *cfg)
235 struct GNUNET_ATS_ConnectivityHandle *ch;
237 ch = GNUNET_new (struct GNUNET_ATS_ConnectivityHandle);
239 ch->sug_requests = GNUNET_CONTAINER_multipeermap_create (32,
247 * Function called to free all `struct GNUNET_ATS_SuggestHandles`
252 * @param value the value to free
253 * @return #GNUNET_OK (continue to iterate)
256 free_sug_handle (void *cls,
257 const struct GNUNET_PeerIdentity *key,
260 struct GNUNET_ATS_ConnectivitySuggestHandle *cur = value;
268 * Client is done with ATS connectivity management, release resources.
270 * @param ch handle to release
273 GNUNET_ATS_connectivity_done (struct GNUNET_ATS_ConnectivityHandle *ch)
277 GNUNET_MQ_destroy (ch->mq);
280 if (NULL != ch->client)
282 GNUNET_CLIENT_disconnect (ch->client);
285 if (NULL != ch->task)
287 GNUNET_SCHEDULER_cancel (ch->task);
290 GNUNET_CONTAINER_multipeermap_iterate (ch->sug_requests,
293 GNUNET_CONTAINER_multipeermap_destroy (ch->sug_requests);
299 * We would like to receive address suggestions for a peer. ATS will
300 * respond with a call to the continuation immediately containing an address or
301 * no address if none is available. ATS can suggest more addresses until we call
302 * #GNUNET_ATS_connectivity_suggest_cancel().
305 * @param peer identity of the peer we need an address for
306 * @return suggest handle, NULL if a request is already pending
308 struct GNUNET_ATS_ConnectivitySuggestHandle *
309 GNUNET_ATS_connectivity_suggest (struct GNUNET_ATS_ConnectivityHandle *ch,
310 const struct GNUNET_PeerIdentity *peer)
312 struct GNUNET_ATS_ConnectivitySuggestHandle *s;
314 LOG (GNUNET_ERROR_TYPE_DEBUG,
315 "Requesting ATS to suggest address for `%s'\n",
317 s = GNUNET_new (struct GNUNET_ATS_ConnectivitySuggestHandle);
321 GNUNET_CONTAINER_multipeermap_put (ch->sug_requests,
324 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
331 (void) transmit_suggestion (ch,
339 * We no longer care about being connected to a peer.
341 * @param sh handle to stop
344 GNUNET_ATS_connectivity_suggest_cancel (struct GNUNET_ATS_ConnectivitySuggestHandle *sh)
346 struct GNUNET_ATS_ConnectivityHandle *ch = sh->ch;
347 struct GNUNET_MQ_Envelope *ev;
348 struct RequestAddressMessage *m;
350 LOG (GNUNET_ERROR_TYPE_DEBUG,
351 "Telling ATS we no longer care for an address for `%s'\n",
352 GNUNET_i2s (&sh->id));
353 GNUNET_assert (GNUNET_OK ==
354 GNUNET_CONTAINER_multipeermap_remove (ch->sug_requests,
362 ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL);
363 m->reserved = htonl (0);
365 GNUNET_MQ_send (ch->mq, ev);
370 /* end of ats_api_connectivity.c */