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_neighbours.h
23 * @brief neighbour management API
24 * @author Christian Grothoff
26 #ifndef GNUNET_SERVICE_TRANSPORT_NEIGHBOURS_H
27 #define GNUNET_SERVICE_TRANSPORT_NEIGHBOURS_H
29 #include "gnunet_statistics_service.h"
30 #include "gnunet_transport_service.h"
31 #include "gnunet_transport_plugin.h"
32 #include "gnunet_util_lib.h"
35 // - ATS and similar info is a bit lacking in the API right now...
40 * Initialize the neighbours subsystem.
42 * @param cls closure for callbacks
43 * @param connect_cb function to call if we connect to a peer
44 * @param disconnect_cb function to call if we disconnect from a peer
45 * @param peer_address_cb function to call if a neighbour's active address changes
48 GST_neighbours_start (void *cls,
49 GNUNET_TRANSPORT_NotifyConnect connect_cb,
50 GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb,
51 GNUNET_TRANSPORT_PeerIterateCallback peer_address_cb);
55 * Cleanup the neighbours subsystem.
58 GST_neighbours_stop (void);
62 * Try to create a connection to the given target (eventually).
64 * @param target peer to try to connect to
67 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target);
71 * Test if we're connected to the given peer.
73 * @param target peer to test
74 * @return GNUNET_YES if we are connected, GNUNET_NO if not
77 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
81 * Function called after the transmission is done.
84 * @param success GNUNET_OK on success, GNUNET_NO on failure, GNUNET_SYSERR if we're not connected
86 typedef void (*GST_NeighbourSendContinuation) (void *cls, int success);
90 * Transmit a message to the given target using the active connection.
92 * @param target destination
93 * @param msg message to send
94 * @param msg_size number of bytes in msg
95 * @param timeout when to fail with timeout
96 * @param cont function to call when done
97 * @param cont_cls closure for 'cont'
100 GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg,
101 size_t msg_size, struct GNUNET_TIME_Relative timeout,
102 GST_NeighbourSendContinuation cont, void *cont_cls);
106 * We have received a message from the given sender.
107 * How long should we delay before receiving more?
108 * (Also used to keep the peer marked as live).
110 * @param sender sender of the message
111 * @param size size of the message
112 * @param do_forward set to GNUNET_YES if the message should be forwarded to clients
113 * GNUNET_NO if the neighbour is not connected or violates the quota
114 * @return how long to wait before reading more from this sender
116 struct GNUNET_TIME_Relative
117 GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity
118 *sender, ssize_t size, int *do_forward);
122 * Keep the connection to the given neighbour alive longer,
123 * we received a KEEPALIVE (or equivalent).
125 * @param neighbour neighbour to keep alive
128 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour);
131 * We received a KEEP_ALIVE_RESPONSE message and use this to calculate latency
134 * @param neighbour neighbour to keep alive
135 * @param ats performance data
136 * @param ats_count number of entries in ats
139 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
140 const struct GNUNET_ATS_Information *ats,
145 * Change the incoming quota for the given peer.
147 * @param neighbour identity of peer to change qutoa for
148 * @param quota new quota
151 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
152 struct GNUNET_BANDWIDTH_Value32NBO quota);
156 * If we have an active connection to the given target, it must be shutdown.
158 * @param target peer to disconnect from
161 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
165 * Function called for each connected neighbour.
168 * @param neighbour identity of the neighbour
169 * @param ats performance data
170 * @param ats_count number of entries in ats (including 0-termination)
171 * @param address the address (or NULL)
173 typedef void (*GST_NeighbourIterator) (void *cls,
174 const struct GNUNET_PeerIdentity *
176 const struct GNUNET_ATS_Information *
177 ats, uint32_t ats_count,
178 const struct GNUNET_HELLO_Address *
183 * Iterate over all connected neighbours.
185 * @param cb function to call
186 * @param cb_cls closure for cb
189 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
193 * A session was terminated. Take note.
195 * @param peer identity of the peer where the session died
196 * @param session session that is gone
199 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
200 struct Session *session);
204 * For an existing neighbour record, set the active connection to
205 * use the given address.
207 * @param peer identity of the peer to switch the address for
208 * @param address address of the other peer, NULL if other peer
210 * @param session session to use (or NULL)
211 * @param ats performance data
212 * @param ats_count number of entries in ats
213 * @param bandwidth_in inbound quota to be used when connection is up
214 * @param bandwidth_out outbound quota to be used when connection is up
215 * @return GNUNET_YES if we are currently connected, GNUNET_NO if the
216 * connection is not up (yet)
219 GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
220 const struct GNUNET_HELLO_Address
221 *address, struct Session *session,
222 const struct GNUNET_ATS_Information *ats,
224 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
225 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
229 * We received a 'SESSION_CONNECT' message from the other peer.
230 * Consider switching to it.
232 * @param message possibly a 'struct SessionConnectMessage' (check format)
233 * @param peer identity of the peer to switch the address for
234 * @param address address of the other peer, NULL if other peer
236 * @param session session to use (or NULL)
237 * @param ats performance data
238 * @param ats_count number of entries in ats (excluding 0-termination)
241 GST_neighbours_handle_connect (const struct GNUNET_MessageHeader *message,
242 const struct GNUNET_PeerIdentity *peer,
243 const struct GNUNET_HELLO_Address *address,
244 struct Session *session,
245 const struct GNUNET_ATS_Information *ats,
250 * We received a 'SESSION_CONNECT_ACK' message from the other peer.
251 * Consider switching to it.
253 * @param message possibly a 'struct SessionConnectMessage' (check format)
254 * @param peer identity of the peer to switch the address for
255 * @param address address of the other peer, NULL if other peer
257 * @param session session to use (or NULL)
258 * @param ats performance data
259 * @param ats_count number of entries in ats
262 GST_neighbours_handle_connect_ack (const struct GNUNET_MessageHeader *message,
263 const struct GNUNET_PeerIdentity *peer,
264 const struct GNUNET_HELLO_Address *address,
265 struct Session *session,
266 const struct GNUNET_ATS_Information *ats,
270 GST_neighbours_handle_ack (const struct GNUNET_MessageHeader *message,
271 const struct GNUNET_PeerIdentity *peer,
272 const struct GNUNET_HELLO_Address *address,
273 struct Session *session,
274 const struct GNUNET_ATS_Information *ats,
279 * Obtain current latency information for the given neighbour.
282 * @return observed latency of the address, FOREVER if the address was
283 * never successfully validated
285 struct GNUNET_TIME_Relative
286 GST_neighbour_get_latency (const struct GNUNET_PeerIdentity *peer);
290 * Obtain current address information for the given neighbour.
293 * @return address currently used
295 struct GNUNET_HELLO_Address *
296 GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer);
300 * We received a disconnect message from the given peer,
301 * validate and process.
303 * @param peer sender of the message
304 * @param msg the disconnect message
307 GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity
309 const struct GNUNET_MessageHeader
314 /* end of file gnunet-service-transport_neighbours.h */