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
49 * Callback called when a queued message is sent.
52 * @param c Connection this message was on.
53 * @param wait Time spent waiting for core (only the time for THIS message)
55 typedef void (*GMP_sent) (void *cls,
56 struct MeshConnection *c,
57 struct GNUNET_TIME_Relative wait);
59 #include "gnunet-service-mesh_connection.h"
62 /******************************************************************************/
63 /******************************** API ***********************************/
64 /******************************************************************************/
67 * Initialize peer subsystem.
69 * @param c Configuration.
72 GMP_init (const struct GNUNET_CONFIGURATION_Handle *c);
75 * Shut down the peer subsystem.
82 * Retrieve the MeshPeer stucture associated with the peer, create one
83 * and insert it in the appropriate structures if the peer is not known yet.
85 * @param peer Full identity of the peer.
87 * @return Existing or newly created peer structure.
90 GMP_get (const struct GNUNET_PeerIdentity *peer_id);
94 * Retrieve the MeshPeer stucture associated with the peer, create one
95 * and insert it in the appropriate structures if the peer is not known yet.
97 * @param peer Short identity of the peer.
99 * @return Existing or newly created peer structure.
102 GMP_get_short (const GNUNET_PEER_Id peer);
105 * Try to establish a new connection to this peer (in its tunnel).
106 * If the peer doesn't have any path to it yet, try to get one.
107 * If the peer already has some path, send a CREATE CONNECTION towards it.
109 * @param peer Peer to connect to.
112 GMP_connect (struct MeshPeer *peer);
115 * @brief Queue and pass message to core when possible.
117 * @param cls Closure (@c type dependant). It will be used by queue_send to
118 * build the message to be sent if not already prebuilt.
119 * @param type Type of the message, 0 for a raw message.
120 * @param size Size of the message.
121 * @param c Connection this message belongs to (cannot be NULL).
122 * @param ch Channel this message belongs to, if applicable (otherwise NULL).
123 * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
124 * @param callback Function to be called once CORE has taken the message.
125 * @param callback_cls Closure for @c callback.
128 GMP_queue_add (void *cls, uint16_t type, size_t size,
129 struct MeshConnection *c,
130 struct MeshChannel *ch,
132 GMP_sent callback, void *callback_cls);
135 * Cancel all queued messages to a peer that belong to a certain connection.
137 * @param peer Peer towards whom to cancel.
138 * @param c Connection whose queued messages to cancel.
141 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c);
144 GMP_queue_unlock (struct MeshPeer *peer, struct MeshConnection *c);
153 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t);
156 * Check whether there is a direct (core level) connection to peer.
158 * @param peer Peer to check.
160 * @return GNUNET_YES if there is a direct connection.
163 GMP_is_neighbor (const struct MeshPeer *peer);
166 * Create and initialize a new tunnel towards a peer, in case it has none.
168 * Does not generate any traffic, just creates the local data structures.
170 * @param peer Peer towards which to create the tunnel.
173 GMP_add_tunnel (struct MeshPeer *peer);
176 * Add a connection to a neighboring peer.
178 * Store that the peer is the first hop of the connection in one
179 * direction and that on peer disconnect the connection must be
180 * notified and destroyed, for it will no longer be valid.
182 * @param peer Peer to add connection to.
183 * @param c Connection to add.
185 * @return GNUNET_OK on success.
188 GMP_add_connection (struct MeshPeer *peer, struct MeshConnection *c);
191 * Add the path to the peer and update the path used to reach it in case this
194 * @param peer_info Destination peer to add the path to.
195 * @param path New path to add. Last peer must be the peer in arg 1.
196 * Path will be either used of freed if already known.
197 * @param trusted Do we trust that this path is real?
200 GMP_add_path (struct MeshPeer *peer, struct MeshPeerPath *p, int trusted);
203 * Add the path to the origin peer and update the path used to reach it in case
204 * this is the shortest.
205 * The path is given in peer_info -> destination, therefore we turn the path
208 * @param peer_info Peer to add the path to, being the origin of the path.
209 * @param path New path to add after being inversed.
210 * Path will be either used or freed.
211 * @param trusted Do we trust that this path is real?
214 GMP_add_path_to_origin (struct MeshPeer *peer_info,
215 struct MeshPeerPath *path,
219 * Adds a path to the info of all the peers in the path
221 * @param p Path to process.
222 * @param confirmed Whether we know if the path works or not.
225 GMP_add_path_to_all (struct MeshPeerPath *p, int confirmed);
228 * Remove a connection from a neighboring peer.
230 * @param peer Peer to remove connection from.
231 * @param c Connection to remove.
233 * @return GNUNET_OK on success.
236 GMP_remove_connection (struct MeshPeer *peer, const struct MeshConnection *c);
239 GMP_start_search (struct MeshPeer *peer);
242 GMP_stop_search (struct MeshPeer *peer);
245 * Get the Full ID of a peer.
247 * @param peer Peer to get from.
249 * @return Full ID of peer.
251 const struct GNUNET_PeerIdentity *
252 GMP_get_id (const struct MeshPeer *peer);
255 * Get the Short ID of a peer.
257 * @param peer Peer to get from.
259 * @return Short ID of peer.
262 GMP_get_short_id (const struct MeshPeer *peer);
265 * Get the static string for a peer ID.
269 * @return Static string for it's ID.
272 GMP_2s (const struct MeshPeer *peer);
275 #if 0 /* keep Emacsens' auto-indent happy */
282 /* ifndef GNUNET_MESH_SERVICE_PEER_H */
284 /* end of gnunet-mesh-service_peer.h */