2 This file is part of GNUnet.
3 (C) 2013 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 mesh/gnunet-service-mesh_peer.h
23 * @brief mesh service; dealing with remote peers
24 * @author Bartlomiej Polot
26 * All functions in this file should use the prefix GMP (Gnunet Mesh Peer)
29 #ifndef GNUNET_SERVICE_MESH_PEER_H
30 #define GNUNET_SERVICE_MESH_PEER_H
35 #if 0 /* keep Emacsens' auto-indent happy */
41 #include "gnunet_util_lib.h"
44 * Struct containing all information regarding a given peer
48 #include "gnunet-service-mesh_connection.h"
51 * Callback called when a queued message is sent.
54 * @param c Connection this message was on.
55 * @param type Type of message sent.
56 * @param fwd Was this a FWD going message?
57 * @param size Size of the message.
58 * @param wait Time spent waiting for core (only the time for THIS message)
60 typedef void (*GMP_sent) (void *cls,
61 struct MeshConnection *c, uint16_t type,
63 struct GNUNET_TIME_Relative wait);
65 /******************************************************************************/
66 /******************************** API ***********************************/
67 /******************************************************************************/
70 * Initialize peer subsystem.
72 * @param c Configuration.
75 GMP_init (const struct GNUNET_CONFIGURATION_Handle *c);
78 * Shut down the peer subsystem.
85 * Retrieve the MeshPeer stucture associated with the peer, create one
86 * and insert it in the appropriate structures if the peer is not known yet.
88 * @param peer Full identity of the peer.
90 * @return Existing or newly created peer structure.
93 GMP_get (const struct GNUNET_PeerIdentity *peer_id);
97 * Retrieve the MeshPeer stucture associated with the peer, create one
98 * and insert it in the appropriate structures if the peer is not known yet.
100 * @param peer Short identity of the peer.
102 * @return Existing or newly created peer structure.
105 GMP_get_short (const GNUNET_PEER_Id peer);
108 * Try to establish a new connection to this peer (in its tunnel).
109 * If the peer doesn't have any path to it yet, try to get one.
110 * If the peer already has some path, send a CREATE CONNECTION towards it.
112 * @param peer Peer to connect to.
115 GMP_connect (struct MeshPeer *peer);
118 * @brief Queue and pass message to core when possible.
120 * @param peer Peer towards which to queue the message.
121 * @param cls Closure (@c type dependant). It will be used by queue_send to
122 * build the message to be sent if not already prebuilt.
123 * @param type Type of the message, 0 for a raw message.
124 * @param size Size of the message.
125 * @param c Connection this message belongs to (cannot be NULL).
126 * @param ch Channel this message belongs to, if applicable (otherwise NULL).
127 * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
128 * @param cont Continuation to be called once CORE has taken the message.
129 * @param cont_cls Closure for @c cont.
132 GMP_queue_add (struct MeshPeer *peer, void *cls, uint16_t type, size_t size,
133 struct MeshConnection *c, struct MeshChannel *ch, int fwd,
134 GMP_sent cont, void *cont_cls);
137 * Cancel all queued messages to a peer that belong to a certain connection.
139 * @param peer Peer towards whom to cancel.
140 * @param c Connection whose queued messages to cancel.
143 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c);
146 GMP_queue_unlock (struct MeshPeer *peer, struct MeshConnection *c);
155 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t);
158 * Check whether there is a direct (core level) connection to peer.
160 * @param peer Peer to check.
162 * @return GNUNET_YES if there is a direct connection.
165 GMP_is_neighbor (const struct MeshPeer *peer);
168 * Create and initialize a new tunnel towards a peer, in case it has none.
170 * Does not generate any traffic, just creates the local data structures.
172 * @param peer Peer towards which to create the tunnel.
175 GMP_add_tunnel (struct MeshPeer *peer);
178 * Add a connection to a neighboring peer.
180 * Store that the peer is the first hop of the connection in one
181 * direction and that on peer disconnect the connection must be
182 * notified and destroyed, for it will no longer be valid.
184 * @param peer Peer to add connection to.
185 * @param c Connection to add.
187 * @return GNUNET_OK on success.
190 GMP_add_connection (struct MeshPeer *peer, struct MeshConnection *c);
193 * Add the path to the peer and update the path used to reach it in case this
196 * @param peer_info Destination peer to add the path to.
197 * @param path New path to add. Last peer must be the peer in arg 1.
198 * Path will be either used of freed if already known.
199 * @param trusted Do we trust that this path is real?
202 GMP_add_path (struct MeshPeer *peer, struct MeshPeerPath *p, int trusted);
205 * Add the path to the origin peer and update the path used to reach it in case
206 * this is the shortest.
207 * The path is given in peer_info -> destination, therefore we turn the path
210 * @param peer_info Peer to add the path to, being the origin of the path.
211 * @param path New path to add after being inversed.
212 * Path will be either used or freed.
213 * @param trusted Do we trust that this path is real?
216 GMP_add_path_to_origin (struct MeshPeer *peer_info,
217 struct MeshPeerPath *path,
221 * Adds a path to the info of all the peers in the path
223 * @param p Path to process.
224 * @param confirmed Whether we know if the path works or not.
227 GMP_add_path_to_all (const struct MeshPeerPath *p, int confirmed);
230 * Remove a connection from a neighboring peer.
232 * @param peer Peer to remove connection from.
233 * @param c Connection to remove.
235 * @return GNUNET_OK on success.
238 GMP_remove_connection (struct MeshPeer *peer, const struct MeshConnection *c);
241 * Start the DHT search for new paths towards the peer: we don't have
242 * enough good connections.
244 * @param peer Destination peer.
247 GMP_start_search (struct MeshPeer *peer);
250 * Stop the DHT search for new paths towards the peer: we already have
251 * enough good connections.
253 * @param peer Destination peer.
256 GMP_stop_search (struct MeshPeer *peer);
259 * Get the Full ID of a peer.
261 * @param peer Peer to get from.
263 * @return Full ID of peer.
265 const struct GNUNET_PeerIdentity *
266 GMP_get_id (const struct MeshPeer *peer);
269 * Get the Short ID of a peer.
271 * @param peer Peer to get from.
273 * @return Short ID of peer.
276 GMP_get_short_id (const struct MeshPeer *peer);
279 * Get the tunnel towards a peer.
281 * @param peer Peer to get from.
283 * @return Tunnel towards peer.
286 GMP_get_tunnel (const struct MeshPeer *peer);
289 * Get the static string for a peer ID.
293 * @return Static string for it's ID.
296 GMP_2s (const struct MeshPeer *peer);
299 #if 0 /* keep Emacsens' auto-indent happy */
306 /* ifndef GNUNET_MESH_SERVICE_PEER_H */
308 /* end of gnunet-mesh-service_peer.h */