2 This file is part of GNUnet.
3 (C) 2010,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 transport/gnunet-service-transport_validation.h
23 * @brief address validation API
24 * @author Christian Grothoff
26 #ifndef GNUNET_SERVICE_TRANSPORT_VALIDATION_H
27 #define GNUNET_SERVICE_TRANSPORT_VALIDATION_H
29 #include "gnunet_statistics_service.h"
30 #include "gnunet_transport_plugin.h"
31 #include "gnunet_util_lib.h"
32 #include "gnunet_hello_lib.h"
35 * Start the validation subsystem.
37 * @param max_fds maximum number of fds to use
40 GST_validation_start (unsigned int max_fds);
44 * Stop the validation subsystem.
47 GST_validation_stop (void);
51 * Update if we are using an address for a connection actively right now.
52 * Based on this, the validation module will measure latency for the
53 * address more or less often.
55 * @param address the address that we are now using (or not)
56 * @param in_use #GNUNET_YES if we are now using the address for a connection,
57 * #GNUNET_NO if we are no longer using the address for a connection
60 GST_validation_set_address_use (const struct GNUNET_HELLO_Address *address,
65 * Function called to notify transport users that a neighbour peer changed its
69 * @param address address (never NULL)
70 * @param last_validation point in time when last validation was performed
71 * @param valid_until point in time how long address is valid
72 * @param next_validation point in time when next validation will be performed
73 * @param state state of validation notification
76 (*GST_ValidationChangedCallback) (void *cls,
77 const struct GNUNET_HELLO_Address *address,
78 struct GNUNET_TIME_Absolute last_validation,
79 struct GNUNET_TIME_Absolute valid_until,
80 struct GNUNET_TIME_Absolute next_validation,
81 enum GNUNET_TRANSPORT_ValidationState state);
85 * Iterate over all iteration entries
87 * @param cb function to call
88 * @param cb_cls closure for @a cb
91 GST_validation_iterate (GST_ValidationChangedCallback cb, void *cb_cls);
95 * We've received a PING. If appropriate, generate a PONG.
97 * @param sender peer sending the PING
99 * @param sender_address address of the sender, NULL if we did not initiate
100 * @param session session we got the PING from
101 * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
104 GST_validation_handle_ping (const struct GNUNET_PeerIdentity *sender,
105 const struct GNUNET_MessageHeader *hdr,
106 const struct GNUNET_HELLO_Address *sender_address,
107 struct Session *session);
111 * We've received a PONG. Check if it matches a pending PING and
112 * mark the respective address as confirmed.
114 * @param sender peer sending the PONG
115 * @param hdr the PONG
116 * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
119 GST_validation_handle_pong (const struct GNUNET_PeerIdentity *sender,
120 const struct GNUNET_MessageHeader *hdr);
124 * We've received a HELLO, check which addresses are new and trigger
127 * @param hello the HELLO we received
128 * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
131 GST_validation_handle_hello (const struct GNUNET_MessageHeader *hello);
135 * Function called for each address (or address status change) that
136 * the validation module is aware of (for the given target).
139 * @param public_key public key for the peer, never NULL
140 * @param valid_until is ZERO if we never validated the address,
141 * otherwise a time up to when we consider it (or was) valid
142 * @param validation_block is FOREVER if the address is for an unsupported plugin (from PEERINFO)
143 * is ZERO if the address is considered valid (no validation needed)
144 * otherwise a time in the future if we're currently denying re-validation
145 * @param address the address
148 (*GST_ValidationAddressCallback) (void *cls,
149 struct GNUNET_TIME_Absolute valid_until,
150 struct GNUNET_TIME_Absolute validation_block,
151 const struct GNUNET_HELLO_Address *address);
155 * Call the given function for each address for the given target.
157 * @param target peer information is requested for
158 * @param cb function to call; will not be called after this function returns
159 * @param cb_cls closure for @a cb
162 GST_validation_get_addresses (const struct GNUNET_PeerIdentity *target,
163 GST_ValidationAddressCallback cb, void *cb_cls);
167 /* end of file gnunet-service-transport_validation.h */