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 * Transmit the given address suggestion and bandwidth update to all scheduling
57 * @param peer peer for which this is an address suggestion
58 * @param plugin_name 0-termintated string specifying the transport plugin
59 * @param plugin_addr binary address for the plugin to use
60 * @param plugin_addr_len number of bytes in plugin_addr
61 * @param session_id session ID to use
62 * @param atsi performance data for the address
63 * @param atsi_count number of performance records in 'ats'
64 * @param bandwidth_out assigned outbound bandwidth
65 * @param bandwidth_in assigned inbound bandwidth
68 GAS_scheduling_transmit_address_suggestion (const struct GNUNET_PeerIdentity
69 *peer, const char *plugin_name,
70 const void *plugin_addr,
71 size_t plugin_addr_len,
73 const struct GNUNET_ATS_Information
74 *atsi, uint32_t atsi_count,
75 struct GNUNET_BANDWIDTH_Value32NBO
77 struct GNUNET_BANDWIDTH_Value32NBO
82 * Handle 'request address' messages from clients.
84 * @param cls unused, NULL
85 * @param client client that sent the request
86 * @param message the request message
89 GAS_handle_request_address (void *cls, struct GNUNET_SERVER_Client *client,
90 const struct GNUNET_MessageHeader *message);
94 * Cancel 'request address' messages from clients.
96 * @param cls unused, NULL
97 * @param client client that sent the request
98 * @param message the request message
101 GAS_handle_request_address_cancel (void *cls,
102 struct GNUNET_SERVER_Client *client,
103 const struct GNUNET_MessageHeader *message);
106 * Handle 'address update' messages from clients.
108 * @param cls unused, NULL
109 * @param client client that sent the request
110 * @param message the request message
113 GAS_handle_address_update (void *cls, struct GNUNET_SERVER_Client *client,
114 const struct GNUNET_MessageHeader *message);
118 * Handle 'address in use' messages from clients.
120 * @param cls unused, NULL
121 * @param client client that sent the request
122 * @param message the request message
125 GAS_handle_address_in_use (void *cls, struct GNUNET_SERVER_Client *client,
126 const struct GNUNET_MessageHeader *message);
130 * Handle 'address destroyed' messages from clients.
132 * @param cls unused, NULL
133 * @param client client that sent the request
134 * @param message the request message
137 GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
138 const struct GNUNET_MessageHeader *message);
142 * Initialize scheduling subsystem.
144 * @param server handle to our server
147 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server);
151 * Shutdown scheduling subsystem.
154 GAS_scheduling_done (void);
158 /* end of gnunet-service-ats_scheduling.h */