gnunet_bandwidth_lib.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2010 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#if !defined (__GNUNET_UTIL_LIB_H_INSIDE__)
#error "Only <gnunet_util_lib.h> can be included directly."
#endif
 
#ifndef GNUNET_BANDWIDTH_LIB_H
#define GNUNET_BANDWIDTH_LIB_H
 
#ifdef __cplusplus
extern "C" {
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
#include "gnunet_time_lib.h"
 
GNUNET_NETWORK_STRUCT_BEGIN
 
struct GNUNET_BANDWIDTH_Value32NBO
{
  uint32_t value__ GNUNET_PACKED;
};
 
GNUNET_NETWORK_STRUCT_END
 
 
typedef void (*GNUNET_BANDWIDTH_TrackerUpdateCallback) (void *cls);
 
 
typedef void (*GNUNET_BANDWIDTH_ExcessNotificationCallback) (void *cls);
 
 
struct GNUNET_BANDWIDTH_Tracker
{
  void *update_cb_cls;
 
  GNUNET_BANDWIDTH_TrackerUpdateCallback update_cb;
 
  void *excess_cb_cls;
 
  GNUNET_BANDWIDTH_ExcessNotificationCallback excess_cb;
 
  int64_t consumption_since_last_update__;
 
  struct GNUNET_SCHEDULER_Task *excess_task;
 
  struct GNUNET_TIME_Absolute last_update__;
 
  uint32_t available_bytes_per_s__;
 
  uint32_t max_carry_s__;
};
 
 
#define GNUNET_BANDWIDTH_ZERO GNUNET_BANDWIDTH_value_init (0)
 
 
struct GNUNET_BANDWIDTH_Value32NBO
GNUNET_BANDWIDTH_value_init (uint32_t bytes_per_second);
 
 
#define GNUNET_BANDWIDTH_VALUE_MAX GNUNET_BANDWIDTH_value_init (UINT32_MAX)
 
 
uint64_t
GNUNET_BANDWIDTH_value_get_available_until (
  struct GNUNET_BANDWIDTH_Value32NBO bps,
  struct GNUNET_TIME_Relative deadline);
 
 
struct GNUNET_TIME_Relative
GNUNET_BANDWIDTH_value_get_delay_for (struct GNUNET_BANDWIDTH_Value32NBO bps,
                                      uint64_t size);
 
 
struct GNUNET_BANDWIDTH_Value32NBO
GNUNET_BANDWIDTH_value_min (struct GNUNET_BANDWIDTH_Value32NBO b1,
                            struct GNUNET_BANDWIDTH_Value32NBO b2);
 
 
struct GNUNET_BANDWIDTH_Value32NBO
GNUNET_BANDWIDTH_value_max (struct GNUNET_BANDWIDTH_Value32NBO b1,
                            struct GNUNET_BANDWIDTH_Value32NBO b2);
 
 
struct GNUNET_BANDWIDTH_Value32NBO
GNUNET_BANDWIDTH_value_sum (struct GNUNET_BANDWIDTH_Value32NBO b1,
                            struct GNUNET_BANDWIDTH_Value32NBO b2);
 
 
void
GNUNET_BANDWIDTH_tracker_init (
  struct GNUNET_BANDWIDTH_Tracker *av,
  GNUNET_BANDWIDTH_TrackerUpdateCallback update_cb,
  void *update_cb_cls,
  struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit,
  uint32_t max_carry_s);
 
 
void
GNUNET_BANDWIDTH_tracker_init2 (
  struct GNUNET_BANDWIDTH_Tracker *av,
  GNUNET_BANDWIDTH_TrackerUpdateCallback update_cb,
  void *update_cb_cls,
  struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit,
  uint32_t max_carry_s,
  GNUNET_BANDWIDTH_ExcessNotificationCallback excess_cb,
  void *excess_cb_cls);
 
 
void
GNUNET_BANDWIDTH_tracker_notification_stop (
  struct GNUNET_BANDWIDTH_Tracker *av);
 
 
int
GNUNET_BANDWIDTH_tracker_consume (struct GNUNET_BANDWIDTH_Tracker *av,
                                  ssize_t size);
 
 
struct GNUNET_TIME_Relative
GNUNET_BANDWIDTH_tracker_get_delay (struct GNUNET_BANDWIDTH_Tracker *av,
                                    size_t size);
 
 
int64_t
GNUNET_BANDWIDTH_tracker_get_available (struct GNUNET_BANDWIDTH_Tracker *av);
 
 
void
GNUNET_BANDWIDTH_tracker_update_quota (
  struct GNUNET_BANDWIDTH_Tracker *av,
  struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit);
 
 
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
/* ifndef GNUNET_BANDWIDTH_LIB_H */
#endif
 /* end of group */
 /* end of group addition */
 
/* end of gnunet_bandwidth_lib.h */