2 This file is part of GNUnet.
3 Copyright (C) 2013 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file cadet/gnunet-service-cadet_peer.h
23 * @brief cadet service; dealing with remote peers
24 * @author Bartlomiej Polot
26 * All functions in this file should use the prefix GMP (Gnunet Cadet Peer)
29 #ifndef GNUNET_SERVICE_CADET_PEER_H
30 #define GNUNET_SERVICE_CADET_PEER_H
35 #if 0 /* keep Emacsens' auto-indent happy */
41 #include "gnunet_util_lib.h"
42 #include "cadet_path.h"
45 * Struct containing all information regarding a given peer
50 * Struct containing info about a queued transmission to this peer
52 struct CadetPeerQueue;
54 #include "gnunet-service-cadet_connection.h"
58 * Callback called when a queued message is sent.
61 * @param c Connection this message was on.
62 * @param sent Was it really sent? (Could have been canceled)
63 * @param type Type of message sent.
64 * @param pid Packet ID, or 0 if not applicable (create, destroy, etc).
65 * @param fwd Was this a FWD going message?
66 * @param size Size of the message.
67 * @param wait Time spent waiting for core (only the time for THIS message)
68 * @return #GNUNET_YES if connection was destroyed, #GNUNET_NO otherwise.
71 (*GCP_sent) (void *cls,
72 struct CadetConnection *c, int sent,
73 uint16_t type, uint32_t pid, int fwd, size_t size,
74 struct GNUNET_TIME_Relative wait);
80 * @param peer Peer this path is towards.
81 * @param path Path itself
82 * @return #GNUNET_YES if should keep iterating.
83 * #GNUNET_NO otherwise.
86 (*GCP_path_iterator) (void *cls,
87 struct CadetPeer *peer,
88 struct CadetPeerPath *path);
91 /******************************************************************************/
92 /******************************** API ***********************************/
93 /******************************************************************************/
96 * Initialize peer subsystem.
98 * @param c Configuration.
101 GCP_init (const struct GNUNET_CONFIGURATION_Handle *c);
104 * Shut down the peer subsystem.
111 * Retrieve the CadetPeer stucture associated with the peer. Optionally create
112 * one and insert it in the appropriate structures if the peer is not known yet.
114 * @param peer_id Full identity of the peer.
115 * @param create #GNUNET_YES if a new peer should be created if unknown.
116 * #GNUNET_NO otherwise.
118 * @return Existing or newly created peer structure.
119 * NULL if unknown and not requested @a create
122 GCP_get (const struct GNUNET_PeerIdentity *peer_id, int create);
125 * Retrieve the CadetPeer stucture associated with the peer. Optionally create
126 * one and insert it in the appropriate structures if the peer is not known yet.
128 * @param peer Short identity of the peer.
129 * @param create #GNUNET_YES if a new peer should be created if unknown.
130 * #GNUNET_NO otherwise.
132 * @return Existing or newly created peer structure.
133 * NULL if unknown and not requested @a create
136 GCP_get_short (const GNUNET_PEER_Id peer, int create);
139 * Try to establish a new connection to this peer (in its tunnel).
140 * If the peer doesn't have any path to it yet, try to get one.
141 * If the peer already has some path, send a CREATE CONNECTION towards it.
143 * @param peer Peer to connect to.
146 GCP_connect (struct CadetPeer *peer);
149 * Free a transmission that was already queued with all resources
150 * associated to the request.
152 * If connection was marked to be destroyed, and this was the last queued
153 * message on it, the connection will be free'd as a result.
155 * @param queue Queue handler to cancel.
156 * @param clear_cls Is it necessary to free associated cls?
157 * @param sent Was it really sent? (Could have been canceled)
158 * @param pid PID, if relevant (was sent and was a payload message).
160 * @return #GNUNET_YES if connection was destroyed as a result,
161 * #GNUNET_NO otherwise.
164 GCP_queue_destroy (struct CadetPeerQueue *queue, int clear_cls,
165 int sent, uint32_t pid);
168 * @brief Queue and pass message to core when possible.
170 * @param peer Peer towards which to queue the message.
171 * @param cls Closure (@c type dependant). It will be used by queue_send to
172 * build the message to be sent if not already prebuilt.
173 * @param type Type of the message.
174 * @param payload_type Type of the message's payload
175 * 0 if the message is a retransmission (unknown payload).
176 * UINT16_MAX if the message does not have payload.
177 * @param payload_id ID of the payload (MID, ACK #, etc)
178 * @param size Size of the message.
179 * @param c Connection this message belongs to (can be NULL).
180 * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
181 * @param cont Continuation to be called once CORE has taken the message.
182 * @param cont_cls Closure for @c cont.
184 * @return Handle to cancel the message before it is sent. Once cont is called
185 * message has been sent and therefore the handle is no longer valid.
187 struct CadetPeerQueue *
188 GCP_queue_add (struct CadetPeer *peer,
191 uint16_t payload_type,
194 struct CadetConnection *c,
200 * Cancel all queued messages to a peer that belong to a certain connection.
202 * @param peer Peer towards whom to cancel.
203 * @param c Connection whose queued messages to cancel. Might be destroyed by
204 * the sent continuation call.
207 GCP_queue_cancel (struct CadetPeer *peer, struct CadetConnection *c);
210 * Get the first message for a connection and unqueue it.
212 * Only tunnel (or higher) level messages are unqueued. Connection specific
213 * messages are silently destroyed upon encounter.
215 * @param peer Neighboring peer.
216 * @param c Connection.
217 * @param destroyed[in/out] Was the connection destroyed as a result?.
221 * @return First message for this connection.
223 struct GNUNET_MessageHeader *
224 GCP_connection_pop (struct CadetPeer *peer,
225 struct CadetConnection *c,
229 * Unlock a possibly locked queue for a connection.
231 * If there is a message that can be sent on this connection, call core for it.
232 * Otherwise (if core transmit is already called or there is no sendable
233 * message) do nothing.
235 * @param peer Peer who keeps the queue.
236 * @param c Connection whose messages to unlock.
239 GCP_queue_unlock (struct CadetPeer *peer, struct CadetConnection *c);
248 GCP_set_tunnel (struct CadetPeer *peer, struct CadetTunnel *t);
252 * Check whether there is a direct (core level) connection to peer.
254 * @param peer Peer to check.
256 * @return #GNUNET_YES if there is a direct connection.
259 GCP_is_neighbor (const struct CadetPeer *peer);
263 * Create and initialize a new tunnel towards a peer, in case it has none.
265 * Does not generate any traffic, just creates the local data structures.
267 * @param peer Peer towards which to create the tunnel.
270 GCP_add_tunnel (struct CadetPeer *peer);
274 * Add a connection to a neighboring peer.
276 * Store that the peer is the first hop of the connection in one
277 * direction and that on peer disconnect the connection must be
278 * notified and destroyed, for it will no longer be valid.
280 * @param peer Peer to add connection to.
281 * @param c Connection to add.
282 * @param pred #GNUNET_YES if we are predecessor, #GNUNET_NO if we are successor
285 GCP_add_connection (struct CadetPeer *peer,
286 struct CadetConnection *c,
291 * Add the path to the peer and update the path used to reach it in case this
294 * @param peer Destination peer to add the path to.
295 * @param path New path to add. Last peer must be the peer in arg 1.
296 * Path will be either used of freed if already known.
297 * @param trusted Do we trust that this path is real?
299 * @return path if path was taken, pointer to existing duplicate if exists
302 struct CadetPeerPath *
303 GCP_add_path (struct CadetPeer *peer,
304 struct CadetPeerPath *p,
309 * Add the path to the origin peer and update the path used to reach it in case
310 * this is the shortest.
311 * The path is given in peer_info -> destination, therefore we turn the path
314 * @param peer Peer to add the path to, being the origin of the path.
315 * @param path New path to add after being inversed.
316 * Path will be either used or freed.
317 * @param trusted Do we trust that this path is real?
319 * @return path if path was taken, pointer to existing duplicate if exists
322 struct CadetPeerPath *
323 GCP_add_path_to_origin (struct CadetPeer *peer,
324 struct CadetPeerPath *path,
328 * Adds a path to the info of all the peers in the path
330 * @param p Path to process.
331 * @param confirmed Whether we know if the path works or not.
334 GCP_add_path_to_all (const struct CadetPeerPath *p, int confirmed);
338 * Remove any path to the peer that has the extact same peers as the one given.
340 * @param peer Peer to remove the path from.
341 * @param path Path to remove. Is always destroyed .
344 GCP_remove_path (struct CadetPeer *peer,
345 struct CadetPeerPath *path);
349 * Check that we are aware of a connection from a neighboring peer.
351 * @param peer Peer to the connection is with
352 * @param c Connection that should be in the map with this peer.
355 GCP_check_connection (const struct CadetPeer *peer,
356 const struct CadetConnection *c);
360 * Remove a connection from a neighboring peer.
362 * @param peer Peer to remove connection from.
363 * @param c Connection to remove.
366 GCP_remove_connection (struct CadetPeer *peer,
367 const struct CadetConnection *c);
371 * Start the DHT search for new paths towards the peer: we don't have
372 * enough good connections.
374 * @param peer Destination peer.
377 GCP_start_search (struct CadetPeer *peer);
381 * Stop the DHT search for new paths towards the peer: we already have
382 * enough good connections.
384 * @param peer Destination peer.
387 GCP_stop_search (struct CadetPeer *peer);
391 * Get the Full ID of a peer.
393 * @param peer Peer to get from.
395 * @return Full ID of peer.
397 const struct GNUNET_PeerIdentity *
398 GCP_get_id (const struct CadetPeer *peer);
402 * Get the Short ID of a peer.
404 * @param peer Peer to get from.
406 * @return Short ID of peer.
409 GCP_get_short_id (const struct CadetPeer *peer);
413 * Get the tunnel towards a peer.
415 * @param peer Peer to get from.
417 * @return Tunnel towards peer.
420 GCP_get_tunnel (const struct CadetPeer *peer);
424 * Set the hello message.
426 * @param peer Peer whose message to set.
427 * @param hello Hello message.
430 GCP_set_hello (struct CadetPeer *peer,
431 const struct GNUNET_HELLO_Message *hello);
435 * Get the hello message.
437 * @param peer Peer whose message to get.
439 * @return Hello message.
441 struct GNUNET_HELLO_Message *
442 GCP_get_hello (struct CadetPeer *peer);
446 * Try to connect to a peer on TRANSPORT level.
448 * @param peer Peer to whom to connect.
451 GCP_try_connect (struct CadetPeer *peer);
454 * Notify a peer that a link between two other peers is broken. If any path
455 * used that link, eliminate it.
457 * @param peer Peer affected by the change.
458 * @param peer1 Peer whose link is broken.
459 * @param peer2 Peer whose link is broken.
462 GCP_notify_broken_link (struct CadetPeer *peer,
463 const struct GNUNET_PeerIdentity *peer1,
464 const struct GNUNET_PeerIdentity *peer2);
468 * Count the number of known paths toward the peer.
470 * @param peer Peer to get path info.
472 * @return Number of known paths.
475 GCP_count_paths (const struct CadetPeer *peer);
478 * Iterate over the paths to a peer.
480 * @param peer Peer to get path info.
481 * @param callback Function to call for every path.
482 * @param cls Closure for @a callback.
484 * @return Number of iterated paths.
487 GCP_iterate_paths (struct CadetPeer *peer,
488 GCP_path_iterator callback,
493 * Iterate all known peers.
495 * @param iter Iterator.
496 * @param cls Closure for @c iter.
499 GCP_iterate_all (GNUNET_CONTAINER_PeerMapIterator iter, void *cls);
503 * Get the static string for a peer ID.
507 * @return Static string for it's ID.
510 GCP_2s (const struct CadetPeer *peer);
514 * Log all kinds of info about a peer.
519 GCP_debug (const struct CadetPeer *p,
520 enum GNUNET_ErrorType level);
523 #if 0 /* keep Emacsens' auto-indent happy */
530 /* ifndef GNUNET_CADET_SERVICE_PEER_H */
532 /* end of gnunet-cadet-service_peer.h */