-skeletons for transport-ng
[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
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., 51 Franklin Street, Fifth Floor,
18      Boston, MA 02110-1301, 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  * Handle 'reservation request' messages from clients.
48  *
49  * @param cls unused, NULL
50  * @param client client that sent the request
51  * @param message the request message
52  */
53 void
54 GAS_handle_reservation_request (void *cls,
55                                 struct GNUNET_SERVER_Client *client,
56                                 const struct GNUNET_MessageHeader *message);
57
58
59 /**
60  * Initialize reservations subsystem.
61  *
62  * @param server handle to our server
63  */
64 void
65 GAS_reservations_init (struct GNUNET_SERVER_Handle *server);
66
67
68 /**
69  * Shutdown reservations subsystem.
70  */
71 void
72 GAS_reservations_done (void);
73
74 #endif