complete reservations API
[oweals/gnunet.git] / src / ats / gnunet-service-ats_reservations.c
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.c
23  * @brief ats service, inbound bandwidth reservation management
24  * @author Christian Grothoff
25  */
26 #include "platform.h"
27 #include "gnunet-service-ats_reservations.h"
28
29
30 /**
31  * Reserve the given amount of incoming bandwidth (in bytes) from the
32  * given peer.  If a reservation is not possible right now, return how
33  * long the client should wait before trying again.
34  *
35  * @param peer peer to reserve bandwidth from
36  * @param amount number of bytes to reserve
37  * @return 0 if the reservation was successful, FOREVER if the
38  *         peer is not connected, otherwise the time to wait
39  *         until the reservation might succeed
40  */
41 struct GNUNET_TIME_Relative
42 GAS_reservations_reserve (const struct GNUNET_PeerIdentity *peer,
43                           int32_t amount)
44 {
45   /* FIXME: implement... */
46   /* permit all reservations instantly for now */
47   return GNUNET_TIME_UNIT_ZERO;
48 }
49
50
51 /**
52  * Set the amount of bandwidth the other peer could currently transmit
53  * to us (as far as we know) to the given value.
54  * 
55  * @param peer identity of the peer
56  * @param bandwidth_in currently available bandwidth from that peer to
57  *        this peer (estimate)
58  */
59 void
60 GAS_reservations_set_bandwidth (const struct GNUNET_PeerIdentity *peer,
61                                 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
62 {
63 }
64
65
66
67 /**
68  * Initialize reservations subsystem.
69  */
70 void
71 GAS_reservations_init ()
72 {
73 }
74
75
76 /**
77  * Shutdown reservations subsystem.
78  */
79 void
80 GAS_reservations_done ()
81 {
82 }
83
84
85
86 /* end of gnunet-service-ats_reservations.c */