2 This file is part of GNUnet.
3 (C) 2009, 2010 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.
22 * @file transport/transport_api_peer_address_lookup.c
23 * @brief given a peer id, get all known addresses from transport service
25 * This api provides the ability to query the transport service about
26 * the status of connections to a specific peer. Calls back with a
27 * pretty printed string of the address, as formatted by the appropriate
28 * transport plugin, and whether or not the address given is currently
29 * in the 'connected' state (according to the transport service).
33 #include "gnunet_client_lib.h"
34 #include "gnunet_arm_service.h"
35 #include "gnunet_hello_lib.h"
36 #include "gnunet_protocols.h"
37 #include "gnunet_server_lib.h"
38 #include "gnunet_time_lib.h"
39 #include "gnunet_transport_service.h"
40 #include "transport.h"
43 * Context for the address lookup.
45 struct GNUNET_TRANSPORT_PeerIterateContext
48 * Function to call with the binary address.
50 GNUNET_TRANSPORT_PeerIterateCallback cb;
58 * Connection to the service.
60 struct GNUNET_CLIENT_Connection *client;
63 * When should this operation time out?
65 struct GNUNET_TIME_Absolute timeout;
70 * Function called with responses from the service.
72 * @param cls our 'struct GNUNET_TRANSPORT_PeerAddressLookupContext*'
73 * @param msg NULL on timeout or error, otherwise presumably a
74 * message with the human-readable address
77 peer_address_response_processor (void *cls,
78 const struct GNUNET_MessageHeader *msg)
80 struct GNUNET_TRANSPORT_PeerIterateContext *pal_ctx = cls;
81 struct AddressIterateResponseMessage *air_msg;
82 struct GNUNET_HELLO_Address *address;
84 const char *transport_name;
91 pal_ctx->cb (pal_ctx->cb_cls, NULL, NULL);
92 GNUNET_TRANSPORT_peer_get_active_addresses_cancel (pal_ctx);
95 size = ntohs (msg->size);
96 GNUNET_break (ntohs (msg->type) ==
97 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE_RESPONSE);
98 if (size == sizeof (struct GNUNET_MessageHeader))
101 pal_ctx->cb (pal_ctx->cb_cls, NULL, NULL);
102 GNUNET_TRANSPORT_peer_get_active_addresses_cancel (pal_ctx);
107 sizeof (struct GNUNET_MessageHeader) +
108 sizeof (struct AddressIterateResponseMessage)) ||
109 (ntohs (msg->type) !=
110 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE_RESPONSE))
113 pal_ctx->cb (pal_ctx->cb_cls, NULL, NULL);
114 GNUNET_TRANSPORT_peer_get_active_addresses_cancel (pal_ctx);
118 air_msg = (struct AddressIterateResponseMessage *) msg;
119 tlen = ntohl (air_msg->pluginlen);
120 alen = ntohl (air_msg->addrlen);
122 if (size != sizeof (struct AddressIterateResponseMessage) + tlen + alen)
125 pal_ctx->cb (pal_ctx->cb_cls, NULL, NULL);
126 GNUNET_TRANSPORT_peer_get_active_addresses_cancel (pal_ctx);
130 addr = (const char *) &air_msg[1];
131 transport_name = &addr[alen];
133 if (transport_name[tlen - 1] != '\0')
136 pal_ctx->cb (pal_ctx->cb_cls, NULL, NULL);
137 GNUNET_TRANSPORT_peer_get_active_addresses_cancel (pal_ctx);
141 /* expect more replies */
142 GNUNET_CLIENT_receive (pal_ctx->client, &peer_address_response_processor,
144 GNUNET_TIME_absolute_get_remaining (pal_ctx->timeout));
148 GNUNET_HELLO_address_allocate (&air_msg->peer, transport_name, addr,
150 pal_ctx->cb (pal_ctx->cb_cls, &air_msg->peer, address);
151 GNUNET_HELLO_address_free (address);
156 * Return all the known addresses for a specific peer or all peers.
157 * Returns continously all address if one_shot is set to GNUNET_NO
159 * CHANGE: Returns the address(es) that we are currently using for this
160 * peer. Upon completion, the 'AddressLookUpCallback' is called one more
161 * time with 'NULL' for the address and the peer. After this, the operation must no
162 * longer be explicitly cancelled.
164 * @param cfg configuration to use
165 * @param peer peer identity to look up the addresses of, CHANGE: allow NULL for all (connected) peers
166 * @param one_shot GNUNET_YES to return the current state and then end (with NULL+NULL),
167 * GNUNET_NO to monitor the set of addresses used (continuously, must be explicitly cancelled)
168 * @param timeout how long is the lookup allowed to take at most
169 * @param peer_address_callback function to call with the results
170 * @param peer_address_callback_cls closure for peer_address_callback
172 struct GNUNET_TRANSPORT_PeerIterateContext *
173 GNUNET_TRANSPORT_peer_get_active_addresses (const struct
174 GNUNET_CONFIGURATION_Handle *cfg,
175 const struct GNUNET_PeerIdentity
177 struct GNUNET_TIME_Relative timeout,
178 GNUNET_TRANSPORT_PeerIterateCallback
179 peer_address_callback,
180 void *peer_address_callback_cls)
182 struct GNUNET_TRANSPORT_PeerIterateContext *pal_ctx;
183 struct AddressIterateMessage msg;
184 struct GNUNET_CLIENT_Connection *client;
185 struct GNUNET_TIME_Absolute abs_timeout;
187 if (GNUNET_YES != one_shot)
189 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
190 "Address monitoring not implemented\n");
193 client = GNUNET_CLIENT_connect ("transport", cfg);
196 abs_timeout = GNUNET_TIME_relative_to_absolute (timeout);
197 msg.header.size = htons (sizeof (struct AddressIterateMessage));
198 msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE);
199 msg.one_shot = htonl (one_shot);
200 msg.timeout = GNUNET_TIME_absolute_hton (abs_timeout);
202 memset (&msg.peer, 0, sizeof (struct GNUNET_PeerIdentity));
205 pal_ctx = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PeerIterateContext));
206 pal_ctx->cb = peer_address_callback;
207 pal_ctx->cb_cls = peer_address_callback_cls;
208 pal_ctx->timeout = abs_timeout;
209 pal_ctx->client = client;
210 GNUNET_assert (GNUNET_OK ==
211 GNUNET_CLIENT_transmit_and_get_response (client, &msg.header,
213 &peer_address_response_processor,
220 * Cancel request for address conversion.
222 * @param alc handle for the request to cancel
225 GNUNET_TRANSPORT_peer_get_active_addresses_cancel (struct
226 GNUNET_TRANSPORT_PeerIterateContext
229 GNUNET_CLIENT_disconnect (alc->client, GNUNET_NO);
234 /* end of transport_api_peer_address_lookup.c */