(no commit message)
[oweals/gnunet.git] / src / transport / transport.h
index fed4bf162b6bdc4bcf0e444e742a1d35ba524999..237f3158139055e986bdee8bb50d8ba7fd4706cb 100644 (file)
@@ -4,7 +4,7 @@
 
      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
  * @brief common internal definitions for transport service
  * @author Christian Grothoff
  */
+#ifndef TRANSPORT_H
+#define TRANSPORT_H
+
 #include "gnunet_crypto_lib.h"
 #include "gnunet_time_lib.h"
 #include "gnunet_transport_service.h"
 
 #define DEBUG_TRANSPORT GNUNET_NO
+#define DEBUG_TRANSPORT_TIMEOUT GNUNET_NO
+#define DEBUG_TRANSPORT_DISCONNECT GNUNET_NO
 
 /**
  * For how long do we allow unused bandwidth
- * from the past to carry over into the future? (in ms)
+ * from the past to carry over into the future? (in seconds)
  */
-#define MAX_BANDWIDTH_CARRY 5000
+#define MAX_BANDWIDTH_CARRY_S 5
 
 /**
  * How often do we (at most) do a full quota
  */
 #define MIN_QUOTA_REFRESH_TIME 2000
 
+/**
+ * Message from the transport service to the library
+ * asking to check if both processes agree about this
+ * peers identity.
+ */
+struct StartMessage
+{
+
+  /**
+   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_START
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Should the 'self' field be checked?
+   */
+  uint32_t do_check;
+
+  /**
+   * Identity we think we have.  If it does not match, the
+   * receiver should print out an error message and disconnect.
+   */
+  struct GNUNET_PeerIdentity self;
+
+};
+
+
 /**
  * Message from the transport service to the library
  * informing about neighbors.
@@ -54,10 +86,9 @@ struct ConnectInfoMessage
   struct GNUNET_MessageHeader header;
 
   /**
-   * Current quota for outbound traffic in bytes/ms.
-   * (should be equal to system default)
+   * Transport distance metric (i.e. hops for DV)
    */
-  uint32_t quota_out GNUNET_PACKED;
+  uint32_t distance;
 
   /**
    * Latency estimate.
@@ -96,58 +127,51 @@ struct DisconnectInfoMessage
 
 };
 
-
 /**
- * Message used to set a particular bandwidth quota.  Send
- * TO the service to set an incoming quota, send FROM the
- * service to update an outgoing quota.
+ * Message type for sending a request connect message
+ * to the transport service.  Must be done before transport
+ * api will allow messages to be queued/sent to transport
+ * service for transmission to a peer.
  */
-struct QuotaSetMessage
+struct TransportRequestConnectMessage
 {
-
   /**
-   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_NEIGHBOUR_INFO
+   *  Message header
    */
   struct GNUNET_MessageHeader header;
 
   /**
-   * Quota in bytes per ms, 0 to drop everything;
-   * in network byte order.
-   */
-  uint32_t quota_in GNUNET_PACKED;
-
-  /**
-   * About which peer are we talking here?
+   * Identity of the peer we would like to connect to.
    */
   struct GNUNET_PeerIdentity peer;
-
 };
 
-
 /**
- * Message used to ask the transport service to connect
- * to a particular peer.
+ * Message used to set a particular bandwidth quota.  Send TO the
+ * service to set an incoming quota, send FROM the service to update
+ * an outgoing quota.
  */
-struct TryConnectMessage
+struct QuotaSetMessage
 {
 
   /**
-   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_TRY_CONNECT.
+   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_NEIGHBOUR_INFO
    */
   struct GNUNET_MessageHeader header;
 
   /**
-   * Always zero.
+   * Quota.
    */
-  uint32_t reserved GNUNET_PACKED;
+  struct GNUNET_BANDWIDTH_Value32NBO quota;
 
   /**
    * About which peer are we talking here?
-  */
+   */
   struct GNUNET_PeerIdentity peer;
 
 };
 
+
 /**
  * Message used to notify the transport API about a message
  * received from the network.  The actual message follows.
@@ -175,6 +199,11 @@ struct InboundMessage
    */
   struct GNUNET_PeerIdentity peer;
 
+  /**
+   * Distance metric.
+   */
+  uint32_t distance;
+
 };
 
 
@@ -198,6 +227,11 @@ struct SendOkMessage
    */
   uint32_t success GNUNET_PACKED;
 
+  /**
+   * Latency estimate.
+   */
+  struct GNUNET_TIME_RelativeNBO latency;
+
   /**
    * Which peer can send more now?
    */
@@ -223,6 +257,11 @@ struct OutboundMessage
    */
   uint32_t priority GNUNET_PACKED;
 
+  /**
+   * Allowed delay.
+   */
+  struct GNUNET_TIME_RelativeNBO timeout;
+
   /**
    * Which peer should receive the message?
    */
@@ -231,8 +270,6 @@ struct OutboundMessage
 };
 
 
-
-
 /**
  * Message from the library to the transport service
  * asking for converting a transport address to a
@@ -246,10 +283,16 @@ struct AddressLookupMessage
    */
   struct GNUNET_MessageHeader header;
 
+  /**
+   * Should the conversion use numeric IP addresses (otherwise
+   * a reverse DNS lookup is OK -- if applicable).
+   */
+  int32_t numeric_only GNUNET_PACKED;
+
   /**
    * timeout to give up.
    */
-  struct GNUNET_TIME_AbosluteNBO tiemout;
+  struct GNUNET_TIME_AbsoluteNBO timeout;
 
   /**
    * Length of the (binary) address in bytes, in big-endian.
@@ -261,4 +304,33 @@ struct AddressLookupMessage
 };
 
 
+
+/**
+ * Change in blacklisting (either request or notification,
+ * depending on which direction it is going).
+ */
+struct BlacklistMessage
+{
+
+  /**
+   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
+   * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed)
+   * for the response.
+   */
+  uint32_t is_allowed GNUNET_PACKED;
+
+  /**
+   * Which peer is being blacklisted or queried?
+   */
+  struct GNUNET_PeerIdentity peer;
+
+};
+
+
 /* end of transport.h */
+#endif