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 plugin_name 0-termintated string specifying the transport plugin
72 * @param plugin_addr binary address for the plugin to use
73 * @param plugin_addr_len number of bytes in plugin_addr
74 * @param session_id session ID to use
75 * @param local_address_info the local address for the address
76 * @param atsi performance data for the address
77 * @param atsi_count number of performance records in 'ats'
78 * @param bandwidth_out assigned outbound bandwidth
79 * @param bandwidth_in assigned inbound bandwidth
82 GAS_scheduling_transmit_address_suggestion (const struct GNUNET_PeerIdentity
84 const char *plugin_name,
85 const void *plugin_addr,
86 size_t plugin_addr_len,
87 uint32_t local_address_info,
89 const struct GNUNET_ATS_Information *atsi,
91 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
92 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
96 * Handle '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 (void *cls, struct GNUNET_SERVER_Client *client,
104 const struct GNUNET_MessageHeader *message);
108 * Cancel 'request address' messages from clients.
110 * @param cls unused, NULL
111 * @param client client that sent the request
112 * @param message the request message
115 GAS_handle_request_address_cancel (void *cls,
116 struct GNUNET_SERVER_Client *client,
117 const struct GNUNET_MessageHeader *message);
121 * Handle 'address add' messages from clients.
123 * @param cls unused, NULL
124 * @param client client that sent the request
125 * @param message the request message
128 GAS_handle_address_add (void *cls, struct GNUNET_SERVER_Client *client,
129 const struct GNUNET_MessageHeader *message);
132 * Handle 'address update' messages from clients.
134 * @param cls unused, NULL
135 * @param client client that sent the request
136 * @param message the request message
139 GAS_handle_address_update (void *cls, struct GNUNET_SERVER_Client *client,
140 const struct GNUNET_MessageHeader *message);
144 * Handle 'address in use' messages from clients.
146 * @param cls unused, NULL
147 * @param client client that sent the request
148 * @param message the request message
151 GAS_handle_address_in_use (void *cls, struct GNUNET_SERVER_Client *client,
152 const struct GNUNET_MessageHeader *message);
156 * Handle 'address destroyed' messages from clients.
158 * @param cls unused, NULL
159 * @param client client that sent the request
160 * @param message the request message
163 GAS_handle_address_destroyed (void *cls,
164 struct GNUNET_SERVER_Client *client,
165 const struct GNUNET_MessageHeader *message);
169 * Initialize scheduling subsystem.
171 * @param server handle to our server
172 * @param ah the address handle to use
175 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server, struct GAS_Addresses_Handle *ah);
179 * Shutdown scheduling subsystem.
182 GAS_scheduling_done (void);
186 /* end of gnunet-service-ats_scheduling.h */