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  * Transmit the given address suggestion and bandwidth update to all scheduling
  55  * clients.
  56  *
  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
  66  */
  67 void
  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,
  72                                             uint32_t session_id,
  73                                             const struct GNUNET_ATS_Information
  74                                             *atsi, uint32_t atsi_count,
  75                                             struct GNUNET_BANDWIDTH_Value32NBO
  76                                             bandwidth_out,
  77                                             struct GNUNET_BANDWIDTH_Value32NBO
  78                                             bandwidth_in);
  79
  80
  81 /**
  82  * Handle 'request address' messages from clients.
  83  *
  84  * @param cls unused, NULL
  85  * @param client client that sent the request
  86  * @param message the request message
  87  */
  88 void
  89 GAS_handle_request_address (void *cls, struct GNUNET_SERVER_Client *client,
  90                             const struct GNUNET_MessageHeader *message);
  91
  92
  93 /**
  94  * Cancel 'request address' messages from clients.
  95  *
  96  * @param cls unused, NULL
  97  * @param client client that sent the request
  98  * @param message the request message
  99  */
 100 void
 101 GAS_handle_request_address_cancel (void *cls,
 102                                    struct GNUNET_SERVER_Client *client,
 103                                    const struct GNUNET_MessageHeader *message);
 104
 105 /**
 106  * Handle 'address update' messages from clients.
 107  *
 108  * @param cls unused, NULL
 109  * @param client client that sent the request
 110  * @param message the request message
 111  */
 112 void
 113 GAS_handle_address_update (void *cls, struct GNUNET_SERVER_Client *client,
 114                            const struct GNUNET_MessageHeader *message);
 115
 116
 117 /**
 118  * Handle 'address in use' messages from clients.
 119  *
 120  * @param cls unused, NULL
 121  * @param client client that sent the request
 122  * @param message the request message
 123  */
 124 void
 125 GAS_handle_address_in_use (void *cls, struct GNUNET_SERVER_Client *client,
 126                            const struct GNUNET_MessageHeader *message);
 127
 128
 129 /**
 130  * Handle 'address destroyed' messages from clients.
 131  *
 132  * @param cls unused, NULL
 133  * @param client client that sent the request
 134  * @param message the request message
 135  */
 136 void
 137 GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
 138                               const struct GNUNET_MessageHeader *message);
 139
 140
 141 /**
 142  * Initialize scheduling subsystem.
 143  *
 144  * @param server handle to our server
 145  */
 146 void
 147 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server);
 148
 149
 150 /**
 151  * Shutdown scheduling subsystem.
 152  */
 153 void
 154 GAS_scheduling_done (void);
 155
 156
 157 #endif
 158 /* end of gnunet-service-ats_scheduling.h */