src/ats/gnunet-service-ats_scheduling.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2011 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, 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 session_id session ID to use
  59  * @param bandwidth_out assigned outbound bandwidth
  60  * @param bandwidth_in assigned inbound bandwidth
  61  */
  62 void
  63 GAS_scheduling_transmit_address_suggestion (const struct GNUNET_PeerIdentity *peer,
  64                                             uint32_t session_id,
  65                                             struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
  66                                             struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
  67
  68
  69 /**
  70  * Handle 'address add' messages from clients.
  71  *
  72  * @param cls unused, NULL
  73  * @param client client that sent the request
  74  * @param message the request message
  75  */
  76 void
  77 GAS_handle_address_add (void *cls,
  78                         struct GNUNET_SERVER_Client *client,
  79                         const struct GNUNET_MessageHeader *message);
  80
  81
  82 /**
  83  * Handle 'address update' 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_update (void *cls,
  91                            struct GNUNET_SERVER_Client *client,
  92                            const struct GNUNET_MessageHeader *message);
  93
  94
  95 /**
  96  * Handle 'address destroyed' 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_destroyed (void *cls,
 104                               struct GNUNET_SERVER_Client *client,
 105                               const struct GNUNET_MessageHeader *message);
 106
 107
 108 /**
 109  * Initialize scheduling subsystem.
 110  *
 111  * @param server handle to our server
 112  * @param ah the address handle to use
 113  */
 114 void
 115 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server);
 116
 117
 118 /**
 119  * Shutdown scheduling subsystem.
 120  */
 121 void
 122 GAS_scheduling_done (void);
 123
 124
 125 #endif
 126 /* end of gnunet-service-ats_scheduling.h */