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
47 GST_neighbours_start (void *cls, GNUNET_TRANSPORT_NotifyConnect connect_cb,
48 GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb);
52 * Cleanup the neighbours subsystem.
55 GST_neighbours_stop (void);
59 * Try to create a connection to the given target (eventually).
61 * @param target peer to try to connect to
64 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target);
68 * Test if we're connected to the given peer.
70 * @param target peer to test
71 * @return GNUNET_YES if we are connected, GNUNET_NO if not
74 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
78 * Function called after the transmission is done.
81 * @param success GNUNET_OK on success, GNUNET_NO on failure, GNUNET_SYSERR if we're not connected
83 typedef void (*GST_NeighbourSendContinuation) (void *cls, int success);
87 * Transmit a message to the given target using the active connection.
89 * @param target destination
90 * @param msg message to send
91 * @param msg_size number of bytes in msg
92 * @param timeout when to fail with timeout
93 * @param cont function to call when done
94 * @param cont_cls closure for 'cont'
97 GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg,
98 size_t msg_size, struct GNUNET_TIME_Relative timeout,
99 GST_NeighbourSendContinuation cont, void *cont_cls);
103 * We have received a message from the given sender.
104 * How long should we delay before receiving more?
105 * (Also used to keep the peer marked as live).
107 * @param sender sender of the message
108 * @param size size of the message
109 * @param do_forward set to GNUNET_YES if the message should be forwarded to clients
110 * GNUNET_NO if the neighbour is not connected or violates the quota
111 * @return how long to wait before reading more from this sender
113 struct GNUNET_TIME_Relative
114 GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity
115 *sender, ssize_t size, int *do_forward);
119 * Keep the connection to the given neighbour alive longer,
120 * we received a KEEPALIVE (or equivalent).
122 * @param neighbour neighbour to keep alive
125 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour);
128 * We received a KEEP_ALIVE_RESPONSE message and use this to calculate latency
131 * @param neighbour neighbour to keep alive
132 * @param ats performance data
133 * @param ats_count number of entries in ats
136 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
137 const struct GNUNET_ATS_Information *ats,
142 * Change the incoming quota for the given peer.
144 * @param neighbour identity of peer to change qutoa for
145 * @param quota new quota
148 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
149 struct GNUNET_BANDWIDTH_Value32NBO quota);
153 * If we have an active connection to the given target, it must be shutdown.
155 * @param target peer to disconnect from
158 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
162 * Function called for each connected neighbour.
165 * @param neighbour identity of the neighbour
166 * @param ats performance data
167 * @param ats_count number of entries in ats (including 0-termination)
168 * @param address the address (or NULL)
170 typedef void (*GST_NeighbourIterator) (void *cls,
171 const struct GNUNET_PeerIdentity *
173 const struct GNUNET_ATS_Information *
174 ats, uint32_t ats_count,
175 const struct GNUNET_HELLO_Address *
180 * Iterate over all connected neighbours.
182 * @param cb function to call
183 * @param cb_cls closure for cb
186 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
190 * A session was terminated. Take note.
192 * @param peer identity of the peer where the session died
193 * @param session session that is gone
196 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
197 struct Session *session);
201 * For an existing neighbour record, set the active connection to
202 * use the given address.
204 * @param peer identity of the peer to switch the address for
205 * @param address address of the other peer, NULL if other peer
207 * @param session session to use (or NULL)
208 * @param ats performance data
209 * @param ats_count number of entries in ats
210 * @param bandwidth_in inbound quota to be used when connection is up
211 * @param bandwidth_out outbound quota to be used when connection is up
212 * @return GNUNET_YES if we are currently connected, GNUNET_NO if the
213 * connection is not up (yet)
216 GST_neighbours_switch_to_address_3way (const struct GNUNET_PeerIdentity *peer,
217 const struct GNUNET_HELLO_Address
218 *address, struct Session *session,
219 const struct GNUNET_ATS_Information *ats,
221 struct GNUNET_BANDWIDTH_Value32NBO
223 struct GNUNET_BANDWIDTH_Value32NBO
228 * We received a 'SESSION_CONNECT' message from the other peer.
229 * Consider switching to it.
231 * @param message possibly a 'struct SessionConnectMessage' (check format)
232 * @param peer identity of the peer to switch the address for
233 * @param address address of the other peer, NULL if other peer
235 * @param session session to use (or NULL)
236 * @param ats performance data
237 * @param ats_count number of entries in ats (excluding 0-termination)
240 GST_neighbours_handle_connect (const struct GNUNET_MessageHeader *message,
241 const struct GNUNET_PeerIdentity *peer,
242 const struct GNUNET_HELLO_Address *address,
243 struct Session *session,
244 const struct GNUNET_ATS_Information *ats,
249 * We received a 'SESSION_CONNECT_ACK' message from the other peer.
250 * Consider switching to it.
252 * @param message possibly a 'struct SessionConnectMessage' (check format)
253 * @param peer identity of the peer to switch the address for
254 * @param address address of the other peer, NULL if other peer
256 * @param session session to use (or NULL)
257 * @param ats performance data
258 * @param ats_count number of entries in ats
261 GST_neighbours_handle_connect_ack (const struct GNUNET_MessageHeader *message,
262 const struct GNUNET_PeerIdentity *peer,
263 const struct GNUNET_HELLO_Address *address,
264 struct Session *session,
265 const struct GNUNET_ATS_Information *ats,
269 GST_neighbours_handle_ack (const struct GNUNET_MessageHeader *message,
270 const struct GNUNET_PeerIdentity *peer,
271 const struct GNUNET_HELLO_Address *address,
272 struct Session *session,
273 const struct GNUNET_ATS_Information *ats,
278 * Obtain current latency information for the given neighbour.
281 * @return observed latency of the address, FOREVER if the address was
282 * never successfully validated
284 struct GNUNET_TIME_Relative
285 GST_neighbour_get_latency (const struct GNUNET_PeerIdentity *peer);
289 * Obtain current address information for the given neighbour.
292 * @return address currently used
294 struct GNUNET_HELLO_Address *
295 GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer);
299 * We received a disconnect message from the given peer,
300 * validate and process.
302 * @param peer sender of the message
303 * @param msg the disconnect message
306 GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity
308 const struct GNUNET_MessageHeader
313 /* end of file gnunet-service-transport_neighbours.h */