Merge branch 'master' of ssh://gnunet.org/gnunet
[oweals/gnunet.git] / src / ats / gnunet-service-ats_reservations.h
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2011 GNUnet e.V.
4
5      GNUnet is free software: you can redistribute it and/or modify it
6      under the terms of the GNU Affero General Public License as published
7      by the Free Software Foundation, either version 3 of the License,
8      or (at your 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      Affero General Public License for more details.
14     
15      You should have received a copy of the GNU Affero General Public License
16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 /**
20  * @file ats/gnunet-service-ats_reservations.h
21  * @brief ats service, inbound bandwidth reservation management
22  * @author Christian Grothoff
23  */
24 #ifndef GNUNET_SERVICE_ATS_RESERVATIONS_H
25 #define GNUNET_SERVICE_ATS_RESERVATIONS_H
26
27 #include "gnunet_util_lib.h"
28 #include "ats.h"
29
30
31 /**
32  * Set the amount of bandwidth the other peer could currently transmit
33  * to us (as far as we know) to the given value.
34  *
35  * @param peer identity of the peer
36  * @param bandwidth_in currently available bandwidth from that peer to
37  *        this peer (estimate)
38  */
39 void
40 GAS_reservations_set_bandwidth (const struct GNUNET_PeerIdentity *peer,
41                                 struct GNUNET_BANDWIDTH_Value32NBO
42                                 bandwidth_in);
43
44
45 /**
46  * Handle 'reservation request' messages from clients.
47  *
48  * @param client client that sent the request
49  * @param message the request message
50  */
51 void
52 GAS_handle_reservation_request (struct GNUNET_SERVICE_Client *client,
53                                 const struct ReservationRequestMessage *message);
54
55
56 /**
57  * Initialize reservations subsystem.
58  *
59  * @param server handle to our server
60  */
61 void
62 GAS_reservations_init (void);
63
64
65 /**
66  * Shutdown reservations subsystem.
67  */
68 void
69 GAS_reservations_done (void);
70
71 #endif