2 This file is part of GNUnet.
3 Copyright (C) 2010-2015 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_neighbours.h
23 * @brief neighbour manipulation API, allows manipulation of
24 * performance metrics (delay and towards ATS)
25 * @author Christian Grothoff
27 #ifndef GNUNET_SERVICE_TRANSPORT_MANIPULATION_H
28 #define GNUNET_SERVICE_TRANSPORT_MANIPULATION_H
31 #include "gnunet-service-transport_hello.h"
32 #include "gnunet-service-transport_neighbours.h"
33 #include "gnunet-service-transport_plugins.h"
34 #include "gnunet-service-transport_validation.h"
35 #include "gnunet-service-transport.h"
36 #include "transport.h"
40 * Set traffic metric to manipulate
42 * @param message containing information
45 GST_manipulation_set_metric (const struct TrafficMetricMessage *tm);
49 * Adapter function between transport's send function and transport plugins
51 * @param target the peer the message to send to
52 * @param msg the message received
53 * @param msg_size message size
54 * @param timeout timeout
55 * @param cont the continuation to call after sending
56 * @param cont_cls cls for continuation
59 GST_manipulation_send (const struct GNUNET_PeerIdentity *target,
62 struct GNUNET_TIME_Relative timeout,
63 GST_NeighbourSendContinuation cont,
68 * Adapter function between transport plugins and transport receive function
69 * manipulation delays for next send.
71 * @param cls the closure for transport
72 * @param address the address and the peer the message was received from
73 * @param message the message received
74 * @param session the session the message was received on
75 * @return manipulated delay for next receive
77 struct GNUNET_TIME_Relative
78 GST_manipulation_recv (void *cls,
79 const struct GNUNET_HELLO_Address *address,
80 struct GNUNET_ATS_Session *session,
81 const struct GNUNET_MessageHeader *message);
85 * Function that will be called to manipulate ATS information according to
86 * current manipulation settings
88 * @param address binary address
89 * @param session the session
90 * @param prop[IN|OUT] metrics to modify
93 GST_manipulation_manipulate_metrics (const struct GNUNET_HELLO_Address *address,
94 struct GNUNET_ATS_Session *session,
95 struct GNUNET_ATS_Properties *prop);
99 * Notify manipulation about disconnect so it can discard queued messages
101 * @param peer the disconnecting peer
104 GST_manipulation_peer_disconnect (const struct GNUNET_PeerIdentity *peer);
108 * Initialize traffic manipulation
111 GST_manipulation_init (void);
115 * Stop traffic manipulation
118 GST_manipulation_stop (void);
121 /* end of file gnunet-service-transport_neighbours.h */