doxygen, new define
authorChristian Grothoff <christian@grothoff.org>
Tue, 3 Feb 2015 17:40:54 +0000 (17:40 +0000)
committerChristian Grothoff <christian@grothoff.org>
Tue, 3 Feb 2015 17:40:54 +0000 (17:40 +0000)
src/include/gnunet_ats_service.h
src/include/gnunet_bandwidth_lib.h

index 88d08fb72e16cc944b53b1623399008233c08639..88df7d0da26ab647406d60f9acce698ea734b76d 100644 (file)
@@ -439,12 +439,14 @@ struct Session;
  * and address preferences as determined by ATS.
  *
  * @param cls closure
- * @param address suggested address (including peer identity of the peer)
+ * @param peer for which we suggest an address, NULL if ATS connection died
+ * @param address suggested address (including peer identity of the peer),
+ *             may be NULL to signal disconnect from peer
  * @param session session to use, NULL to establish a new outgoing session
  * @param bandwidth_out assigned outbound bandwidth for the connection,
- *        0 to disconnect
+ *        0 to signal disconnect
  * @param bandwidth_in assigned inbound bandwidth for the connection,
- *        0 to disconnect
+ *        0 to signal disconnect
  */
 typedef void
 (*GNUNET_ATS_AddressSuggestionCallback) (void *cls,
index ad8f3a2b9c1f4c81e0e7af52305099f06134e8ac..bbad562dc70e464944df028b8b8c9aa6f42f0230 100644 (file)
@@ -134,6 +134,12 @@ struct GNUNET_BANDWIDTH_Tracker
 };
 
 
+/**
+ * Convenience definition to use for 0-bandwidth.
+ */
+#define GNUNET_BANDWIDTH_ZERO GNUNET_BANDWIDTH_value_init (0)
+
+
 /**
  * Create a new bandwidth value.
  *