gnunet/src/ats/gnunet-service-ats_preferences.h

/*
   This file is part of GNUnet.
   Copyright (C) 2011-2014 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
 */
/**
 * @file ats/gnunet-service-ats_preferences.h
 * @brief manage preferences expressed by clients
 * @author Matthias Wachs
 * @author Christian Grothoff
 */
#ifndef GNUNET_SERVICE_ATS_PREFERENCES_H
#define GNUNET_SERVICE_ATS_PREFERENCES_H

#include "gnunet_util_lib.h"
#include "gnunet_ats_service.h"
#include "gnunet-service-ats.h"
#include "gnunet_statistics_service.h"
#include "ats.h"

/**
 * Default preference value we assume if we know nothing.
 */
#define DEFAULT_ABS_PREFERENCE 0.0

/**
 * Default relative preference value we assume if we know nothing.
 */
#define DEFAULT_REL_PREFERENCE 0.0


/**
 * Handle 'preference change' messages from clients.
 *
 * @param client the client that sent the request
 * @param msg the request message
 */
void
GAS_handle_preference_change(struct GNUNET_SERVICE_Client *client,
                             const struct ChangePreferenceMessage *msg);


/**
 * Initialize preferences subsystem.
 */
void
GAS_preference_init(void);


/**
 * Shutdown preferences subsystem.
 */
void
GAS_preference_done(void);


/**
 * Get the normalized preference values for a specific peer.
 *
 * @param cls ignored
 * @param id the peer
 * @return pointer to the values, can be indexed
 *  with `enum GNUNET_ATS_PreferenceKind`, never NULL
 */
const double *
GAS_preference_get_by_peer(void *cls,
                           const struct GNUNET_PeerIdentity *id);


/**
 * A performance client disconnected
 *
 * @param client the disconnecting client
 */
void
GAS_preference_client_disconnect(struct GNUNET_SERVICE_Client *client);


#endif