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.
81 * @brief Queue and pass message to core when possible.
83 * @param cls Closure (@c type dependant). It will be used by queue_send to
84 * build the message to be sent if not already prebuilt.
85 * @param type Type of the message, 0 for a raw message.
86 * @param size Size of the message.
87 * @param c Connection this message belongs to (cannot be NULL).
88 * @param ch Channel this message belongs to, if applicable (otherwise NULL).
89 * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
90 * @param callback Function to be called once CORE has taken the message.
91 * @param callback_cls Closure for @c callback.
94 GMP_queue_add (void *cls, uint16_t type, size_t size,
95 struct MeshConnection *c,
96 struct MeshChannel *ch,
98 GMP_sent callback, void *callback_cls);
101 * Cancel all queued messages to a peer that belong to a certain connection.
103 * @param peer Peer towards whom to cancel.
104 * @param c Connection whose queued messages to cancel.
107 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c);
116 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t);
119 * Check whether there is a direct (core level) connection to peer.
121 * @param peer Peer to check.
123 * @return GNUNET_YES if there is a direct connection.
126 GMP_is_neighbor (const struct MeshPeer *peer);
130 * Add a connection to a neighboring peer.
132 * Store that the peer is the first hop of the connection in one
133 * direction and that on peer disconnect the connection must be
134 * notified and destroyed, for it will no longer be valid.
136 * @param peer Peer to add connection to.
137 * @param c Connection to add.
139 * @return GNUNET_OK on success.
142 GMP_add_connection (struct MeshPeer *peer, struct MeshConnection *c);
145 * Remove a connection from a neighboring peer.
147 * @param peer Peer to remove connection from.
148 * @param c Connection to remove.
150 * @return GNUNET_OK on success.
153 GMP_remove_connection (struct MeshPeer *peer, struct MeshConnection *c);
156 GMP_start_search (struct MeshPeer *peer);
159 GMP_stop_search (struct MeshPeer *peer);
162 * Get the Full ID of a peer.
164 * @param peer Peer to get from.
166 * @return Full ID of peer.
168 struct GNUNET_PeerIdentity *
169 GMP_get_id (const struct MeshPeer *peer);
172 * Get the Short ID of a peer.
174 * @param peer Peer to get from.
176 * @return Short ID of peer.
179 GMP_get_short_id (const struct MeshPeer *peer);
182 * Get the static string for a peer ID.
186 * @return Static string for it's ID.
189 GMP_2s (const struct MeshPeer *peer);
192 #if 0 /* keep Emacsens' auto-indent happy */
199 /* ifndef GNUNET_MESH_SERVICE_PEER_H */
201 /* end of gnunet-mesh-service_peer.h */