src/ats/gnunet-service-ats_reservations.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file ats/gnunet-service-ats_reservations.h
  23  * @brief ats service, inbound bandwidth reservation management
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_SERVICE_ATS_RESERVATIONS_H
  27 #define GNUNET_SERVICE_ATS_RESERVATIONS_H
  28
  29 #include "gnunet_util_lib.h"
  30
  31
  32 /**
  33  * Set the amount of bandwidth the other peer could currently transmit
  34  * to us (as far as we know) to the given value.
  35  *
  36  * @param peer identity of the peer
  37  * @param bandwidth_in currently available bandwidth from that peer to
  38  *        this peer (estimate)
  39  */
  40 void
  41 GAS_reservations_set_bandwidth (const struct GNUNET_PeerIdentity *peer,
  42                                 struct GNUNET_BANDWIDTH_Value32NBO
  43                                 bandwidth_in);
  44
  45
  46 /**
  47  * Reserve the given amount of incoming bandwidth (in bytes) from the
  48  * given peer.  If a reservation is not possible right now, return how
  49  * long the client should wait before trying again.
  50  *
  51  * @param peer peer to reserve bandwidth from
  52  * @param amount number of bytes to reserve
  53  * @return 0 if the reservation was successful, FOREVER if the
  54  *         peer is not connected, otherwise the time to wait
  55  *         until the reservation might succeed
  56  */
  57 struct GNUNET_TIME_Relative
  58 GAS_reservations_reserve (const struct GNUNET_PeerIdentity *peer,
  59                           int32_t amount);
  60
  61
  62 /**
  63  * Initialize reservations subsystem.
  64  */
  65 void
  66 GAS_reservations_init (void);
  67
  68
  69 /**
  70  * Shutdown reservations subsystem.
  71  */
  72 void
  73 GAS_reservations_done (void);
  74
  75 #endif