Check that you are not present in trail twice
[oweals/gnunet.git] / src / transport / transport.h
index cbbefb7e183d8b1b7f9722ae80811bbb11ee7b6a..40349c57c8e6087b10d4993060f122734fdc0e3d 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2009 Christian Grothoff (and other contributing authors)
+     (C) 2009-2014 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
  * @param bandwidth_out outbound bandwidth in NBO
  *
  */
+typedef void
+(*NotifyConnect) (void *cls,
+                  const struct GNUNET_PeerIdentity *peer,
+                  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
+                  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
 
-typedef void (*NotifyConnect) (void *cls,
-                              const struct GNUNET_PeerIdentity *peer,
-                              struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
-                              struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
 
 GNUNET_NETWORK_STRUCT_BEGIN
 
@@ -89,7 +90,7 @@ struct StartMessage
 {
 
   /**
-   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_START
+   * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_START
    */
   struct GNUNET_MessageHeader header;
 
@@ -117,7 +118,7 @@ struct ConnectInfoMessage
 {
 
   /**
-   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
+   * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
    */
   struct GNUNET_MessageHeader header;
 
@@ -146,7 +147,7 @@ struct DisconnectInfoMessage
 {
 
   /**
-   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
+   * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
    */
   struct GNUNET_MessageHeader header;
 
@@ -176,7 +177,7 @@ struct TransportRequestConnectMessage
   struct GNUNET_MessageHeader header;
 
   /**
-   * Connect (GNUNET_YES) or connect (GNUNET_NO).
+   * Connect (#GNUNET_YES) or connect (#GNUNET_NO).
    */
   uint32_t connect;
 
@@ -195,7 +196,7 @@ struct QuotaSetMessage
 {
 
   /**
-   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
+   * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
    */
   struct GNUNET_MessageHeader header;
 
@@ -220,7 +221,7 @@ struct InboundMessage
 {
 
   /**
-   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
+   * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
    */
   struct GNUNET_MessageHeader header;
 
@@ -240,19 +241,18 @@ struct SendOkMessage
 {
 
   /**
-   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
+   * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
    */
   struct GNUNET_MessageHeader header;
 
   /**
-   * GNUNET_OK if the transmission succeeded,
-   * GNUNET_SYSERR if it failed (i.e. network disconnect);
+   * #GNUNET_OK if the transmission succeeded,
+   * #GNUNET_SYSERR if it failed (i.e. network disconnect);
    * in either case, it is now OK for this client to
    * send us another message for the given peer.
    */
   uint32_t success GNUNET_PACKED;
 
-
   /**
    * Size of message sent
    */
@@ -416,17 +416,20 @@ struct ValidationIterateResponseMessage
   uint32_t state GNUNET_PACKED;
 
   /**
-   * FIXME
+   * At what time did we successfully validate the address last.
+   * Will be NEVER if the address failed validation.
    */
   struct GNUNET_TIME_AbsoluteNBO last_validation;
 
   /**
-   * FIXME
+   * Until when is the address believed to be valid.
+   * Will be ZERO if the address is not belived to be valid.
    */
   struct GNUNET_TIME_AbsoluteNBO valid_until;
 
   /**
-   * FIXME
+   * When will we next try to validate the address (typically
+   * done before @e valid_until happens).
    */
   struct GNUNET_TIME_AbsoluteNBO next_validation;
 };