- FIX: GNUNET_SET_STATUS_HALF_DONE is never called only GNUNET_SET_STATUS_DONE

[oweals/gnunet.git] / src / dv / dv.h

diff --git a/src/dv/dv.h b/src/dv/dv.h
index 3063bc9178871d7b3b9bd7ba767f6254c1f1a214..c0a4828a20592a7f55fc05d9b68a9a9e2931bfd2 100644 (file)
--- a/src/dv/dv.h
+++ b/src/dv/dv.h
@@ -1,10 +1,10 @@
 /*
      This file is part of GNUnet.
 /*
      This file is part of GNUnet.

-     (C) 2001, 2002, 2003, 2004, 2009 Christian Grothoff (and other contributing authors)
+     (C) 2013 Christian Grothoff (and other contributing authors)

 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published

-     by the Free Software Foundation; either version 2, or (at your
+     by the Free Software Foundation; either version 3, or (at your

      option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
      option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but


@@ -20,97 +20,98 @@
 
 /**
  * @author Christian Grothoff
 
 /**
  * @author Christian Grothoff

- * @author NOT Nathan Evans

  * @file dv/dv.h
  * @file dv/dv.h

+ * @brief IPC messages between DV service and DV plugin

  */
 #ifndef DV_H
 #define DV_H
 
 #include "gnunet_common.h"
 
  */
 #ifndef DV_H
 #define DV_H
 
 #include "gnunet_common.h"
 

-#define DEBUG_DV GNUNET_YES
-#define DEBUG_DV_API GNUNET_YES
-
-typedef void (*GNUNET_DV_MessageReceivedHandler) (void *cls,
-                                                  struct GNUNET_PeerIdentity *sender,
-                                                  struct GNUNET_MessageHeader *msg,
-                                                  unsigned int distance,
-                                                  char *sender_address,
-                                                  size_t sender_address_len);
+GNUNET_NETWORK_STRUCT_BEGIN

 
 /**
 
 /**

- * DV Message, contains a message that was received
- * via DV for this peer!
- *
- * Sender address is copied to the end of this struct.
+ * DV service tells plugin about a DV-connection being
+ * now available.

  */
  */

-struct GNUNET_DV_MessageReceived
+struct GNUNET_DV_ConnectMessage

 {
   /**
 {
   /**

-   * Type:  GNUNET_MESSAGE_TYPE_TRANSPORT_DV_MESSAGE
+   * Type:  GNUNET_MESSAGE_TYPE_TRANSPORT_DV_CONNECT

    */
   struct GNUNET_MessageHeader header;
 
   /**
    */
   struct GNUNET_MessageHeader header;
 
   /**

-   * The sender of the message
+   * The distance to the peer that we are now connected to

    */
    */

-  struct GNUNET_PeerIdentity *sender;
+  uint32_t distance GNUNET_PACKED;

 
   /**
 
   /**

-   * The message that was sent
+   * The other peer (at the given distance).

    */
    */

-  struct GNUNET_MessageHeader *msg;
-
-  /**
-   * The distance to the peer that we received the message from
-   */
-  size_t distance;
-
-  /**
-   * Length of the sender address, appended to end of this message
-   */
-  size_t sender_address_len;
+  struct GNUNET_PeerIdentity peer;

 
 };
 
 
 /**
 
 };
 
 
 /**

- * DV Message, indicates that we have learned of a new DV level peer.
+ * DV service tells plugin about a DV-connection being
+ * no longer available.

  *
  *

- * Sender address is copied to the end of this struct.
+ * Sender address is copied to the end of this struct,
+ * followed by the actual message received.

  */
  */

-struct GNUNET_DV_ConnectMessage
+struct GNUNET_DV_DisconnectMessage

 {
   /**
 {
   /**

-   * Type:  GNUNET_MESSAGE_TYPE_TRANSPORT_DV_MESSAGE
+   * Type:  GNUNET_MESSAGE_TYPE_TRANSPORT_DV_DISCONNECT

    */
   struct GNUNET_MessageHeader header;
 
   /**
    */
   struct GNUNET_MessageHeader header;
 
   /**

-   * The sender of the message
+   * Always zero.

    */
    */

-  struct GNUNET_PeerIdentity *sender;
+  uint32_t reserved GNUNET_PACKED;

 
   /**
 
   /**

-   * The message that was sent
+   * The peer that is no longer available.
+   */
+  struct GNUNET_PeerIdentity peer;
+
+};
+
+
+/**
+ * DV Message, contains a message that was received via DV for this
+ * peer.  Send from the DV service to the DV plugin.
+ *
+ * Sender address is copied to the end of this struct,
+ * followed by the actual message received.
+ */
+struct GNUNET_DV_ReceivedMessage
+{
+  /**
+   * Type:  GNUNET_MESSAGE_TYPE_TRANSPORT_DV_RECV

    */
    */

-  struct GNUNET_MessageHeader *msg;
+  struct GNUNET_MessageHeader header;

 
   /**
    * The distance to the peer that we received the message from
    */
 
   /**
    * The distance to the peer that we received the message from
    */

-  size_t distance;
+  uint32_t distance GNUNET_PACKED;

 
   /**
 
   /**

-   * Length of the sender address, appended to end of this message
+   * The (actual) sender of the message

    */
    */

-  size_t sender_address_len;
+  struct GNUNET_PeerIdentity sender;

 
 

+  /* payload follows */

 };
 
 
 /**
 };
 
 
 /**

- * Message to send a message over DV via a specific peer
+ * Message from plugin to DV service, requesting a
+ * message to be routed.

  */
 struct GNUNET_DV_SendMessage
 {
  */
 struct GNUNET_DV_SendMessage
 {


@@ -120,46 +121,67 @@ struct GNUNET_DV_SendMessage
   struct GNUNET_MessageHeader header;
 
   /**
   struct GNUNET_MessageHeader header;
 
   /**

-   * Intended final recipient of this message
+   * Unique ID for this message, for confirm callback, must never be zero.
+   */
+  uint32_t uid GNUNET_PACKED;
+
+  /**
+   * The (actual) target of the message

    */
   struct GNUNET_PeerIdentity target;
 
    */
   struct GNUNET_PeerIdentity target;
 

+};
+
+
+/**
+ * Message from service to DV plugin, saying that a
+ * SEND request was handled.
+ */
+struct GNUNET_DV_AckMessage
+{

   /**
   /**

-   * The message(s) to be sent.
+   * Type: GNUNET_MESSAGE_TYPE_DV_SEND_ACK or
+   * GNUNET_MESSAGE_TYPE_DV_SEND_NACK.

    */
    */

-  char *msgbuf;
+  struct GNUNET_MessageHeader header;

 
   /**
 
   /**

-   * The size of the msgbuf
+   * Which message is being acknowledged?

    */
    */

-  size_t msgbuf_size;
+  uint32_t uid GNUNET_PACKED;

 
   /**
 
   /**

-   * Message priority
+   * The (actual) target of the message

    */
    */

-  size_t priority;
+  struct GNUNET_PeerIdentity target;
+
+};

 
 

+
+/**
+ * Message from service to DV plugin, saying that our
+ * distance to another peer changed.
+ */
+struct GNUNET_DV_DistanceUpdateMessage
+{

   /**
   /**

-   * How long can we delay sending?
+   * Type: GNUNET_MESSAGE_TYPE_DV_DISTANCE_CHANGED.

    */
    */

-  struct GNUNET_TIME_Relative timeout;
+  struct GNUNET_MessageHeader header;

 
   /**
 
   /**

-   * Size of the address (appended to end of struct)
+   * What is the new distance?

    */
    */

-  size_t addrlen;
+  uint32_t distance GNUNET_PACKED;

 
 

-  /*
-   * Sender, appended to end of struct tells via whom
-   * to send this message.
+  /**
+   * The peer for which the distance changed.

    */
    */

+  struct GNUNET_PeerIdentity peer;

 
 };
 
 
 };
 

-struct GNUNET_DV_Handle *
-GNUNET_DV_connect (struct GNUNET_SCHEDULER_Handle *sched,
-                  const struct GNUNET_CONFIGURATION_Handle *cfg,
-                  GNUNET_DV_MessageReceivedHandler receive_handler,
-                  void *receive_handler_cls);
+
+GNUNET_NETWORK_STRUCT_END

 
 #endif
 
 #endif