gnunetutil: add 2d and 3d allocation including tests

[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 2dde8b226c951238f5767fea3c5072263ca8e1c1..178ddaaacaacb0026b61c00aae49b1d10dfc44ae 100644 (file)
--- a/src/include/gnunet_bandwidth_lib.h
+++ b/src/include/gnunet_bandwidth_lib.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2010 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2010 GNUnet e.V.
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,14 +14,19 @@
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
- * @file include/gnunet_bandwidth_lib.h
- * @brief functions related to bandwidth (unit)
  * @author Christian Grothoff
+ *
+ * @file
+ * Functions related to bandwidth (unit)
+ *
+ * @defgroup bandwidth  Bandwidth library
+ * Functions related to bandwidth (unit)
+ * @{
  */
 
 #ifndef GNUNET_BANDWIDTH_LIB_H
@@ -113,7 +118,7 @@ struct GNUNET_BANDWIDTH_Tracker
    * Task scheduled to call the @e excess_cb once we have
    * reached the maximum bandwidth the tracker can hold.
    */
-  GNUNET_SCHEDULER_TaskIdentifier excess_task;
+  struct GNUNET_SCHEDULER_Task *excess_task;
 
   /**
    * Time when we last updated the tracker.
@@ -121,7 +126,7 @@ struct GNUNET_BANDWIDTH_Tracker
   struct GNUNET_TIME_Absolute last_update__;
 
   /**
-   * Bandwidth limit to enforce in bytes per s.
+   * Bandwidth limit to enforce in bytes per second.
    */
   uint32_t available_bytes_per_s__;
 
@@ -134,6 +139,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.
  *
@@ -188,18 +199,30 @@ GNUNET_BANDWIDTH_value_min (struct GNUNET_BANDWIDTH_Value32NBO b1,
                             struct GNUNET_BANDWIDTH_Value32NBO b2);
 
 
+/**
+ * Compute the MAX of two bandwidth values.
+ *
+ * @param b1 first value
+ * @param b2 second value
+ * @return the min of b1 and b2
+ */
+struct GNUNET_BANDWIDTH_Value32NBO
+GNUNET_BANDWIDTH_value_max (struct GNUNET_BANDWIDTH_Value32NBO b1,
+                            struct GNUNET_BANDWIDTH_Value32NBO b2);
+
+
 /**
  * Initialize bandwidth tracker.  Note that in addition to the
  * 'max_carry_s' limit, we also always allow at least
- * GNUNET_SERVER_MAX_MESSAGE_SIZE to accumulate.  So if the
+ * #GNUNET_SERVER_MAX_MESSAGE_SIZE to accumulate.  So if the
  * bytes-per-second limit is so small that within 'max_carry_s' not
- * even GNUNET_SERVER_MAX_MESSAGE_SIZE is allowed to accumulate, it is
- * ignored and replaced by GNUNET_SERVER_MAX_MESSAGE_SIZE (which is in
+ * even #GNUNET_SERVER_MAX_MESSAGE_SIZE is allowed to accumulate, it is
+ * ignored and replaced by #GNUNET_SERVER_MAX_MESSAGE_SIZE (which is in
  * bytes).
  *
  * @param av tracker to initialize
  * @param update_cb callback to notify a client about the tracker being updated
- * @param update_cb_cls cls for the callback
+ * @param update_cb_cls cls for the @a update_cb callback
  * @param bytes_per_second_limit initial limit to assume
  * @param max_carry_s maximum number of seconds unused bandwidth
  *        may accumulate before it expires
@@ -240,16 +263,25 @@ GNUNET_BANDWIDTH_tracker_init2 (struct GNUNET_BANDWIDTH_Tracker *av,
                                 void *excess_cb_cls);
 
 
+/**
+ * Stop notifying about tracker updates and excess notifications
+ *
+ * @param av the respective trackers
+ */
+void
+GNUNET_BANDWIDTH_tracker_notification_stop (struct GNUNET_BANDWIDTH_Tracker *av);
+
+
 /**
  * Notify the tracker that a certain number of bytes of bandwidth have
  * been consumed.  Note that it is legal to consume bytes even if not
  * enough bandwidth is available (in that case,
- * GNUNET_BANDWIDTH_tracker_get_delay may return non-zero delay values
+ * #GNUNET_BANDWIDTH_tracker_get_delay() may return non-zero delay values
  * even for a size of zero for a while).
  *
  * @param av tracker to update
  * @param size number of bytes consumed
- * @return GNUNET_YES if this consumption is above the limit
+ * @return #GNUNET_YES if this consumption is above the limit
  */
 int
 GNUNET_BANDWIDTH_tracker_consume (struct GNUNET_BANDWIDTH_Tracker *av,
@@ -257,7 +289,7 @@ GNUNET_BANDWIDTH_tracker_consume (struct GNUNET_BANDWIDTH_Tracker *av,
 
 
 /**
- * Compute how long we should wait until consuming 'size'
+ * Compute how long we should wait until consuming @a size
  * bytes of bandwidth in order to stay within the given
  * quota.
  *
@@ -302,4 +334,7 @@ GNUNET_BANDWIDTH_tracker_update_quota (struct GNUNET_BANDWIDTH_Tracker *av,
 
 /* ifndef GNUNET_BANDWIDTH_LIB_H */
 #endif
+
+/** @} */  /* end of group */
+
 /* end of gnunet_bandwidth_lib.h */