src/nse/nse_api.c

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