doc: gnunet-c-tutorial: Add nodes.
[oweals/gnunet.git] / src / nse / nse_api.c
index 8ff0256b9107e880b4d2ab21bad2bcbf3b69ff9a..d50b0214ac8efbe80ae177b6fddfa052bdae8302 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2009, 2010, 2011, 2016 GNUnet e.V.
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,8 +14,8 @@
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
  * @author Nathan Evans
  */
 #include "platform.h"
-#include "gnunet_client_lib.h"
 #include "gnunet_constants.h"
-#include "gnunet_container_lib.h"
 #include "gnunet_arm_service.h"
 #include "gnunet_hello_lib.h"
 #include "gnunet_protocols.h"
-#include "gnunet_server_lib.h"
-#include "gnunet_time_lib.h"
+#include "gnunet_util_lib.h"
 #include "gnunet_nse_service.h"
 #include "nse.h"
 
+#define LOG(kind,...) GNUNET_log_from (kind, "nse-api",__VA_ARGS__)
 
 /**
- * Handle for the service.
+ * Handle for talking with the NSE service.
  */
 struct GNUNET_NSE_Handle
 {
@@ -47,19 +45,14 @@ struct GNUNET_NSE_Handle
   const struct GNUNET_CONFIGURATION_Handle *cfg;
 
   /**
-   * Socket (if available).
+   * Message queue (if available).
    */
-  struct GNUNET_CLIENT_Connection *client;
-
-  /**
-   * Currently pending transmission request.
-   */
-  struct GNUNET_CLIENT_TransmitHandle *th;
+  struct GNUNET_MQ_Handle *mq;
 
   /**
    * Task doing exponential back-off trying to reconnect.
    */
-  GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
+  struct GNUNET_SCHEDULER_Task *reconnect_task;
 
   /**
    * Time for next connect retry.
@@ -72,7 +65,7 @@ struct GNUNET_NSE_Handle
   GNUNET_NSE_Callback recv_cb;
 
   /**
-   * Closure to pass to callback.
+   * Closure to pass to @e recv_cb callback.
    */
   void *recv_cb_cls;
 
@@ -82,161 +75,92 @@ struct GNUNET_NSE_Handle
 /**
  * Try again to connect to network size estimation service.
  *
- * @param cls the handle to the transport service
- * @param tc scheduler context
+ * @param cls closure with the `struct GNUNET_NSE_Handle *`
  */
-static void reconnect (void *cls,
-                       const struct GNUNET_SCHEDULER_TaskContext *tc);
+static void
+reconnect (void *cls);
 
 
 /**
- * Type of a function to call when we receive a message
- * from the service.
+ * Generic error handler, called with the appropriate
+ * error code and the same closure specified at the creation of
+ * the message queue.
+ * Not every message queue implementation supports an error handler.
  *
- * @param cls closure
- * @param msg message received, NULL on timeout or fatal error
+ * @param cls closure with the `struct GNUNET_NSE_Handle *`
+ * @param error error code
  */
 static void
-message_handler (void *cls, const struct GNUNET_MessageHeader *msg)
+mq_error_handler (void *cls,
+                  enum GNUNET_MQ_Error error)
 {
   struct GNUNET_NSE_Handle *h = cls;
-  const struct GNUNET_NSE_ClientMessage *client_msg;
 
-  if (msg == NULL)
-  {
-    /* Error, timeout, death */
-    GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
-    h->client = NULL;
-    h->reconnect_task =
-        GNUNET_SCHEDULER_add_delayed (h->reconnect_delay, &reconnect, h);
-    return;
-  }
-  if ((ntohs (msg->size) != sizeof (struct GNUNET_NSE_ClientMessage)) ||
-      (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_NSE_ESTIMATE))
-  {
-    GNUNET_break (0);
-    return;
-  }
-  client_msg = (const struct GNUNET_NSE_ClientMessage *) msg;
-  h->recv_cb (h->recv_cb_cls, GNUNET_TIME_absolute_ntoh (client_msg->timestamp),
-              client_msg->size_estimate, client_msg->std_deviation);
-  GNUNET_CLIENT_receive (h->client, &message_handler, h,
-                         GNUNET_TIME_UNIT_FOREVER_REL);
+  GNUNET_MQ_destroy (h->mq);
+  h->mq = NULL;
+  h->reconnect_task
+    = GNUNET_SCHEDULER_add_delayed (h->reconnect_delay,
+                                    &reconnect,
+                                    h);
+  h->reconnect_delay = GNUNET_TIME_STD_BACKOFF (h->reconnect_delay);
 }
 
 
-
 /**
- * Reschedule a connect attempt to the service.
+ * Type of a function to call when we receive a message
+ * from the service.
  *
- * @param h transport service to reconnect
+ * @param cls closure
+ * @param client_msg message received
  */
 static void
-reschedule_connect (struct GNUNET_NSE_Handle *h)
-{
-  GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
-
-  if (NULL != h->th)
-  {
-    GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
-    h->th = NULL;
-  }
-  if (NULL != h->client)
-  {
-    GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
-    h->client = NULL;
-  }
-
-#if DEBUG_NSE
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-              "Scheduling task to reconnect to nse service in %llu ms.\n",
-              h->reconnect_delay.rel_value);
-#endif
-  h->reconnect_task =
-      GNUNET_SCHEDULER_add_delayed (h->reconnect_delay, &reconnect, h);
-  if (h->reconnect_delay.rel_value == 0)
-  {
-    h->reconnect_delay = GNUNET_TIME_UNIT_MILLISECONDS;
-  }
-  else
-  {
-    h->reconnect_delay = GNUNET_TIME_relative_multiply (h->reconnect_delay, 2);
-    h->reconnect_delay =
-        GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS, h->reconnect_delay);
-  }
-}
-
-
-/**
- * Transmit START message to service.
- *
- * @param cls unused
- * @param size number of bytes available in buf
- * @param buf where to copy the message
- * @return number of bytes copied to buf
- */
-static size_t
-send_start (void *cls, size_t size, void *buf)
+handle_estimate (void *cls,
+                const struct GNUNET_NSE_ClientMessage *client_msg)
 {
   struct GNUNET_NSE_Handle *h = cls;
-  struct GNUNET_MessageHeader *msg;
-
-  h->th = NULL;
-  if (buf == NULL)
-  {
-    /* Connect error... */
-#if DEBUG_NSE
-    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-                "Shutdown while trying to transmit `%s' request.\n", "START");
-#endif
-    reschedule_connect (h);
-    return 0;
-  }
-#if DEBUG_NSE
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting `%s' request.\n", "START");
-#endif
-  GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
 
-  msg = (struct GNUNET_MessageHeader *) buf;
-  msg->size = htons (sizeof (struct GNUNET_MessageHeader));
-  msg->type = htons (GNUNET_MESSAGE_TYPE_NSE_START);
-  GNUNET_CLIENT_receive (h->client, &message_handler, h,
-                         GNUNET_TIME_UNIT_FOREVER_REL);
-  return sizeof (struct GNUNET_MessageHeader);
+  h->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
+  h->recv_cb (h->recv_cb_cls,
+              GNUNET_TIME_absolute_ntoh (client_msg->timestamp),
+              GNUNET_ntoh_double (client_msg->size_estimate),
+             GNUNET_ntoh_double (client_msg->std_deviation));
 }
 
 
 /**
  * Try again to connect to network size estimation service.
  *
- * @param cls the handle to the transport service
- * @param tc scheduler context
+ * @param cls the `struct GNUNET_NSE_Handle *`
  */
 static void
-reconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+reconnect (void *cls)
 {
   struct GNUNET_NSE_Handle *h = cls;
-
-  h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
-  if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
-  {
-    /* shutdown, just give up */
+  struct GNUNET_MQ_MessageHandler handlers[] = {
+    GNUNET_MQ_hd_fixed_size (estimate,
+                             GNUNET_MESSAGE_TYPE_NSE_ESTIMATE,
+                             struct GNUNET_NSE_ClientMessage,
+                             h),
+    GNUNET_MQ_handler_end ()
+  };
+  struct GNUNET_MessageHeader *msg;
+  struct GNUNET_MQ_Envelope *env;
+
+  h->reconnect_task = NULL;
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Connecting to network size estimation service.\n");
+  GNUNET_assert (NULL == h->mq);
+  h->mq = GNUNET_CLIENT_connect (h->cfg,
+                                 "nse",
+                                 handlers,
+                                 &mq_error_handler,
+                                 h);
+  if (NULL == h->mq)
     return;
-  }
-#if DEBUG_NSE
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-              "Connecting to network size estimation service.\n");
-#endif
-  GNUNET_assert (h->client == NULL);
-  h->client = GNUNET_CLIENT_connect ("nse", h->cfg);
-  GNUNET_assert (h->client != NULL);
-
-  h->th =
-      GNUNET_CLIENT_notify_transmit_ready (h->client,
-                                           sizeof (struct GNUNET_MessageHeader),
-                                           GNUNET_TIME_UNIT_FOREVER_REL,
-                                           GNUNET_NO, &send_start, h);
-  GNUNET_assert (h->th != NULL);
+  env = GNUNET_MQ_msg (msg,
+                       GNUNET_MESSAGE_TYPE_NSE_START);
+  GNUNET_MQ_send (h->mq,
+                  env);
 }
 
 
@@ -245,24 +169,29 @@ reconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  *
  * @param cfg the configuration to use
  * @param func funtion to call with network size estimate
- * @param func_cls closure to pass for network size estimate callback
- *
+ * @param func_cls closure to pass to @a func
  * @return handle to use
  */
 struct GNUNET_NSE_Handle *
 GNUNET_NSE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                    GNUNET_NSE_Callback func, void *func_cls)
+                    GNUNET_NSE_Callback func,
+                    void *func_cls)
 {
-  struct GNUNET_NSE_Handle *ret;
-
-  GNUNET_assert (func != NULL);
-  ret = GNUNET_malloc (sizeof (struct GNUNET_NSE_Handle));
-  ret->cfg = cfg;
-  ret->recv_cb = func;
-  ret->recv_cb_cls = func_cls;
-  ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
-  ret->reconnect_task = GNUNET_SCHEDULER_add_now (&reconnect, ret);
-  return ret;
+  struct GNUNET_NSE_Handle *h;
+
+  GNUNET_assert (NULL != func);
+  h = GNUNET_new (struct GNUNET_NSE_Handle);
+  h->cfg = cfg;
+  h->recv_cb = func;
+  h->recv_cb_cls = func_cls;
+  h->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
+  reconnect (h);
+  if (NULL == h->mq)
+  {
+    GNUNET_free (h);
+    return NULL;
+  }
+  return h;
 }
 
 
@@ -274,21 +203,15 @@ GNUNET_NSE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 void
 GNUNET_NSE_disconnect (struct GNUNET_NSE_Handle *h)
 {
-  GNUNET_assert (h != NULL);
-  if (h->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
+  if (NULL != h->reconnect_task)
   {
     GNUNET_SCHEDULER_cancel (h->reconnect_task);
-    h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
-  }
-  if (h->th != NULL)
-  {
-    GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
-    h->th = NULL;
+    h->reconnect_task = NULL;
   }
-  if (h->client != NULL)
+  if (NULL != h->mq)
   {
-    GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
-    h->client = NULL;
+    GNUNET_MQ_destroy (h->mq);
+    h->mq = NULL;
   }
   GNUNET_free (h);
 }