2 This file is part of GNUnet.
3 Copyright (C) 2010,2011 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file transport/gnunet-service-transport.h
24 * @author Christian Grothoff
26 #ifndef GNUNET_SERVICE_TRANSPORT_H
27 #define GNUNET_SERVICE_TRANSPORT_H
29 #include "gnunet_util_lib.h"
30 #include "gnunet_statistics_service.h"
31 #include "gnunet_ats_service.h"
32 #include "gnunet_transport_service.h"
34 #define VERBOSE_VALIDATION GNUNET_YES
39 extern struct GNUNET_STATISTICS_Handle *GST_stats;
42 * Configuration handle.
44 extern const struct GNUNET_CONFIGURATION_Handle *GST_cfg;
47 * Configuration handle.
49 extern struct GNUNET_PeerIdentity GST_my_identity;
52 * Handle to peerinfo service.
54 extern struct GNUNET_PEERINFO_Handle *GST_peerinfo;
59 extern struct GNUNET_CRYPTO_EddsaPrivateKey *GST_my_private_key;
64 extern struct GNUNET_ATS_SchedulingHandle *GST_ats;
67 * ATS connectivity handle.
69 extern struct GNUNET_ATS_ConnectivityHandle *GST_ats_connect;
72 * Interface scanner determines our LAN address range(s).
74 extern struct GNUNET_NT_InterfaceScanner *GST_is;
78 * Function to call when a peer's address has changed
81 * @param peer peer this update is about,
82 * @param address address, NULL for disconnect notification
85 (*GNUNET_TRANSPORT_NeighbourChangeCallback) (void *cls,
86 const struct GNUNET_PeerIdentity *peer,
87 const struct GNUNET_HELLO_Address *address,
88 enum GNUNET_TRANSPORT_PeerState state,
89 struct GNUNET_TIME_Absolute state_timeout,
90 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
91 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
95 * Continuation called from a blacklist test.
98 * @param peer identity of peer that was tested
99 * @param address address associated with the request
100 * @param session session associated with the request
101 * @param result #GNUNET_OK if the connection is allowed,
103 * #GNUNET_SYSERR if operation was aborted
106 (*GST_BlacklistTestContinuation) (void *cls,
107 const struct GNUNET_PeerIdentity *peer,
108 const struct GNUNET_HELLO_Address *address,
109 struct GNUNET_ATS_Session *session,
114 * Add the given peer to the blacklist (for the given transport).
116 * @param peer peer to blacklist
117 * @param transport_name transport to blacklist for this peer, NULL for all
120 GST_blacklist_add_peer (const struct GNUNET_PeerIdentity *peer,
121 const char *transport_name);
125 * Handle to an active blacklist check.
127 struct GST_BlacklistCheck;
132 * Test if a peer/transport combination is blacklisted.
134 * @param peer the identity of the peer to test
135 * @param transport_name name of the transport to test, never NULL
136 * @param cont function to call with result
137 * @param cont_cls closure for @a cont
138 * @param address address to pass back to @a cont, can be NULL
139 * @param session session to pass back to @a cont, can be NULL
140 * @return handle to the blacklist check, NULL if the decision
141 * was made instantly and @a cont was already called
143 struct GST_BlacklistCheck *
144 GST_blacklist_test_allowed (const struct GNUNET_PeerIdentity *peer,
145 const char *transport_name,
146 GST_BlacklistTestContinuation cont,
148 const struct GNUNET_HELLO_Address *address,
149 struct GNUNET_ATS_Session *session);
153 * Abort blacklist if @a address and @a session match.
155 * @param address address used to abort matching checks
156 * @param session session used to abort matching checks
159 GST_blacklist_abort_matching (const struct GNUNET_HELLO_Address *address,
160 struct GNUNET_ATS_Session *session);
163 * Cancel a blacklist check.
165 * @param bc check to cancel
168 GST_blacklist_test_cancel (struct GST_BlacklistCheck *bc);
172 * Function called by the transport for each received message.
174 * @param cls closure, const char* with the name of the plugin we received the message from
175 * @param address address and (claimed) identity of the other peer
176 * @param session identifier used for this session (NULL for plugins
177 * that do not offer bi-directional communication to the sender
178 * using the same "connection")
179 * @param message the message, NULL if we only care about
180 * learning about the delay until we should receive again
181 * @return how long the plugin should wait until receiving more data
182 * (plugins that do not support this, can ignore the return value)
184 struct GNUNET_TIME_Relative
185 GST_receive_callback (void *cls,
186 const struct GNUNET_HELLO_Address *address,
187 struct GNUNET_ATS_Session *session,
188 const struct GNUNET_MessageHeader *message);
191 * Broadcast the given message to all of our clients.
193 * @param msg message to broadcast
194 * @param may_drop #GNUNET_YES if the message can be dropped / is payload
197 GST_clients_broadcast (const struct GNUNET_MessageHeader *msg,
202 * Broadcast the new active address to all clients monitoring the peer.
204 * @param peer peer this update is about (never NULL)
205 * @param address address, NULL on disconnect
206 * @param state the current state of the peer
207 * @param state_timeout the time out for the state
210 GST_clients_broadcast_peer_notification (const struct GNUNET_PeerIdentity *peer,
211 const struct GNUNET_HELLO_Address *address,
212 enum GNUNET_TRANSPORT_PeerState state,
213 struct GNUNET_TIME_Absolute state_timeout);
217 * Notify all clients about a disconnect, and cancel
218 * pending SEND_OK messages for this peer.
220 * @param peer peer that disconnected
223 GST_clients_broadcast_disconnect (const struct GNUNET_PeerIdentity *peer);
229 /* end of file gnunet-service-transport_plugins.h */