gnunet_ats_plugin.h

Go to the documentation of this file.

/*
   This file is part of GNUnet
   Copyright (C) 2009-2015 GNUnet e.V.
 
   GNUnet is free software: you can redistribute it and/or modify it
   under the terms of the GNU Affero General Public License as published
   by the Free Software Foundation, either version 3 of the License,
   or (at your option) any later version.
 
   GNUnet is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Affero General Public License for more details.
 
   You should have received a copy of the GNU Affero General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#ifndef PLUGIN_ATS_H
#define PLUGIN_ATS_H
 
 
#include "gnunet_ats_service.h"
#include "gnunet_statistics_service.h"
 
struct ATS_Address;
 
typedef void
(*GAS_solver_address_change_preference) (void *solver,
                                         const struct GNUNET_PeerIdentity *peer,
                                         enum GNUNET_ATS_PreferenceKind kind,
                                         double pref_rel);
 
 
typedef void
(*GAS_solver_address_feedback_preference) (void *solver,
                                           struct GNUNET_SERVICE_Client *
                                           application,
                                           const struct
                                           GNUNET_PeerIdentity *peer,
                                           const struct GNUNET_TIME_Relative
                                           scope,
                                           enum GNUNET_ATS_PreferenceKind kind,
                                           double score);
 
typedef void
(*GAS_solver_bulk_start) (void *solver);
 
 
typedef void
(*GAS_solver_bulk_stop) (void *solver);
 
 
typedef void
(*GAS_solver_address_add) (void *solver,
                           struct ATS_Address *address,
                           uint32_t network);
 
 
typedef void
(*GAS_solver_address_delete) (void *solver,
                              struct ATS_Address *address);
 
 
typedef void
(*GAS_solver_address_property_changed) (void *solver,
                                        struct ATS_Address *address);
 
 
typedef void
(*GAS_solver_get_preferred_address) (void *solver,
                                     const struct GNUNET_PeerIdentity *peer);
 
 
typedef void
(*GAS_solver_stop_get_preferred_address) (void *solver,
                                          const struct
                                          GNUNET_PeerIdentity *peer);
 
 
struct GNUNET_ATS_SolverFunctions
{
  void *cls;
 
  GAS_solver_address_add s_add;
 
  GAS_solver_address_property_changed s_address_update_property;
 
  GAS_solver_get_preferred_address s_get;
 
  GAS_solver_stop_get_preferred_address s_get_stop;
 
  GAS_solver_address_delete s_del;
 
  GAS_solver_address_change_preference s_pref;
 
  GAS_solver_address_feedback_preference s_feedback;
 
  GAS_solver_bulk_start s_bulk_start;
 
  GAS_solver_bulk_stop s_bulk_stop;
};
 
 
enum GAS_Solver_Operation
{
  GAS_OP_SOLVE_START,
 
  GAS_OP_SOLVE_STOP,
 
  GAS_OP_SOLVE_SETUP_START,
 
  GAS_OP_SOLVE_SETUP_STOP,
 
  GAS_OP_SOLVE_MLP_LP_START,
 
  GAS_OP_SOLVE_MLP_LP_STOP,
 
  GAS_OP_SOLVE_MLP_MLP_START,
 
  GAS_OP_SOLVE_MLP_MLP_STOP,
 
  GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
 
  GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP
};
 
 
enum GAS_Solver_Status
{
  GAS_STAT_SUCCESS,
 
  GAS_STAT_FAIL
};
 
 
enum GAS_Solver_Additional_Information
{
  GAS_INFO_NONE,
 
  GAS_INFO_FULL,
 
  GAS_INFO_UPDATED,
 
  GAS_INFO_PROP_SINGLE,
 
  GAS_INFO_PROP_ALL
};
 
 
typedef void
(*GAS_solver_information_callback) (void *cls,
                                    enum GAS_Solver_Operation op,
                                    enum GAS_Solver_Status stat,
                                    enum GAS_Solver_Additional_Information);
 
 
typedef void
(*GAS_bandwidth_changed_cb) (void *cls,
                             struct ATS_Address *address);
 
 
typedef const double *
(*GAS_get_preferences) (void *cls,
                        const struct GNUNET_PeerIdentity *id);
 
 
typedef unsigned int
(*GAS_get_connectivity) (void *cls,
                         const struct GNUNET_PeerIdentity *id);
 
 
struct GNUNET_ATS_PluginEnvironment
{
  const struct GNUNET_CONFIGURATION_Handle *cfg;
 
  struct GNUNET_STATISTICS_Handle *stats;
 
  void *cls;
 
  struct GNUNET_CONTAINER_MultiPeerMap *addresses;
 
  GAS_bandwidth_changed_cb bandwidth_changed_cb;
 
  GAS_get_preferences get_preferences;
 
  GAS_get_connectivity get_connectivity;
 
  GAS_solver_information_callback info_cb;
 
  unsigned int network_count;
 
  unsigned long long out_quota[GNUNET_NT_COUNT];
 
  unsigned long long in_quota[GNUNET_NT_COUNT];
};
 
#endif
  /* end of group */
  /* end of group addition */