(no commit message)

[oweals/gnunet.git] / src / include / gnunet_bandwidth_lib.h

diff --git a/src/include/gnunet_bandwidth_lib.h b/src/include/gnunet_bandwidth_lib.h
index 2dbe6e5624283761df0f543c1ad95f365c50e4b4..75f71b32c9b7111b7eb32fd2d0cef17549635345 100644 (file)
--- a/src/include/gnunet_bandwidth_lib.h
+++ b/src/include/gnunet_bandwidth_lib.h
@@ -21,7 +21,6 @@
 /**
  * @file include/gnunet_bandwidth_lib.h
  * @brief functions related to bandwidth (unit)
- *
  * @author Christian Grothoff
  */
 
@@ -63,7 +62,7 @@ struct GNUNET_BANDWIDTH_Tracker
   /**
    * Number of bytes consumed since we last updated the tracker.
    */
-  uint64_t consumption_since_last_update__;
+  int64_t consumption_since_last_update__;
 
   /**
    * Time when we last updated the tracker.
@@ -94,6 +93,41 @@ struct GNUNET_BANDWIDTH_Value32NBO
 GNUNET_BANDWIDTH_value_init (uint32_t bytes_per_second);
 
 
+/**
+ * Maximum possible bandwidth value.
+ */
+#define GNUNET_BANDWIDTH_VALUE_MAX GNUNET_BANDWIDTH_value_init(UINT32_MAX)
+
+
+/**
+ * At the given bandwidth, calculate how much traffic will be
+ * available until the given deadline.
+ *
+ * @param bps bandwidth
+ * @param deadline when is the deadline
+ * @return number of bytes available at bps until deadline
+ */
+uint64_t
+GNUNET_BANDWIDTH_value_get_available_until (struct GNUNET_BANDWIDTH_Value32NBO
+                                            bps,
+                                            struct GNUNET_TIME_Relative
+                                            deadline);
+
+
+/**
+ * At the given bandwidth, calculate how long it would take for
+ * 'size' bytes to be transmitted.
+ *
+ * @param bps bandwidth
+ * @param size number of bytes we want to have available
+ * @return how long it would take
+ */
+struct GNUNET_TIME_Relative
+GNUNET_BANDWIDTH_value_get_delay_for (struct GNUNET_BANDWIDTH_Value32NBO bps,
+                                      uint64_t size);
+
+
+
 /**
  * Compute the MIN of two bandwidth values.
  *
@@ -103,7 +137,7 @@ GNUNET_BANDWIDTH_value_init (uint32_t bytes_per_second);
  */
 struct GNUNET_BANDWIDTH_Value32NBO
 GNUNET_BANDWIDTH_value_min (struct GNUNET_BANDWIDTH_Value32NBO b1,
-                           struct GNUNET_BANDWIDTH_Value32NBO b2);
+                            struct GNUNET_BANDWIDTH_Value32NBO b2);
 
 
 /**
@@ -122,8 +156,8 @@ GNUNET_BANDWIDTH_value_min (struct GNUNET_BANDWIDTH_Value32NBO b1,
  */
 void
 GNUNET_BANDWIDTH_tracker_init (struct GNUNET_BANDWIDTH_Tracker *av,
-                              struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit,
-                              uint32_t max_carry_s);
+                               struct GNUNET_BANDWIDTH_Value32NBO
+                               bytes_per_second_limit, uint32_t max_carry_s);
 
 
 /**
@@ -135,10 +169,11 @@ GNUNET_BANDWIDTH_tracker_init (struct GNUNET_BANDWIDTH_Tracker *av,
  *
  * @param av tracker to update
  * @param size number of bytes consumed
+ * @return GNUNET_YES if this consumption is above the limit
  */
-void
+int
 GNUNET_BANDWIDTH_tracker_consume (struct GNUNET_BANDWIDTH_Tracker *av,
-                                 size_t size);
+                                  ssize_t size);
 
 
 /**
@@ -152,7 +187,18 @@ GNUNET_BANDWIDTH_tracker_consume (struct GNUNET_BANDWIDTH_Tracker *av,
  */
 struct GNUNET_TIME_Relative
 GNUNET_BANDWIDTH_tracker_get_delay (struct GNUNET_BANDWIDTH_Tracker *av,
-                                   size_t size);
+                                    size_t size);
+
+
+/**
+ * Compute how many bytes are available for consumption right now.
+ * quota.
+ *
+ * @param av tracker to query
+ * @return number of bytes available for consumption right now
+ */
+int64_t
+GNUNET_BANDWIDTH_tracker_get_available (struct GNUNET_BANDWIDTH_Tracker *av);
 
 
 /**
@@ -163,7 +209,8 @@ GNUNET_BANDWIDTH_tracker_get_delay (struct GNUNET_BANDWIDTH_Tracker *av,
  */
 void
 GNUNET_BANDWIDTH_tracker_update_quota (struct GNUNET_BANDWIDTH_Tracker *av,
-                                      struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit);
+                                       struct GNUNET_BANDWIDTH_Value32NBO
+                                       bytes_per_second_limit);
 
 
 #if 0                           /* keep Emacsens' auto-indent happy */