rename connecT -> connect now that the old API is dead
[oweals/gnunet.git] / src / transport / transport_api_monitor_peers.c
index 5d19ad6d7a515e94e7bbea9f27a2af55120f7c8a..38e6e0d7c20019828ff4beb159778463cbc5e2a1 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     Copyright (C) 2009-2014 GNUnet e.V.
+     Copyright (C) 2009-2014, 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
@@ -54,18 +54,13 @@ struct GNUNET_TRANSPORT_PeerMonitoringContext
   /**
    * Connection to the service.
    */
-  struct GNUNET_CLIENT_Connection *client;
+  struct GNUNET_MQ_Handle *mq;
 
   /**
    * Configuration we use.
    */
   const struct GNUNET_CONFIGURATION_Handle *cfg;
 
-  /**
-   * When should this operation time out?
-   */
-  struct GNUNET_TIME_Absolute timeout;
-
   /**
    * Backoff for reconnect.
    */
@@ -165,76 +160,103 @@ GNUNET_TRANSPORT_ps2s (enum GNUNET_TRANSPORT_PeerState state)
 
 
 /**
- * Function called with responses from the service.
+ * Task run to re-establish the connection.
  *
  * @param cls our `struct GNUNET_TRANSPORT_PeerMonitoringContext *`
- * @param msg NULL on timeout or error, otherwise presumably a
- *        message with the human-readable address
  */
 static void
-peer_response_processor (void *cls,
-                         const struct GNUNET_MessageHeader *msg);
+do_peer_connect (void *cls);
 
 
 /**
- * Send our subscription request to the service.
+ * Cut the existing connection and reconnect.
  *
  * @param pal_ctx our context
  */
 static void
-send_peer_mon_request (struct GNUNET_TRANSPORT_PeerMonitoringContext *pal_ctx)
+reconnect_peer_ctx (struct GNUNET_TRANSPORT_PeerMonitoringContext *pal_ctx)
 {
-  struct PeerMonitorMessage msg;
-
-  msg.header.size = htons (sizeof (struct PeerMonitorMessage));
-  msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_REQUEST);
-  msg.one_shot = htonl (pal_ctx->one_shot);
-  msg.peer = pal_ctx->peer;
-  GNUNET_assert (GNUNET_OK ==
-                 GNUNET_CLIENT_transmit_and_get_response (pal_ctx->client,
-                                                          &msg.header,
-                                                          GNUNET_TIME_absolute_get_remaining (pal_ctx->timeout),
-                                                          GNUNET_YES,
-                                                          &peer_response_processor,
-                                                          pal_ctx));
+  GNUNET_assert (GNUNET_NO == pal_ctx->one_shot);
+  GNUNET_MQ_destroy (pal_ctx->mq);
+  pal_ctx->mq = NULL;
+  pal_ctx->cb (pal_ctx->cb_cls,
+               NULL,
+               NULL,
+               GNUNET_TRANSPORT_PS_NOT_CONNECTED,
+               GNUNET_TIME_UNIT_ZERO_ABS);
+  pal_ctx->backoff = GNUNET_TIME_STD_BACKOFF (pal_ctx->backoff);
+  pal_ctx->reconnect_task = GNUNET_SCHEDULER_add_delayed (pal_ctx->backoff,
+                                                         &do_peer_connect,
+                                                         pal_ctx);
 }
 
 
 /**
- * Task run to re-establish the connection.
+ * Function called with responses from the service.
  *
  * @param cls our `struct GNUNET_TRANSPORT_PeerMonitoringContext *`
+ * @param msg message from service
  */
 static void
-do_peer_connect (void *cls)
+handle_response_end (void *cls,
+                     const struct GNUNET_MessageHeader *msg)
 {
   struct GNUNET_TRANSPORT_PeerMonitoringContext *pal_ctx = cls;
 
-  pal_ctx->reconnect_task = NULL;
-  pal_ctx->client = GNUNET_CLIENT_connect ("transport", pal_ctx->cfg);
-  GNUNET_assert (NULL != pal_ctx->client);
-  send_peer_mon_request (pal_ctx);
+  if (pal_ctx->one_shot)
+  {
+    /* iteration finished */
+    pal_ctx->cb (pal_ctx->cb_cls,
+                 NULL,
+                 NULL,
+                 GNUNET_TRANSPORT_PS_NOT_CONNECTED,
+                 GNUNET_TIME_UNIT_ZERO_ABS);
+    GNUNET_TRANSPORT_monitor_peers_cancel (pal_ctx);
+    return;
+  }
+  /* not quite what we expected, reconnect */
+  GNUNET_break (0);
+  reconnect_peer_ctx (pal_ctx);
 }
 
 
 /**
- * Cut the existing connection and reconnect.
+ * Function called to check responses from the service.
  *
- * @param pal_ctx our context
+ * @param cls our `struct GNUNET_TRANSPORT_PeerMonitoringContext *`
+ * @param pir_msg  message with the human-readable address
+ * @return #GNUNET_OK if @a pir_msg is well-formed
  */
-static void
-reconnect_peer_ctx (struct GNUNET_TRANSPORT_PeerMonitoringContext *pal_ctx)
+static int
+check_response (void *cls,
+                const struct PeerIterateResponseMessage *pir_msg)
 {
-  GNUNET_assert (GNUNET_NO == pal_ctx->one_shot);
-  GNUNET_CLIENT_disconnect (pal_ctx->client);
-  pal_ctx->client = NULL;
-  pal_ctx->cb (pal_ctx->cb_cls, NULL, NULL,
-               GNUNET_TRANSPORT_PS_NOT_CONNECTED,
-               GNUNET_TIME_UNIT_ZERO_ABS);
-  pal_ctx->backoff = GNUNET_TIME_STD_BACKOFF (pal_ctx->backoff);
-  pal_ctx->reconnect_task = GNUNET_SCHEDULER_add_delayed (pal_ctx->backoff,
-                                                         &do_peer_connect,
-                                                         pal_ctx);
+  uint16_t size = ntohs (pir_msg->header.size) - sizeof (*pir_msg);
+  size_t alen = ntohl (pir_msg->addrlen);
+  size_t tlen = ntohl (pir_msg->pluginlen);
+  const char *addr;
+  const char *transport_name;
+
+  if (size != tlen + alen)
+  {
+    GNUNET_break (0);
+    return GNUNET_SYSERR;
+  }
+  if ( (0 == tlen) && (0 == alen) )
+    return GNUNET_OK;
+  if (0 == tlen)
+  {
+    GNUNET_break (0); /* This must not happen: address without plugin */
+    return GNUNET_SYSERR;
+  }
+  addr = (const char *) &pir_msg[1];
+  transport_name = &addr[alen];
+  if (transport_name[tlen - 1] != '\0')
+  {
+    GNUNET_break (0);
+    return GNUNET_SYSERR;
+  }
+  return GNUNET_OK;
 }
 
 
@@ -242,143 +264,115 @@ reconnect_peer_ctx (struct GNUNET_TRANSPORT_PeerMonitoringContext *pal_ctx)
  * Function called with responses from the service.
  *
  * @param cls our `struct GNUNET_TRANSPORT_PeerMonitoringContext *`
- * @param msg NULL on timeout or error, otherwise presumably a
- *        message with the human-readable address
+ * @param msg  message with the human-readable address
  */
 static void
-peer_response_processor (void *cls,
-                         const struct GNUNET_MessageHeader *msg)
+handle_response (void *cls,
+                 const struct PeerIterateResponseMessage *pir_msg)
 {
   struct GNUNET_TRANSPORT_PeerMonitoringContext *pal_ctx = cls;
-  struct PeerIterateResponseMessage *pir_msg;
   struct GNUNET_HELLO_Address *address;
+  size_t alen = ntohl (pir_msg->addrlen);
+  size_t tlen = ntohl (pir_msg->pluginlen);
   const char *addr;
   const char *transport_name;
-  uint16_t size;
-  size_t alen;
-  size_t tlen;
 
-  if (NULL == msg)
-  {
-    if (pal_ctx->one_shot)
-    {
-      /* Disconnect */
-      pal_ctx->cb (pal_ctx->cb_cls, NULL, NULL,
-          GNUNET_TRANSPORT_PS_NOT_CONNECTED, GNUNET_TIME_UNIT_ZERO_ABS);
-      GNUNET_TRANSPORT_monitor_peers_cancel (pal_ctx);
-    }
-    else
-    {
-      reconnect_peer_ctx (pal_ctx);
-    }
-    return;
-  }
-  size = ntohs (msg->size);
-  GNUNET_break (ntohs (msg->type) ==
-      GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE);
-  if (size == sizeof (struct GNUNET_MessageHeader))
+  if ( (0 == tlen) &&
+       (0 == alen) )
   {
-    /* Done! */
-    if (pal_ctx->one_shot)
-    {
-      /* iteration finished */
-      pal_ctx->cb (pal_ctx->cb_cls, NULL, NULL,
-          GNUNET_TRANSPORT_PS_NOT_CONNECTED, GNUNET_TIME_UNIT_ZERO_ABS);
-      GNUNET_TRANSPORT_monitor_peers_cancel (pal_ctx);
-    }
-    else
-    {
-      reconnect_peer_ctx (pal_ctx);
-    }
+    /* No address available */
+    pal_ctx->cb (pal_ctx->cb_cls,
+                 &pir_msg->peer,
+                 NULL,
+                 ntohl(pir_msg->state),
+                 GNUNET_TIME_absolute_ntoh (pir_msg->state_timeout));
     return;
   }
+  addr = (const char *) &pir_msg[1];
+  transport_name = &addr[alen];
+
+  /* notify client */
+  address = GNUNET_HELLO_address_allocate (&pir_msg->peer,
+                                           transport_name,
+                                           addr,
+                                           alen,
+                                           ntohl (pir_msg->local_address_info));
+  pal_ctx->cb (pal_ctx->cb_cls,
+               &pir_msg->peer,
+               address,
+               ntohl (pir_msg->state),
+               GNUNET_TIME_absolute_ntoh (pir_msg->state_timeout));
+  GNUNET_HELLO_address_free (address);
+}
 
-  if ((size < sizeof (struct PeerIterateResponseMessage)) ||
-      (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE))
-  {
-    GNUNET_break (0);
-    if (pal_ctx->one_shot)
-    {
-      /* iteration finished (with error) */
-      pal_ctx->cb (pal_ctx->cb_cls, NULL, NULL,
-          GNUNET_TRANSPORT_PS_NOT_CONNECTED, GNUNET_TIME_UNIT_ZERO_ABS);
-      GNUNET_TRANSPORT_monitor_peers_cancel (pal_ctx);
-    }
-    else
-    {
-      reconnect_peer_ctx (pal_ctx);
-    }
-    return;
-  }
 
-  pir_msg = (struct PeerIterateResponseMessage *) msg;
-  tlen = ntohl (pir_msg->pluginlen);
-  alen = ntohl (pir_msg->addrlen);
 
-  if (size != sizeof (struct PeerIterateResponseMessage) + tlen + alen)
+/**
+ * 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 with the `struct GNUNET_TRANSPORT_PeerMonitoringContext *`
+ * @param error error code
+ */
+static void
+mq_error_handler (void *cls,
+                  enum GNUNET_MQ_Error error)
+{
+  struct GNUNET_TRANSPORT_PeerMonitoringContext *pal_ctx = cls;
+
+  if (pal_ctx->one_shot)
   {
-    GNUNET_break (0);
-    if (pal_ctx->one_shot)
-    {
-      pal_ctx->cb (pal_ctx->cb_cls, NULL, NULL,
-          GNUNET_TRANSPORT_PS_NOT_CONNECTED, GNUNET_TIME_UNIT_ZERO_ABS);
-      GNUNET_TRANSPORT_monitor_peers_cancel (pal_ctx);
-    }
-    else
-    {
-      reconnect_peer_ctx (pal_ctx);
-    }
+    /* Disconnect */
+    pal_ctx->cb (pal_ctx->cb_cls,
+                 NULL,
+                 NULL,
+                 GNUNET_TRANSPORT_PS_NOT_CONNECTED,
+                 GNUNET_TIME_UNIT_ZERO_ABS);
+    GNUNET_TRANSPORT_monitor_peers_cancel (pal_ctx);
     return;
   }
+  reconnect_peer_ctx (pal_ctx);
+}
 
-  if ( (0 == tlen) && (0 == alen) )
-  {
-    /* No address available */
-    pal_ctx->cb (pal_ctx->cb_cls, &pir_msg->peer, NULL,
-        ntohl(pir_msg->state),
-        GNUNET_TIME_absolute_ntoh (pir_msg->state_timeout));
-  }
-  else
-  {
-    if (0 == tlen)
-    {
-      GNUNET_break (0); /* This must not happen: address without plugin */
-      return;
-    }
-    addr = (const char *) &pir_msg[1];
-    transport_name = &addr[alen];
-
-    if (transport_name[tlen - 1] != '\0')
-    {
-      /* Corrupt plugin name */
-      GNUNET_break (0);
-      if (pal_ctx->one_shot)
-      {
-        pal_ctx->cb (pal_ctx->cb_cls, NULL, NULL,
-            GNUNET_TRANSPORT_PS_NOT_CONNECTED, GNUNET_TIME_UNIT_ZERO_ABS);
-        GNUNET_TRANSPORT_monitor_peers_cancel (pal_ctx);
-      }
-      else
-      {
-        reconnect_peer_ctx (pal_ctx);
-      }
-      return;
-    }
-
-    /* notify client */
-    address = GNUNET_HELLO_address_allocate (&pir_msg->peer,
-        transport_name, addr, alen, ntohl(pir_msg->local_address_info));
-    pal_ctx->cb (pal_ctx->cb_cls, &pir_msg->peer, address,
-        ntohl(pir_msg->state),
-        GNUNET_TIME_absolute_ntoh (pir_msg->state_timeout));
-    GNUNET_HELLO_address_free (address);
 
-  }
+/**
+ * Task run to re-establish the connection.
+ *
+ * @param cls our `struct GNUNET_TRANSPORT_PeerMonitoringContext *`
+ */
+static void
+do_peer_connect (void *cls)
+{
+  struct GNUNET_TRANSPORT_PeerMonitoringContext *pal_ctx = cls;
+  struct GNUNET_MQ_MessageHandler handlers[] = {
+    GNUNET_MQ_hd_var_size (response,
+                           GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE,
+                           struct PeerIterateResponseMessage,
+                           pal_ctx),
+    GNUNET_MQ_hd_fixed_size (response_end,
+                             GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE_END,
+                             struct GNUNET_MessageHeader,
+                             pal_ctx),
+    GNUNET_MQ_handler_end ()
+  };
+  struct PeerMonitorMessage *msg;
+  struct GNUNET_MQ_Envelope *env;
 
-  /* expect more replies */
-  GNUNET_CLIENT_receive (pal_ctx->client, &peer_response_processor,
-                         pal_ctx,
-                         GNUNET_TIME_absolute_get_remaining (pal_ctx->timeout));
+  pal_ctx->reconnect_task = NULL;
+  pal_ctx->mq = GNUNET_CLIENT_connect (pal_ctx->cfg,
+                                       "transport",
+                                       handlers,
+                                       &mq_error_handler,
+                                       pal_ctx);
+  if (NULL == pal_ctx->mq)
+    return;
+  env = GNUNET_MQ_msg (msg,
+                       GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_REQUEST);
+  msg->one_shot = htonl (pal_ctx->one_shot);
+  msg->peer = pal_ctx->peer;
+  GNUNET_MQ_send (pal_ctx->mq,
+                  env);
 }
 
 
@@ -405,7 +399,6 @@ peer_response_processor (void *cls,
  *      NULL for all peers
  * @param one_shot #GNUNET_YES to return the current state and then end (with NULL+NULL),
  *                 #GNUNET_NO to monitor peers continuously
- * @param timeout how long is the lookup allowed to take at most
  * @param peer_callback function to call with the results
  * @param peer_callback_cls closure for @a peer_address_callback
  */
@@ -413,29 +406,24 @@ struct GNUNET_TRANSPORT_PeerMonitoringContext *
 GNUNET_TRANSPORT_monitor_peers (const struct GNUNET_CONFIGURATION_Handle *cfg,
                                 const struct GNUNET_PeerIdentity *peer,
                                 int one_shot,
-                                struct GNUNET_TIME_Relative timeout,
                                 GNUNET_TRANSPORT_PeerIterateCallback peer_callback,
                                 void *peer_callback_cls)
 {
-  struct GNUNET_TRANSPORT_PeerMonitoringContext *pal_ctx;
-  struct GNUNET_CLIENT_Connection *client;
+  struct GNUNET_TRANSPORT_PeerMonitoringContext *pal_ctx
+    = GNUNET_new (struct GNUNET_TRANSPORT_PeerMonitoringContext);
 
-  client = GNUNET_CLIENT_connect ("transport", cfg);
-  if (NULL == client)
-    return NULL;
-  if (GNUNET_YES != one_shot)
-    timeout = GNUNET_TIME_UNIT_FOREVER_REL;
-  pal_ctx = GNUNET_new (struct GNUNET_TRANSPORT_PeerMonitoringContext);
   pal_ctx->cb = peer_callback;
   pal_ctx->cb_cls = peer_callback_cls;
   pal_ctx->cfg = cfg;
-  pal_ctx->timeout = GNUNET_TIME_relative_to_absolute (timeout);
   if (NULL != peer)
     pal_ctx->peer = *peer;
   pal_ctx->one_shot = one_shot;
-  pal_ctx->client = client;
-  send_peer_mon_request (pal_ctx);
-
+  do_peer_connect (pal_ctx);
+  if (NULL == pal_ctx->mq)
+  {
+    GNUNET_free (pal_ctx);
+    return NULL;
+  }
   return pal_ctx;
 }
 
@@ -448,10 +436,10 @@ GNUNET_TRANSPORT_monitor_peers (const struct GNUNET_CONFIGURATION_Handle *cfg,
 void
 GNUNET_TRANSPORT_monitor_peers_cancel (struct GNUNET_TRANSPORT_PeerMonitoringContext *pic)
 {
-  if (NULL != pic->client)
+  if (NULL != pic->mq)
   {
-    GNUNET_CLIENT_disconnect (pic->client);
-    pic->client = NULL;
+    GNUNET_MQ_destroy (pic->mq);
+    pic->mq = NULL;
   }
   if (NULL != pic->reconnect_task)
   {