src/ats/gnunet-service-ats_scheduling.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011 Christian Grothoff (and other contributing authors)
   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., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file ats/gnunet-service-ats_scheduling.h
  23  * @brief ats service, interaction with 'scheduling' API
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #ifndef GNUNET_SERVICE_ATS_SCHEDULING_H
  28 #define GNUNET_SERVICE_ATS_SCHEDULING_H
  29
  30 #include "gnunet_util_lib.h"
  31
  32
  33 /**
  34  * Register a new scheduling client.
  35  *
  36  * @param client handle of the new client
  37  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
  38  */
  39 int
  40 GAS_scheduling_add_client (struct GNUNET_SERVER_Client *client);
  41
  42
  43 /**
  44  * Unregister a client (which may have been a scheduling client,
  45  * but this is not assured).
  46  *
  47  * @param client handle of the (now dead) client
  48  */
  49 void
  50 GAS_scheduling_remove_client (struct GNUNET_SERVER_Client *client);
  51
  52
  53 /**
  54  * Handle 'reset backoff' messages from clients.
  55  *
  56  * @param cls unused, NULL
  57  * @param client client that sent the request
  58  * @param message the request message
  59  */
  60 void
  61 GAS_handle_reset_backoff (void *cls,
  62                           struct GNUNET_SERVER_Client *client,
  63                           const struct GNUNET_MessageHeader *message);
  64
  65
  66 /**
  67  * Transmit the given address suggestion and bandwidth update to all scheduling
  68  * clients.
  69  *
  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 @a 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 @a atsi
  78  * @param bandwidth_out assigned outbound bandwidth
  79  * @param bandwidth_in assigned inbound bandwidth
  80  */
  81 void
  82 GAS_scheduling_transmit_address_suggestion (const struct GNUNET_PeerIdentity *peer,
  83                                             const char *plugin_name,
  84                                             const void *plugin_addr,
  85                                             size_t plugin_addr_len,
  86                                             uint32_t local_address_info,
  87                                             uint32_t session_id,
  88                                             const struct GNUNET_ATS_Information *atsi,
  89                                             uint32_t atsi_count,
  90                                             struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
  91                                             struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
  92
  93
  94 /**
  95  * Handle 'request address' messages from clients.
  96  *
  97  * @param cls unused, NULL
  98  * @param client client that sent the request
  99  * @param message the request message
 100  */
 101 void
 102 GAS_handle_request_address (void *cls,
 103                             struct GNUNET_SERVER_Client *client,
 104                             const struct GNUNET_MessageHeader *message);
 105
 106
 107 /**
 108  * Cancel 'request address' messages from clients.
 109  *
 110  * @param cls unused, NULL
 111  * @param client client that sent the request
 112  * @param message the request message
 113  */
 114 void
 115 GAS_handle_request_address_cancel (void *cls,
 116                                    struct GNUNET_SERVER_Client *client,
 117                                    const struct GNUNET_MessageHeader *message);
 118
 119
 120 /**
 121  * Handle 'address add' messages from clients.
 122  *
 123  * @param cls unused, NULL
 124  * @param client client that sent the request
 125  * @param message the request message
 126  */
 127 void
 128 GAS_handle_address_add (void *cls,
 129                         struct GNUNET_SERVER_Client *client,
 130                         const struct GNUNET_MessageHeader *message);
 131
 132
 133 /**
 134  * Handle 'address update' messages from clients.
 135  *
 136  * @param cls unused, NULL
 137  * @param client client that sent the request
 138  * @param message the request message
 139  */
 140 void
 141 GAS_handle_address_update (void *cls,
 142                            struct GNUNET_SERVER_Client *client,
 143                            const struct GNUNET_MessageHeader *message);
 144
 145
 146 /**
 147  * Handle 'address in use' messages from clients.
 148  *
 149  * @param cls unused, NULL
 150  * @param client client that sent the request
 151  * @param message the request message
 152  */
 153 void
 154 GAS_handle_address_in_use (void *cls,
 155                            struct GNUNET_SERVER_Client *client,
 156                            const struct GNUNET_MessageHeader *message);
 157
 158
 159 /**
 160  * Handle 'address destroyed' messages from clients.
 161  *
 162  * @param cls unused, NULL
 163  * @param client client that sent the request
 164  * @param message the request message
 165  */
 166 void
 167 GAS_handle_address_destroyed (void *cls,
 168                               struct GNUNET_SERVER_Client *client,
 169                               const struct GNUNET_MessageHeader *message);
 170
 171
 172 /**
 173  * Initialize scheduling subsystem.
 174  *
 175  * @param server handle to our server
 176  * @param ah the address handle to use
 177  */
 178 void
 179 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server,
 180                      struct GAS_Addresses_Handle *ah);
 181
 182
 183 /**
 184  * Shutdown scheduling subsystem.
 185  */
 186 void
 187 GAS_scheduling_done (void);
 188
 189
 190 #endif
 191 /* end of gnunet-service-ats_scheduling.h */