src/mesh/gnunet-service-mesh_peer.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2013 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file mesh/gnunet-service-mesh_peer.h
  23  * @brief mesh service; dealing with remote peers
  24  * @author Bartlomiej Polot
  25  *
  26  * All functions in this file should use the prefix GMP (Gnunet Mesh Peer)
  27  */
  28
  29 #ifndef GNUNET_SERVICE_MESH_PEER_H
  30 #define GNUNET_SERVICE_MESH_PEER_H
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #if 0                           /* keep Emacsens' auto-indent happy */
  36 }
  37 #endif
  38 #endif
  39
  40 #include "platform.h"
  41 #include "gnunet_util_lib.h"
  42
  43 /**
  44  * Struct containing all information regarding a given peer
  45  */
  46 struct MeshPeer;
  47
  48 /**
  49  * Callback called when a queued message is sent.
  50  *
  51  * @param cls Closure.
  52  * @param c Connection this message was on.
  53  * @param wait Time spent waiting for core (only the time for THIS message)
  54  */
  55 typedef void (*GMP_sent) (void *cls,
  56                           struct MeshConnection *c,
  57                           struct GNUNET_TIME_Relative wait);
  58
  59 #include "gnunet-service-mesh_connection.h"
  60
  61
  62 /******************************************************************************/
  63 /********************************    API    ***********************************/
  64 /******************************************************************************/
  65
  66 /**
  67  * Initialize peer subsystem.
  68  *
  69  * @param c Configuration.
  70  */
  71 void
  72 GMP_init (const struct GNUNET_CONFIGURATION_Handle *c);
  73
  74 /**
  75  * Shut down the peer subsystem.
  76  */
  77 void
  78 GMP_shutdown (void);
  79
  80
  81 /**
  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.
  84  *
  85  * @param peer Full identity of the peer.
  86  *
  87  * @return Existing or newly created peer structure.
  88  */
  89 struct MeshPeer *
  90 GMP_get (const struct GNUNET_PeerIdentity *peer_id);
  91
  92
  93 /**
  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.
  96  *
  97  * @param peer Short identity of the peer.
  98  *
  99  * @return Existing or newly created peer structure.
 100  */
 101 struct MeshPeer *
 102 GMP_get_short (const GNUNET_PEER_Id peer);
 103
 104 /**
 105  * @brief Queue and pass message to core when possible.
 106  *
 107  * @param cls Closure (@c type dependant). It will be used by queue_send to
 108  *            build the message to be sent if not already prebuilt.
 109  * @param type Type of the message, 0 for a raw message.
 110  * @param size Size of the message.
 111  * @param c Connection this message belongs to (cannot be NULL).
 112  * @param ch Channel this message belongs to, if applicable (otherwise NULL).
 113  * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
 114  * @param callback Function to be called once CORE has taken the message.
 115  * @param callback_cls Closure for @c callback.
 116  */
 117 void
 118 GMP_queue_add (void *cls, uint16_t type, size_t size,
 119                struct MeshConnection *c,
 120                struct MeshChannel *ch,
 121                int fwd,
 122                GMP_sent callback, void *callback_cls);
 123
 124 /**
 125  * Cancel all queued messages to a peer that belong to a certain connection.
 126  *
 127  * @param peer Peer towards whom to cancel.
 128  * @param c Connection whose queued messages to cancel.
 129  */
 130 void
 131 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c);
 132
 133 void
 134 GMP_queue_unlock (struct MeshPeer *peer, struct MeshConnection *c);
 135
 136 /**
 137  * Set tunnel.
 138  *
 139  * @param peer Peer.
 140  * @param t Tunnel.
 141  */
 142 void
 143 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t);
 144
 145 /**
 146  * Check whether there is a direct (core level)  connection to peer.
 147  *
 148  * @param peer Peer to check.
 149  *
 150  * @return GNUNET_YES if there is a direct connection.
 151  */
 152 int
 153 GMP_is_neighbor (const struct MeshPeer *peer);
 154
 155 /**
 156  * Create and initialize a new tunnel towards a peer, in case it has none.
 157  *
 158  * Does not generate any traffic, just creates the local data structures.
 159  *
 160  * @param peer Peer towards which to create the tunnel.
 161  */
 162 void
 163 GMP_add_tunnel (struct MeshPeer *peer);
 164
 165 /**
 166  * Add a connection to a neighboring peer.
 167  *
 168  * Store that the peer is the first hop of the connection in one
 169  * direction and that on peer disconnect the connection must be
 170  * notified and destroyed, for it will no longer be valid.
 171  *
 172  * @param peer Peer to add connection to.
 173  * @param c Connection to add.
 174  *
 175  * @return GNUNET_OK on success.
 176  */
 177 int
 178 GMP_add_connection (struct MeshPeer *peer, const struct MeshConnection *c);
 179
 180 /**
 181  * Add the path to the peer and update the path used to reach it in case this
 182  * is the shortest.
 183  *
 184  * @param peer_info Destination peer to add the path to.
 185  * @param path New path to add. Last peer must be the peer in arg 1.
 186  *             Path will be either used of freed if already known.
 187  * @param trusted Do we trust that this path is real?
 188  */
 189 void
 190 GMP_add_path (struct MeshPeer *peer, struct MeshPeerPath *p, int trusted);
 191
 192 /**
 193  * Add the path to the origin peer and update the path used to reach it in case
 194  * this is the shortest.
 195  * The path is given in peer_info -> destination, therefore we turn the path
 196  * upside down first.
 197  *
 198  * @param peer_info Peer to add the path to, being the origin of the path.
 199  * @param path New path to add after being inversed.
 200  *             Path will be either used or freed.
 201  * @param trusted Do we trust that this path is real?
 202  */
 203 void
 204 GMP_add_path_to_origin (struct MeshPeer *peer_info,
 205                         struct MeshPeerPath *path,
 206                         int trusted);
 207
 208 /**
 209  * Adds a path to the info of all the peers in the path
 210  *
 211  * @param p Path to process.
 212  * @param confirmed Whether we know if the path works or not.
 213  */
 214 void
 215 GMP_add_path_to_all (struct MeshPeerPath *p, int confirmed);
 216
 217 /**
 218  * Remove a connection from a neighboring peer.
 219  *
 220  * @param peer Peer to remove connection from.
 221  * @param c Connection to remove.
 222  *
 223  * @return GNUNET_OK on success.
 224  */
 225 int
 226 GMP_remove_connection (struct MeshPeer *peer, struct MeshConnection *c);
 227
 228 void
 229 GMP_start_search (struct MeshPeer *peer);
 230
 231 void
 232 GMP_stop_search (struct MeshPeer *peer);
 233
 234 /**
 235  * Get the Full ID of a peer.
 236  *
 237  * @param peer Peer to get from.
 238  *
 239  * @return Full ID of peer.
 240  */
 241 struct GNUNET_PeerIdentity *
 242 GMP_get_id (const struct MeshPeer *peer);
 243
 244 /**
 245  * Get the Short ID of a peer.
 246  *
 247  * @param peer Peer to get from.
 248  *
 249  * @return Short ID of peer.
 250  */
 251 GNUNET_PEER_Id
 252 GMP_get_short_id (const struct MeshPeer *peer);
 253
 254 /**
 255  * Get the static string for a peer ID.
 256  *
 257  * @param peer Peer.
 258  *
 259  * @return Static string for it's ID.
 260  */
 261 const char *
 262 GMP_2s (const struct MeshPeer *peer);
 263
 264
 265 #if 0                           /* keep Emacsens' auto-indent happy */
 266 {
 267 #endif
 268 #ifdef __cplusplus
 269 }
 270 #endif
 271
 272 /* ifndef GNUNET_MESH_SERVICE_PEER_H */
 273 #endif
 274 /* end of gnunet-mesh-service_peer.h */