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-service-transport.h"
33 #include "transport.h"
34 #include "gnunet_util_lib.h"
37 // - ATS and similar info is a bit lacking in the API right now...
42 * Initialize the neighbours subsystem.
44 * @param cls closure for callbacks
45 * @param connect_cb function to call if we connect to a peer
46 * @param disconnect_cb function to call if we disconnect from a peer
47 * @param peer_address_cb function to call if a neighbour's active address changes
48 * @param max_fds maximum number of fds to use
51 GST_neighbours_start (void *cls,
52 NotifyConnect connect_cb,
53 GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb,
54 GNUNET_TRANSPORT_NeighbourChangeCallback peer_address_cb,
55 unsigned int max_fds);
59 * Cleanup the neighbours subsystem.
62 GST_neighbours_stop (void);
66 * Try to create a connection to the given target (eventually).
68 * @param target peer to try to connect to
71 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target);
75 * Test if we're connected to the given peer.
77 * @param target peer to test
78 * @return #GNUNET_YES if we are connected, #GNUNET_NO if not
81 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
85 * Function called after the transmission is done.
88 * @param success #GNUNET_OK on success, #GNUNET_NO on failure, #GNUNET_SYSERR if we're not connected
89 * @param bytes_payload how much payload was transmitted
90 * @param bytes_on_wire how many bytes were used on the wire
93 (*GST_NeighbourSendContinuation) (void *cls,
96 size_t bytes_on_wire);
100 * Transmit a message to the given target using the active connection.
102 * @param target destination
103 * @param msg message to send
104 * @param msg_size number of bytes in @a msg
105 * @param timeout when to fail with timeout
106 * @param cont function to call when done
107 * @param cont_cls closure for @a cont
110 GST_neighbours_send (const struct GNUNET_PeerIdentity *target,
113 struct GNUNET_TIME_Relative timeout,
114 GST_NeighbourSendContinuation cont, void *cont_cls);
122 GST_neighbours_register_quota_notification (void *cls,
123 const struct GNUNET_PeerIdentity *peer,
125 struct Session *session);
132 GST_neighbours_unregister_quota_notification (void *cls,
133 const struct GNUNET_PeerIdentity *peer,
135 struct Session *session);
139 * We have received a message from the given sender.
140 * How long should we delay before receiving more?
141 * (Also used to keep the peer marked as live).
143 * @param sender sender of the message
144 * @param size size of the message
145 * @param do_forward set to #GNUNET_YES if the message should be forwarded to clients
146 * #GNUNET_NO if the neighbour is not connected or violates the quota
147 * @return how long to wait before reading more from this sender
149 struct GNUNET_TIME_Relative
150 GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity *sender,
156 * Keep the connection to the given neighbour alive longer,
157 * we received a KEEPALIVE (or equivalent); send a response.
159 * @param neighbour neighbour to keep alive (by sending keep alive response)
160 * @param m the keep alive message containing the nonce to respond to
163 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour,
164 const struct GNUNET_MessageHeader *m);
168 * We received a KEEP_ALIVE_RESPONSE message and use this to calculate
169 * latency to this peer. Pass the updated information (existing ats
170 * plus calculated latency) to ATS.
172 * @param neighbour neighbour to keep alive
173 * @param m the message containing the keep alive response
176 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
177 const struct GNUNET_MessageHeader *m);
181 * Change the incoming quota for the given peer.
183 * @param neighbour identity of peer to change qutoa for
184 * @param quota new quota
187 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
188 struct GNUNET_BANDWIDTH_Value32NBO quota);
192 * If we have an active connection to the given target, it must be shutdown.
194 * @param target peer to disconnect from
197 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
201 * Function called for each neighbour.
204 * @param neighbour identity of the neighbour
205 * @param address the address (or NULL)
206 * @param state current state the peer is in
207 * @param state_timeout timeout for this state
208 * @param bandwidth_in inbound quota in NBO
209 * @param bandwidth_out outbound quota in NBO
212 (*GST_NeighbourIterator) (void *cls,
213 const struct GNUNET_PeerIdentity *neighbour,
214 const struct GNUNET_HELLO_Address *address,
215 enum GNUNET_TRANSPORT_PeerState state,
216 struct GNUNET_TIME_Absolute state_timeout,
217 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
218 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
222 * Iterate over all connected neighbours.
224 * @param cb function to call
225 * @param cb_cls closure for @a cb
228 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
232 * A session was terminated. Take note.
234 * @param peer identity of the peer where the session died
235 * @param session session that is gone
236 * @return #GNUNET_YES if this was a session used, #GNUNET_NO if
237 * this session was not in use
240 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
241 struct Session *session);
248 GST_neighbours_notify_data_recv (const struct GNUNET_PeerIdentity *peer,
249 const struct GNUNET_HELLO_Address *address,
250 struct Session *session,
251 const struct GNUNET_MessageHeader *message);
258 GST_neighbours_notify_payload_recv (const struct GNUNET_PeerIdentity *peer,
259 const struct GNUNET_HELLO_Address *address,
260 struct Session *session,
261 const struct GNUNET_MessageHeader *message);
268 GST_neighbours_notify_payload_sent (const struct GNUNET_PeerIdentity *peer,
276 GST_neighbours_notify_data_sent (const struct GNUNET_PeerIdentity *peer,
277 const struct GNUNET_HELLO_Address *address,
278 struct Session *session,
283 * For an existing neighbour record, set the active connection to
284 * use the given address.
286 * @param peer identity of the peer to switch the address for
287 * @param address address of the other peer, NULL if other peer
289 * @param session session to use (or NULL)
290 * @param bandwidth_in inbound quota to be used when connection is up
291 * @param bandwidth_out outbound quota to be used when connection is up
294 GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
295 const struct GNUNET_HELLO_Address *address,
296 struct Session *session,
297 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
298 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
302 * We received a 'SESSION_CONNECT' message from the other peer.
303 * Consider switching to it.
305 * @param message possibly a 'struct SessionConnectMessage' (check format)
306 * @param peer identity of the peer to switch the address for
307 * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
310 GST_neighbours_handle_session_syn (const struct GNUNET_MessageHeader *message,
311 const struct GNUNET_PeerIdentity *peer);
315 * We received a 'SESSION_CONNECT_ACK' message from the other peer.
316 * Consider switching to it.
318 * @param message possibly a `struct SessionConnectMessage` (check format)
319 * @param peer identity of the peer to switch the address for
320 * @param address address of the other peer, NULL if other peer
322 * @param session session to use (or NULL)
323 * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
326 GST_neighbours_handle_session_syn_ack (const struct GNUNET_MessageHeader *message,
327 const struct GNUNET_PeerIdentity *peer,
328 const struct GNUNET_HELLO_Address *address,
329 struct Session *session);
333 * We received a 'SESSION_ACK' message from the other peer.
334 * If we sent a 'CONNECT_ACK' last, this means we are now
335 * connected. Otherwise, do nothing.
337 * @param message possibly a 'struct SessionConnectMessage' (check format)
338 * @param peer identity of the peer to switch the address for
339 * @param address address of the other peer, NULL if other peer
341 * @param session session to use (or NULL)
342 * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
345 GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
346 const struct GNUNET_PeerIdentity *peer,
347 const struct GNUNET_HELLO_Address *address,
348 struct Session *session);
352 * Obtain current latency information for the given neighbour.
355 * @return observed latency of the address, FOREVER if the address was
356 * never successfully validated
358 struct GNUNET_TIME_Relative
359 GST_neighbour_get_latency (const struct GNUNET_PeerIdentity *peer);
363 * Obtain current address information for the given neighbour.
366 * @return address currently used
368 struct GNUNET_HELLO_Address *
369 GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer);
373 * We received a disconnect message from the given peer,
374 * validate and process.
376 * @param peer sender of the message
377 * @param msg the disconnect message
380 GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity *peer,
381 const struct GNUNET_MessageHeader *msg);
385 /* end of file gnunet-service-transport_neighbours.h */