gnunet-service-ats_addresses.h

Go to the documentation of this file.

/*
   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
 */
 
#ifndef GNUNET_SERVICE_ATS_ADDRESSES_H
#define GNUNET_SERVICE_ATS_ADDRESSES_H
 
#include "gnunet_util_lib.h"
#include "gnunet_ats_service.h"
#include "gnunet-service-ats.h"
#include "ats.h"
 
/*
 * How long will address suggestions blocked after a suggestion
 */
#define ATS_BLOCKING_DELTA GNUNET_TIME_relative_multiply ( \
    GNUNET_TIME_UNIT_MILLISECONDS, 100)
 
struct GAS_NormalizationInfo
{
  unsigned int avg_queue_index;
 
  uint64_t atsi_abs[GAS_normalization_queue_length];
 
  uint64_t avg;
 
  double norm;
};
 
 
struct ATS_Address
{
  struct GNUNET_PeerIdentity peer;
 
  const void *addr;
 
  char *plugin;
 
  void *solver_information;
 
  struct GNUNET_ATS_Properties properties;
 
  struct GNUNET_TIME_Absolute t_last_activity;
 
  struct GNUNET_TIME_Absolute t_added;
 
  size_t addr_len;
 
  uint32_t session_id;
 
  enum GNUNET_HELLO_AddressInfo local_address_info;
 
  uint32_t atsi_count;
 
  uint32_t assigned_bw_in;
 
  uint32_t assigned_bw_out;
 
  uint32_t last_notified_bw_in;
 
  uint32_t last_notified_bw_out;
 
  int active;
 
  struct GAS_NormalizationInfo norm_delay;
 
  struct GAS_NormalizationInfo norm_distance;
 
  struct GAS_NormalizationInfo norm_utilization_in;
 
  struct GAS_NormalizationInfo norm_utilization_out;
};
 
 
extern struct GNUNET_CONTAINER_MultiPeerMap *GSA_addresses;
 
 
void
GAS_addresses_init (void);
 
 
void
GAS_addresses_done (void);
 
 
void
GAS_addresses_add (const struct GNUNET_PeerIdentity *peer,
                   const char *plugin_name,
                   const void *plugin_addr,
                   size_t plugin_addr_len,
                   uint32_t local_address_info,
                   uint32_t session_id,
                   const struct GNUNET_ATS_Properties *prop);
 
 
void
GAS_addresses_update (const struct GNUNET_PeerIdentity *peer,
                      uint32_t session_id,
                      const struct GNUNET_ATS_Properties *prop);
 
 
void
GAS_addresses_destroy (const struct GNUNET_PeerIdentity *peer,
                       uint32_t session_id);
 
 
void
GAS_addresses_destroy_all (void);
 
 
typedef void
(*GNUNET_ATS_PeerInfo_Iterator) (void *cls,
                                 const struct GNUNET_PeerIdentity *id,
                                 const char *plugin_name,
                                 const void *plugin_addr,
                                 size_t plugin_addr_len,
                                 const int address_active,
                                 const struct GNUNET_ATS_Properties *prop,
                                 enum GNUNET_HELLO_AddressInfo
                                 local_address_info,
                                 struct GNUNET_BANDWIDTH_Value32NBO
                                 bandwidth_out,
                                 struct GNUNET_BANDWIDTH_Value32NBO
                                 bandwidth_in);
 
 
void
GAS_addresses_get_peer_info (const struct GNUNET_PeerIdentity *peer,
                             GNUNET_ATS_PeerInfo_Iterator pi_it,
                             void *pi_it_cls);
 
 
void
GAS_handle_request_address_list (struct GNUNET_SERVICE_Client *client,
                                 const struct AddressListRequestMessage *alrm);
 
 
#endif
 
/* end of gnunet-service-ats_addresses.h */