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