2 This file is part of GNUnet.
3 (C) 2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file ats/gnunet-service-ats_addresses.h
23 * @brief ats service address management
24 * @author Matthias Wachs
25 * @author Christian Grothoff
27 #ifndef GNUNET_SERVICE_ATS_ADDRESSES_H
28 #define GNUNET_SERVICE_ATS_ADDRESSES_H
30 #include "gnunet_util_lib.h"
31 #include "gnunet_ats_service.h"
32 #include "gnunet_statistics_service.h"
37 struct ATS_Address *next;
39 struct ATS_Address *prev;
41 struct GNUNET_PeerIdentity peer;
53 void *mlp_information;
55 struct GNUNET_ATS_Information *ats;
57 struct GNUNET_TIME_Relative atsp_latency;
59 struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_in;
61 struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_out;
63 uint32_t atsp_distance;
65 uint32_t atsp_cost_wan;
67 uint32_t atsp_cost_lan;
69 uint32_t atsp_cost_wlan;
71 uint32_t atsp_network_type;
73 struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_in;
75 struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_out;
80 struct GNUNET_TIME_Relative block_interval;
83 * Time when address can be suggested again
85 struct GNUNET_TIME_Absolute blocked_until;
88 * Is this the active address for this peer?
93 * Is this the address for this peer in use?
100 (*GAS_solver_init) (const struct GNUNET_CONFIGURATION_Handle *cfg,
101 const struct GNUNET_STATISTICS_Handle *stats);
104 (*GAS_solver_address_change_preference) (void *solver,
105 const struct GNUNET_PeerIdentity *peer,
106 enum GNUNET_ATS_PreferenceKind kind,
110 (*GAS_solver_address_delete) (void *solver,
111 struct GNUNET_CONTAINER_MultiHashMap *addresses,
112 struct ATS_Address *address);
115 (*GAS_solver_address_update) (void *solver,
116 struct GNUNET_CONTAINER_MultiHashMap *addresses,
117 struct ATS_Address *address);
120 typedef struct ATS_PreferedAddress *
121 (*GAS_solver_get_preferred_address) (void *solver,
122 struct GNUNET_CONTAINER_MultiHashMap *addresses,
123 const struct GNUNET_PeerIdentity *peer);
127 (*GAS_solver_done) (void *solver);
131 * Initialize address subsystem.
133 * @param cfg configuration to use
134 * @param stats the statistics handle to use
136 struct GAS_Addresses_Handle *
137 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
138 const struct GNUNET_STATISTICS_Handle *stats);
141 * Shutdown address subsystem.
144 GAS_addresses_done (struct GAS_Addresses_Handle *handle);
147 GAS_addresses_handle_backoff_reset (const struct GNUNET_PeerIdentity *peer);
150 * This address is now used or not used anymore
153 GAS_addresses_in_use (const struct GNUNET_PeerIdentity *peer,
154 const char *plugin_name, const void *plugin_addr,
155 size_t plugin_addr_len, uint32_t session_id, int in_use);
158 GAS_addresses_update (const struct GNUNET_PeerIdentity *peer,
159 const char *plugin_name, const void *plugin_addr,
160 size_t plugin_addr_len, uint32_t session_id,
161 const struct GNUNET_ATS_Information *atsi,
162 uint32_t atsi_count);
166 GAS_addresses_destroy (const struct GNUNET_PeerIdentity *peer,
167 const char *plugin_name, const void *plugin_addr,
168 size_t plugin_addr_len, uint32_t session_id);
172 GAS_addresses_destroy_all (void);
175 // FIXME: this function should likely end up in the LP-subsystem and
176 // not with 'addresses' in the future...
177 // Note: this call should trigger an address suggestion
178 // (GAS_scheduling_transmit_address_suggestion)
180 GAS_addresses_request_address (const struct GNUNET_PeerIdentity *peer);
183 // FIXME: this function should likely end up in the LP-subsystem and
184 // not with 'addresses' in the future...
186 GAS_addresses_change_preference (const struct GNUNET_PeerIdentity *peer,
187 enum GNUNET_ATS_PreferenceKind kind,
191 GAS_addresses_add (const struct GNUNET_PeerIdentity *peer,
192 const char *plugin_name, const void *plugin_addr,
193 size_t plugin_addr_len, uint32_t session_id,
194 const struct GNUNET_ATS_Information *atsi,
195 uint32_t atsi_count);
198 typedef void (*GNUNET_ATS_Peer_Iterator) (void *p_it_cls,
199 const struct GNUNET_PeerIdentity *id);
202 * Return all peers currently known to ATS
204 * @param p_it the iterator to call for every peer
205 * @param p_it_cls the closure for the iterator
208 GAS_addresses_iterate_peers (GNUNET_ATS_Peer_Iterator p_it, void *p_it_cls);
210 typedef void (*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
211 const struct GNUNET_PeerIdentity *id,
212 const char *plugin_name,
213 const void *plugin_addr, size_t plugin_addr_len,
214 const int address_active,
215 const struct GNUNET_ATS_Information *atsi,
217 struct GNUNET_BANDWIDTH_Value32NBO
219 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
222 * Return information all peers currently known to ATS
224 * @param peer the respective peer
225 * @param pi_it the iterator to call for every peer
226 * @param pi_it_cls the closure for the iterator
229 GAS_addresses_get_peer_info (const struct GNUNET_PeerIdentity *peer, GNUNET_ATS_PeerInfo_Iterator pi_it, void *pi_it_cls);
233 /* end of gnunet-service-ats_addresses.h */