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   const char *address;
  82   uint16_t size;
  83
  84   if (msg == NULL)
  85   {
  86     alucb->cb (alucb->cb_cls, NULL);
  87     GNUNET_CLIENT_disconnect (alucb->client, GNUNET_NO);
  88     GNUNET_free (alucb);
  89     return;
  90   }
  91   GNUNET_break (ntohs (msg->type) ==
  92                 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
  93   size = ntohs (msg->size);
  94   if (size == sizeof (struct GNUNET_MessageHeader))
  95   {
  96     /* done! */
  97     alucb->cb (alucb->cb_cls, NULL);
  98     GNUNET_CLIENT_disconnect (alucb->client, GNUNET_NO);
  99     GNUNET_free (alucb);
 100     return;
 101   }
 102   address = (const char *) &msg[1];
 103   if (address[size - sizeof (struct GNUNET_MessageHeader) - 1] != '\0')
 104   {
 105     /* invalid reply */
 106     GNUNET_break (0);
 107     alucb->cb (alucb->cb_cls, NULL);
 108     GNUNET_CLIENT_disconnect (alucb->client, GNUNET_NO);
 109     GNUNET_free (alucb);
 110     return;
 111   }
 112   /* expect more replies */
 113   GNUNET_CLIENT_receive (alucb->client,
 114                          &peer_address_response_processor, alucb,
 115                          GNUNET_TIME_absolute_get_remaining (alucb->timeout));
 116   alucb->cb (alucb->cb_cls, address);
 117 }
 118
 119
 120 /**
 121  * Return all the known addresses for a peer.
 122  *
 123  * @param cfg configuration to use
 124  * @param timeout how long is the lookup allowed to take at most
 125  * @param peer_address_callback function to call with the results
 126  * @param peer_address_callback_cls closure for peer_address_callback
 127  */
 128 void
 129 GNUNET_TRANSPORT_address_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg,
 130                                   struct GNUNET_TIME_Relative timeout,
 131                                   GNUNET_TRANSPORT_AddressLookUpCallback
 132                                   peer_address_callback,
 133                                   void *peer_address_callback_cls)
 134 {
 135   struct AddressIterateMessage msg;
 136   struct GNUNET_TIME_Absolute abs_timeout;
 137   struct AddressLookupCtx *peer_address_lookup_cb;
 138   struct GNUNET_CLIENT_Connection *client;
 139
 140   client = GNUNET_CLIENT_connect ("transport", cfg);
 141   if (client == NULL)
 142   {
 143     peer_address_callback (peer_address_callback_cls, NULL);
 144     return;
 145   }
 146   abs_timeout = GNUNET_TIME_relative_to_absolute (timeout);
 147
 148   msg.header.size = htons (sizeof (struct AddressLookupMessage));
 149   msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE);
 150   msg.timeout = GNUNET_TIME_absolute_hton (abs_timeout);
 151   peer_address_lookup_cb = GNUNET_malloc (sizeof (struct AddressLookupCtx));
 152   peer_address_lookup_cb->cb = peer_address_callback;
 153   peer_address_lookup_cb->cb_cls = peer_address_callback_cls;
 154   peer_address_lookup_cb->timeout = abs_timeout;
 155   peer_address_lookup_cb->client = client;
 156   GNUNET_assert (GNUNET_OK ==
 157                  GNUNET_CLIENT_transmit_and_get_response (client,
 158                                                           &msg.header,
 159                                                           timeout,
 160                                                           GNUNET_YES,
 161                                                           &peer_address_response_processor,
 162                                                           peer_address_lookup_cb));
 163 }
 164
 165 /* end of transport_api_address_iterate.c */