first steps to transport_api cleanup
[oweals/gnunet.git] / src / transport / transport_api_address_iterate.c
1 /*
2      This file is part of GNUnet.
3      (C) 2009, 2010 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20
21 /**
22  * @file transport/transport_api_address_iterate.c
23  * @brief api for asking transport service to iterate over all
24  *        known addresses
25  *
26  * This api provides a single function call to ask the transport
27  * service to list all peers and their known addresses, as pretty
28  * printed by the appropriate plugin.  Reports whether or not the
29  * address is connected as well.
30  */
31
32 #include "platform.h"
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"
41
42 /**
43  * Context for the address lookup.
44  */
45 struct AddressLookupCtx
46 {
47   /**
48    * Function to call with the human-readable address.
49    */
50   GNUNET_TRANSPORT_AddressLookUpCallback cb;
51
52   /**
53    * Closure for cb.
54    */
55   void *cb_cls;
56
57   /**
58    * Connection to the service.
59    */
60   struct GNUNET_CLIENT_Connection *client;
61
62   /**
63    * When should this operation time out?
64    */
65   struct GNUNET_TIME_Absolute timeout;
66 };
67
68
69 /**
70  * Function called with responses from the service.
71  *
72  * @param cls our 'struct AddressLookupCtx*'
73  * @param msg NULL on timeout or error, otherwise presumably a
74  *        message with the human-readable peer and address
75  */
76 static void
77 peer_address_response_processor (void *cls,
78                                  const struct GNUNET_MessageHeader *msg)
79 {
80   struct AddressLookupCtx *alucb = cls;
81   struct AddressIterateResponseMessage *arm;
82   struct GNUNET_HELLO_Address * address;
83   uint16_t size;
84
85   if (msg == NULL)
86   {
87     alucb->cb (alucb->cb_cls, NULL);
88     GNUNET_CLIENT_disconnect (alucb->client, GNUNET_NO);
89     GNUNET_free (alucb);
90     return;
91   }
92
93   GNUNET_break (ntohs (msg->type) ==
94                 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
95   size = ntohs (msg->size);
96   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received message type %u size %u\n",
97               ntohs (msg->type), size);
98   if (size == sizeof (struct GNUNET_MessageHeader))
99   {
100     /* done! */
101     alucb->cb (alucb->cb_cls, NULL);
102     GNUNET_CLIENT_disconnect (alucb->client, GNUNET_NO);
103     GNUNET_free (alucb);
104     return;
105   }
106   if (size < sizeof (struct AddressIterateResponseMessage))
107   {
108     /* invalid reply */
109     GNUNET_break (0);
110     alucb->cb (alucb->cb_cls, NULL);
111     GNUNET_CLIENT_disconnect (alucb->client, GNUNET_NO);
112     GNUNET_free (alucb);
113     return;
114   }
115
116   arm = (struct AddressIterateResponseMessage *) &msg[1];
117   address = (struct GNUNET_HELLO_Address *) &arm[1];
118
119   /* expect more replies */
120   GNUNET_CLIENT_receive (alucb->client, &peer_address_response_processor, alucb,
121                          GNUNET_TIME_absolute_get_remaining (alucb->timeout));
122   alucb->cb (alucb->cb_cls, address);
123 }
124
125
126 /**
127  * Return all the known addresses for a peer.
128  *
129  * @param cfg configuration to use
130  * @param timeout how long is the lookup allowed to take at most
131  * @param peer_address_callback function to call with the results
132  * @param peer_address_callback_cls closure for peer_address_callback
133  */
134 void
135 GNUNET_TRANSPORT_address_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg,
136                                   struct GNUNET_TIME_Relative timeout,
137                                   GNUNET_TRANSPORT_AddressLookUpCallback
138                                   peer_address_callback,
139                                   void *peer_address_callback_cls)
140 {
141   struct AddressIterateMessage msg;
142   struct GNUNET_TIME_Absolute abs_timeout;
143   struct AddressLookupCtx *peer_address_lookup_cb;
144   struct GNUNET_CLIENT_Connection *client;
145
146   client = GNUNET_CLIENT_connect ("transport", cfg);
147   if (client == NULL)
148   {
149     peer_address_callback (peer_address_callback_cls, NULL);
150     return;
151   }
152   abs_timeout = GNUNET_TIME_relative_to_absolute (timeout);
153
154   msg.header.size = htons (sizeof (struct AddressIterateMessage));
155   msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE);
156   msg.timeout = GNUNET_TIME_absolute_hton (abs_timeout);
157   peer_address_lookup_cb = GNUNET_malloc (sizeof (struct AddressLookupCtx));
158   peer_address_lookup_cb->cb = peer_address_callback;
159   peer_address_lookup_cb->cb_cls = peer_address_callback_cls;
160   peer_address_lookup_cb->timeout = abs_timeout;
161   peer_address_lookup_cb->client = client;
162   GNUNET_assert (GNUNET_OK ==
163                  GNUNET_CLIENT_transmit_and_get_response (client, &msg.header,
164                                                           timeout, GNUNET_YES,
165                                                           &peer_address_response_processor,
166                                                           peer_address_lookup_cb));
167 }
168
169 /* end of transport_api_address_iterate.c */