src/nse/nse_api.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009, 2010, 2011 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @file nse/nse_api.c
  23  * @brief api to get information from the network size estimation service
  24  * @author Nathan Evans
  25  */
  26 #include "platform.h"
  27 #include "gnunet_constants.h"
  28 #include "gnunet_arm_service.h"
  29 #include "gnunet_hello_lib.h"
  30 #include "gnunet_protocols.h"
  31 #include "gnunet_util_lib.h"
  32 #include "gnunet_nse_service.h"
  33 #include "nse.h"
  34
  35 #define LOG(kind,...) GNUNET_log_from (kind, "nse-api",__VA_ARGS__)
  36
  37 /**
  38  * Handle for talking with the NSE service.
  39  */
  40 struct GNUNET_NSE_Handle
  41 {
  42   /**
  43    * Configuration to use.
  44    */
  45   const struct GNUNET_CONFIGURATION_Handle *cfg;
  46
  47   /**
  48    * Socket (if available).
  49    */
  50   struct GNUNET_CLIENT_Connection *client;
  51
  52   /**
  53    * Currently pending transmission request.
  54    */
  55   struct GNUNET_CLIENT_TransmitHandle *th;
  56
  57   /**
  58    * Task doing exponential back-off trying to reconnect.
  59    */
  60   struct GNUNET_SCHEDULER_Task * reconnect_task;
  61
  62   /**
  63    * Time for next connect retry.
  64    */
  65   struct GNUNET_TIME_Relative reconnect_delay;
  66
  67   /**
  68    * Callback function to call when message is received.
  69    */
  70   GNUNET_NSE_Callback recv_cb;
  71
  72   /**
  73    * Closure to pass to @e recv_cb callback.
  74    */
  75   void *recv_cb_cls;
  76
  77 };
  78
  79
  80 /**
  81  * Try again to connect to network size estimation service.
  82  *
  83  * @param cls the handle to the transport service
  84  */
  85 static void
  86 reconnect (void *cls);
  87
  88
  89 /**
  90  * Type of a function to call when we receive a message
  91  * from the service.
  92  *
  93  * @param cls closure
  94  * @param msg message received, NULL on timeout or fatal error
  95  */
  96 static void
  97 message_handler (void *cls,
  98                  const struct GNUNET_MessageHeader *msg)
  99 {
 100   struct GNUNET_NSE_Handle *h = cls;
 101   const struct GNUNET_NSE_ClientMessage *client_msg;
 102
 103   if (NULL == msg)
 104   {
 105     /* Error, timeout, death */
 106     GNUNET_CLIENT_disconnect (h->client);
 107     h->client = NULL;
 108     h->reconnect_task =
 109         GNUNET_SCHEDULER_add_delayed (h->reconnect_delay,
 110                                       &reconnect, h);
 111     return;
 112   }
 113   if ((ntohs (msg->size) != sizeof (struct GNUNET_NSE_ClientMessage)) ||
 114       (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_NSE_ESTIMATE))
 115   {
 116     GNUNET_break (0);
 117     return;
 118   }
 119   client_msg = (const struct GNUNET_NSE_ClientMessage *) msg;
 120   h->recv_cb (h->recv_cb_cls, GNUNET_TIME_absolute_ntoh (client_msg->timestamp),
 121               GNUNET_ntoh_double (client_msg->size_estimate),
 122               GNUNET_ntoh_double (client_msg->std_deviation));
 123   GNUNET_CLIENT_receive (h->client, &message_handler, h,
 124                          GNUNET_TIME_UNIT_FOREVER_REL);
 125 }
 126
 127
 128 /**
 129  * Reschedule a connect attempt to the service.
 130  *
 131  * @param h transport service to reconnect
 132  */
 133 static void
 134 reschedule_connect (struct GNUNET_NSE_Handle *h)
 135 {
 136   GNUNET_assert (h->reconnect_task == NULL);
 137
 138   if (NULL != h->th)
 139   {
 140     GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
 141     h->th = NULL;
 142   }
 143   if (NULL != h->client)
 144   {
 145     GNUNET_CLIENT_disconnect (h->client);
 146     h->client = NULL;
 147   }
 148
 149   LOG (GNUNET_ERROR_TYPE_DEBUG,
 150        "Scheduling task to reconnect to nse service in %s.\n",
 151        GNUNET_STRINGS_relative_time_to_string (h->reconnect_delay,
 152                                                GNUNET_YES));
 153   h->reconnect_task =
 154       GNUNET_SCHEDULER_add_delayed (h->reconnect_delay,
 155                                     &reconnect, h);
 156   h->reconnect_delay = GNUNET_TIME_STD_BACKOFF (h->reconnect_delay);
 157 }
 158
 159
 160 /**
 161  * Transmit START message to service.
 162  *
 163  * @param cls the `struct GNUNET_NSE_Handle *`
 164  * @param size number of bytes available in @a buf
 165  * @param buf where to copy the message
 166  * @return number of bytes copied to @a buf
 167  */
 168 static size_t
 169 send_start (void *cls, size_t size, void *buf)
 170 {
 171   struct GNUNET_NSE_Handle *h = cls;
 172   struct GNUNET_MessageHeader *msg;
 173
 174   h->th = NULL;
 175   if (NULL == buf)
 176   {
 177     /* Connect error... */
 178     LOG (GNUNET_ERROR_TYPE_DEBUG,
 179          "Error while trying to transmit `%s' request.\n",
 180          "START");
 181     reschedule_connect (h);
 182     return 0;
 183   }
 184   LOG (GNUNET_ERROR_TYPE_DEBUG,
 185        "Transmitting `%s' request.\n",
 186        "START");
 187   GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
 188
 189   msg = (struct GNUNET_MessageHeader *) buf;
 190   msg->size = htons (sizeof (struct GNUNET_MessageHeader));
 191   msg->type = htons (GNUNET_MESSAGE_TYPE_NSE_START);
 192   GNUNET_CLIENT_receive (h->client, &message_handler, h,
 193                          GNUNET_TIME_UNIT_FOREVER_REL);
 194   return sizeof (struct GNUNET_MessageHeader);
 195 }
 196
 197
 198 /**
 199  * Try again to connect to network size estimation service.
 200  *
 201  * @param cls the `struct GNUNET_NSE_Handle *`
 202  */
 203 static void
 204 reconnect (void *cls)
 205 {
 206   struct GNUNET_NSE_Handle *h = cls;
 207
 208   h->reconnect_task = NULL;
 209   LOG (GNUNET_ERROR_TYPE_DEBUG,
 210        "Connecting to network size estimation service.\n");
 211   GNUNET_assert (NULL == h->client);
 212   h->client = GNUNET_CLIENT_connect ("nse", h->cfg);
 213   GNUNET_assert (NULL != h->client);
 214   GNUNET_assert (NULL == h->th);
 215   h->th =
 216       GNUNET_CLIENT_notify_transmit_ready (h->client,
 217                                            sizeof (struct GNUNET_MessageHeader),
 218                                            GNUNET_TIME_UNIT_FOREVER_REL,
 219                                            GNUNET_NO, &send_start, h);
 220   GNUNET_assert (NULL != h->th);
 221 }
 222
 223
 224 /**
 225  * Connect to the network size estimation service.
 226  *
 227  * @param cfg the configuration to use
 228  * @param func funtion to call with network size estimate
 229  * @param func_cls closure to pass to @a func
 230  * @return handle to use
 231  */
 232 struct GNUNET_NSE_Handle *
 233 GNUNET_NSE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 234                     GNUNET_NSE_Callback func, void *func_cls)
 235 {
 236   struct GNUNET_NSE_Handle *ret;
 237
 238   GNUNET_assert (func != NULL);
 239   ret = GNUNET_new (struct GNUNET_NSE_Handle);
 240   ret->cfg = cfg;
 241   ret->recv_cb = func;
 242   ret->recv_cb_cls = func_cls;
 243   ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
 244   ret->reconnect_task = GNUNET_SCHEDULER_add_now (&reconnect, ret);
 245   return ret;
 246 }
 247
 248
 249 /**
 250  * Disconnect from network size estimation service
 251  *
 252  * @param h handle to destroy
 253  */
 254 void
 255 GNUNET_NSE_disconnect (struct GNUNET_NSE_Handle *h)
 256 {
 257   GNUNET_assert (NULL != h);
 258   if (h->reconnect_task != NULL)
 259   {
 260     GNUNET_SCHEDULER_cancel (h->reconnect_task);
 261     h->reconnect_task = NULL;
 262   }
 263   if (NULL != h->th)
 264   {
 265     GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
 266     h->th = NULL;
 267   }
 268   if (NULL != h->client)
 269   {
 270     GNUNET_CLIENT_disconnect (h->client);
 271     h->client = NULL;
 272   }
 273   GNUNET_free (h);
 274 }
 275
 276 /* end of nse_api.c */