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  */
  38 void
  39 GAS_scheduling_add_client (struct GNUNET_SERVER_Client *client);
  40
  41
  42 /**
  43  * Unregister a client (which may have been a scheduling client,
  44  * but this is not assured).
  45  *
  46  * @param client handle of the (now dead) client
  47  */
  48 void
  49 GAS_scheduling_remove_client (struct GNUNET_SERVER_Client *client);
  50
  51
  52 /**
  53  * Transmit the given address suggestion and bandwidth update to all scheduling
  54  * clients.
  55  *
  56  * @param peer peer for which this is an address suggestion
  57  * @param plugin_name 0-termintated string specifying the transport plugin
  58  * @param plugin_addr binary address for the plugin to use
  59  * @param plugin_addr_len number of bytes in plugin_addr
  60  * @param session_client which client gave us this session_id?
  61  * @param session_id session ID to use for the given client (other clients will see 0)
  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 *peer,
  69                                             const char *plugin_name,
  70                                             const void *plugin_addr, size_t plugin_addr_len,
  71                                             struct GNUNET_SERVER_Client *session_client,
  72                                             uint32_t session_id,
  73                                             const struct GNUNET_ATS_Information *atsi,
  74                                             uint32_t atsi_count,
  75                                             struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
  76                                             struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
  77
  78
  79 /**
  80  * Handle 'request address' messages from clients.
  81  *
  82  * @param cls unused, NULL
  83  * @param client client that sent the request
  84  * @param message the request message
  85  */
  86 void
  87 GAS_handle_request_address (void *cls, struct GNUNET_SERVER_Client *client,
  88                             const struct GNUNET_MessageHeader *message);
  89
  90
  91
  92 /**
  93  * Handle 'address update' messages from clients.
  94  *
  95  * @param cls unused, NULL
  96  * @param client client that sent the request
  97  * @param message the request message
  98  */
  99 void
 100 GAS_handle_address_update (void *cls, struct GNUNET_SERVER_Client *client,
 101                            const struct GNUNET_MessageHeader *message);
 102
 103
 104 /**
 105  * Handle 'address destroyed' messages from clients.
 106  *
 107  * @param cls unused, NULL
 108  * @param client client that sent the request
 109  * @param message the request message
 110  */
 111 void
 112 GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
 113                               const struct GNUNET_MessageHeader *message);
 114
 115
 116 /**
 117  * Initialize scheduling subsystem.
 118  *
 119  * @param server handle to our server
 120  */
 121 void
 122 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server);
 123
 124
 125 /**
 126  * Shutdown scheduling subsystem.
 127  */
 128 void
 129 GAS_scheduling_done (void);
 130
 131
 132 #endif
 133 /* end of gnunet-service-ats_scheduling.h */