Merge branch 'master' of 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      SPDX-License-Identifier: AGPL3.0-or-later
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 #include "ats.h"
31
32
33 /**
34  * Set the amount of bandwidth the other peer could currently transmit
35  * to us (as far as we know) to the given value.
36  *
37  * @param peer identity of the peer
38  * @param bandwidth_in currently available bandwidth from that peer to
39  *        this peer (estimate)
40  */
41 void
42 GAS_reservations_set_bandwidth (const struct GNUNET_PeerIdentity *peer,
43                                 struct GNUNET_BANDWIDTH_Value32NBO
44                                 bandwidth_in);
45
46
47 /**
48  * Handle 'reservation request' messages from clients.
49  *
50  * @param client client that sent the request
51  * @param message the request message
52  */
53 void
54 GAS_handle_reservation_request (struct GNUNET_SERVICE_Client *client,
55                                 const struct
56                                 ReservationRequestMessage *message);
57
58
59 /**
60  * Initialize reservations subsystem.
61  *
62  * @param server handle to our server
63  */
64 void
65 GAS_reservations_init (void);
66
67
68 /**
69  * Shutdown reservations subsystem.
70  */
71 void
72 GAS_reservations_done (void);
73
74 #endif