2 This file is part of GNUnet.
3 Copyright (C) 2011, 2017 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 cadet/cadet_api_get_path.c
22 * @brief cadet api: client implementation of cadet service
23 * @author Bartlomiej Polot
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_constants.h"
29 #include "gnunet_cadet_service.h"
31 #include "cadet_protocol.h"
37 struct GNUNET_CADET_GetPath
42 GNUNET_CADET_PathCB path_cb;
45 * Closure for @c path_cb.
50 * Message queue to talk to CADET service.
52 struct GNUNET_MQ_Handle *mq;
55 * Configuration we use.
57 const struct GNUNET_CONFIGURATION_Handle *cfg;
62 struct GNUNET_SCHEDULER_Task *reconnect_task;
65 * Backoff for reconnect attempts.
67 struct GNUNET_TIME_Relative backoff;
70 * Peer we want information about.
72 struct GNUNET_PeerIdentity id;
77 * Check that message received from CADET service is well-formed.
80 * @param message the message we got
81 * @return #GNUNET_OK if the message is well-formed,
82 * #GNUNET_SYSERR otherwise
85 check_get_path (void *cls,
86 const struct GNUNET_CADET_LocalInfoPath *message)
88 size_t msize = sizeof(struct GNUNET_CADET_LocalInfoPath);
92 esize = ntohs (message->header.size);
98 if (0 != ((esize - msize) % sizeof(struct GNUNET_PeerIdentity)))
101 return GNUNET_SYSERR;
108 * Process a local peer info reply, pass info to the user.
111 * @param message Message itself.
114 handle_get_path (void *cls,
115 const struct GNUNET_CADET_LocalInfoPath *message)
117 struct GNUNET_CADET_GetPath *gp = cls;
118 struct GNUNET_CADET_PeerPathDetail ppd;
121 ppd.path = (const struct GNUNET_PeerIdentity *) &message[1];
122 ppd.target_offset = ntohl (message->off);
123 ppd.path_length = (ntohs (message->header.size) - sizeof(*message))
124 / sizeof(struct GNUNET_PeerIdentity);
125 gp->path_cb (gp->path_cb_cls,
131 * Process a local peer info reply, pass info to the user.
134 * @param message Message itself.
137 handle_get_path_end (void *cls,
138 const struct GNUNET_MessageHeader *message)
140 struct GNUNET_CADET_GetPath *gp = cls;
143 gp->path_cb (gp->path_cb_cls,
145 GNUNET_CADET_get_path_cancel (gp);
150 * Reconnect to the service and try again.
152 * @param cls a `struct GNUNET_CADET_GetPath` operation
155 reconnect (void *cls);
159 * Function called on connection trouble. Reconnects.
161 * @param cls a `struct GNUNET_CADET_GetPath`
162 * @param error error code from MQ
165 error_handler (void *cls,
166 enum GNUNET_MQ_Error error)
168 struct GNUNET_CADET_GetPath *gp = cls;
170 GNUNET_MQ_destroy (gp->mq);
172 gp->backoff = GNUNET_TIME_randomized_backoff (gp->backoff,
173 GNUNET_TIME_UNIT_MINUTES);
174 gp->reconnect_task = GNUNET_SCHEDULER_add_delayed (gp->backoff,
181 * Reconnect to the service and try again.
183 * @param cls a `struct GNUNET_CADET_GetPath` operation
186 reconnect (void *cls)
188 struct GNUNET_CADET_GetPath *gp = cls;
189 struct GNUNET_MQ_MessageHandler handlers[] = {
190 GNUNET_MQ_hd_var_size (get_path,
191 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PATH,
192 struct GNUNET_CADET_LocalInfoPath,
194 GNUNET_MQ_hd_fixed_size (get_path_end,
195 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PATH_END,
196 struct GNUNET_MessageHeader,
198 GNUNET_MQ_handler_end ()
200 struct GNUNET_CADET_RequestPathInfoMessage *msg;
201 struct GNUNET_MQ_Envelope *env;
203 gp->reconnect_task = NULL;
204 gp->mq = GNUNET_CLIENT_connect (gp->cfg,
211 env = GNUNET_MQ_msg (msg,
212 GNUNET_MESSAGE_TYPE_CADET_LOCAL_REQUEST_INFO_PATH);
214 GNUNET_MQ_send (gp->mq,
220 * Request information about paths known to the running cadet peer.
222 * @param cfg configuration to use
223 * @param id Peer whose paths to examine.
224 * @param callback Function to call with the requested data.
225 * @param callback_cls Closure for @c callback.
226 * @return NULL on error
228 struct GNUNET_CADET_GetPath *
229 GNUNET_CADET_get_path (const struct GNUNET_CONFIGURATION_Handle *cfg,
230 const struct GNUNET_PeerIdentity *id,
231 GNUNET_CADET_PathCB callback,
234 struct GNUNET_CADET_GetPath *gp;
236 if (NULL == callback)
241 gp = GNUNET_new (struct GNUNET_CADET_GetPath);
242 gp->path_cb = callback;
243 gp->path_cb_cls = callback_cls;
257 * Cancel @a gp operation.
259 * @param gp operation to cancel
260 * @return closure from #GNUNET_CADET_get_path().
263 GNUNET_CADET_get_path_cancel (struct GNUNET_CADET_GetPath *gp)
265 void *ret = gp->path_cb_cls;
268 GNUNET_MQ_destroy (gp->mq);
269 if (NULL != gp->reconnect_task)
270 GNUNET_SCHEDULER_cancel (gp->reconnect_task);
276 /* end of cadet_api_get_path.c */