2 This file is part of GNUnet.
3 (C) 2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file ats/gnunet-service-ats_scheduling.h
23 * @brief ats service, interaction with 'scheduling' API
24 * @author Matthias Wachs
25 * @author Christian Grothoff
27 #ifndef GNUNET_SERVICE_ATS_SCHEDULING_H
28 #define GNUNET_SERVICE_ATS_SCHEDULING_H
30 #include "gnunet_util_lib.h"
34 * Register a new scheduling client.
36 * @param client handle of the new client
37 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
40 GAS_scheduling_add_client (struct GNUNET_SERVER_Client *client);
44 * Unregister a client (which may have been a scheduling client,
45 * but this is not assured).
47 * @param client handle of the (now dead) client
50 GAS_scheduling_remove_client (struct GNUNET_SERVER_Client *client);
54 * Handle 'reset backoff' messages from clients.
56 * @param cls unused, NULL
57 * @param client client that sent the request
58 * @param message the request message
61 GAS_handle_reset_backoff (void *cls,
62 struct GNUNET_SERVER_Client *client,
63 const struct GNUNET_MessageHeader *message);
67 * Transmit the given address suggestion and bandwidth update to all scheduling
70 * @param peer peer for which this is an address suggestion
71 * @param session_id session ID to use
72 * @param bandwidth_out assigned outbound bandwidth
73 * @param bandwidth_in assigned inbound bandwidth
76 GAS_scheduling_transmit_address_suggestion (const struct GNUNET_PeerIdentity *peer,
78 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
79 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
83 * Handle 'request address' messages from clients.
85 * @param cls unused, NULL
86 * @param client client that sent the request
87 * @param message the request message
90 GAS_handle_request_address (void *cls,
91 struct GNUNET_SERVER_Client *client,
92 const struct GNUNET_MessageHeader *message);
96 * Cancel 'request address' messages from clients.
98 * @param cls unused, NULL
99 * @param client client that sent the request
100 * @param message the request message
103 GAS_handle_request_address_cancel (void *cls,
104 struct GNUNET_SERVER_Client *client,
105 const struct GNUNET_MessageHeader *message);
109 * Handle 'address add' messages from clients.
111 * @param cls unused, NULL
112 * @param client client that sent the request
113 * @param message the request message
116 GAS_handle_address_add (void *cls,
117 struct GNUNET_SERVER_Client *client,
118 const struct GNUNET_MessageHeader *message);
122 * Handle 'address update' messages from clients.
124 * @param cls unused, NULL
125 * @param client client that sent the request
126 * @param message the request message
129 GAS_handle_address_update (void *cls,
130 struct GNUNET_SERVER_Client *client,
131 const struct GNUNET_MessageHeader *message);
135 * Handle 'address in use' messages from clients.
137 * @param cls unused, NULL
138 * @param client client that sent the request
139 * @param message the request message
142 GAS_handle_address_in_use (void *cls,
143 struct GNUNET_SERVER_Client *client,
144 const struct GNUNET_MessageHeader *message);
148 * Handle 'address destroyed' messages from clients.
150 * @param cls unused, NULL
151 * @param client client that sent the request
152 * @param message the request message
155 GAS_handle_address_destroyed (void *cls,
156 struct GNUNET_SERVER_Client *client,
157 const struct GNUNET_MessageHeader *message);
161 * Initialize scheduling subsystem.
163 * @param server handle to our server
164 * @param ah the address handle to use
167 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server,
168 struct GAS_Addresses_Handle *ah);
172 * Shutdown scheduling subsystem.
175 GAS_scheduling_done (void);
179 /* end of gnunet-service-ats_scheduling.h */