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 #include "gnunet-service-mesh_connection.h"
  49
  50 /**
  51  * Callback called when a queued message is sent.
  52  *
  53  * @param cls Closure.
  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)
  59  */
  60 typedef void (*GMP_sent) (void *cls,
  61                           struct MeshConnection *c, uint16_t type,
  62                           int fwd, size_t size,
  63                           struct GNUNET_TIME_Relative wait);
  64
  65 /******************************************************************************/
  66 /********************************    API    ***********************************/
  67 /******************************************************************************/
  68
  69 /**
  70  * Initialize peer subsystem.
  71  *
  72  * @param c Configuration.
  73  */
  74 void
  75 GMP_init (const struct GNUNET_CONFIGURATION_Handle *c);
  76
  77 /**
  78  * Shut down the peer subsystem.
  79  */
  80 void
  81 GMP_shutdown (void);
  82
  83
  84 /**
  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.
  87  *
  88  * @param peer_id Full identity of the peer.
  89  *
  90  * @return Existing or newly created peer structure.
  91  */
  92 struct MeshPeer *
  93 GMP_get (const struct GNUNET_PeerIdentity *peer_id);
  94
  95
  96 /**
  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.
  99  *
 100  * @param peer Short identity of the peer.
 101  *
 102  * @return Existing or newly created peer structure.
 103  */
 104 struct MeshPeer *
 105 GMP_get_short (const GNUNET_PEER_Id peer);
 106
 107 /**
 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.
 111  *
 112  * @param peer Peer to connect to.
 113  */
 114 void
 115 GMP_connect (struct MeshPeer *peer);
 116
 117 /**
 118  * @brief Queue and pass message to core when possible.
 119  *
 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 fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
 127  * @param cont Continuation to be called once CORE has taken the message.
 128  * @param cont_cls Closure for @c cont.
 129  */
 130 void
 131 GMP_queue_add (struct MeshPeer *peer, void *cls, uint16_t type, size_t size,
 132                struct MeshConnection *c, int fwd,
 133                GMP_sent cont, void *cont_cls);
 134
 135 /**
 136  * Cancel all queued messages to a peer that belong to a certain connection.
 137  *
 138  * @param peer Peer towards whom to cancel.
 139  * @param c Connection whose queued messages to cancel. Might be destroyed by
 140  *          the sent continuation call.
 141  */
 142 void
 143 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c);
 144
 145 void
 146 GMP_queue_unlock (struct MeshPeer *peer, struct MeshConnection *c);
 147
 148 /**
 149  * Set tunnel.
 150  *
 151  * @param peer Peer.
 152  * @param t Tunnel.
 153  */
 154 void
 155 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t);
 156
 157 /**
 158  * Check whether there is a direct (core level)  connection to peer.
 159  *
 160  * @param peer Peer to check.
 161  *
 162  * @return #GNUNET_YES if there is a direct connection.
 163  */
 164 int
 165 GMP_is_neighbor (const struct MeshPeer *peer);
 166
 167 /**
 168  * Create and initialize a new tunnel towards a peer, in case it has none.
 169  *
 170  * Does not generate any traffic, just creates the local data structures.
 171  *
 172  * @param peer Peer towards which to create the tunnel.
 173  */
 174 void
 175 GMP_add_tunnel (struct MeshPeer *peer);
 176
 177 /**
 178  * Add a connection to a neighboring peer.
 179  *
 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.
 183  *
 184  * @param peer Peer to add connection to.
 185  * @param c Connection to add.
 186  *
 187  * @return GNUNET_OK on success.
 188  */
 189 int
 190 GMP_add_connection (struct MeshPeer *peer, struct MeshConnection *c);
 191
 192 /**
 193  * Add the path to the peer and update the path used to reach it in case this
 194  * is the shortest.
 195  *
 196  * @param peer 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?
 200  *
 201  * @return path if path was taken, pointer to existing duplicate if exists
 202  *         NULL on error.
 203  */
 204 struct MeshPeerPath *
 205 GMP_add_path (struct MeshPeer *peer, struct MeshPeerPath *p, int trusted);
 206
 207 /**
 208  * Add the path to the origin peer and update the path used to reach it in case
 209  * this is the shortest.
 210  * The path is given in peer_info -> destination, therefore we turn the path
 211  * upside down first.
 212  *
 213  * @param peer Peer to add the path to, being the origin of the path.
 214  * @param path New path to add after being inversed.
 215  *             Path will be either used or freed.
 216  * @param trusted Do we trust that this path is real?
 217  *
 218  * @return path if path was taken, pointer to existing duplicate if exists
 219  *         NULL on error.
 220  */
 221 struct MeshPeerPath *
 222 GMP_add_path_to_origin (struct MeshPeer *peer,
 223                         struct MeshPeerPath *path,
 224                         int trusted);
 225
 226 /**
 227  * Adds a path to the info of all the peers in the path
 228  *
 229  * @param p Path to process.
 230  * @param confirmed Whether we know if the path works or not.
 231  */
 232 void
 233 GMP_add_path_to_all (const struct MeshPeerPath *p, int confirmed);
 234
 235 /**
 236  * Remove a connection from a neighboring peer.
 237  *
 238  * @param peer Peer to remove connection from.
 239  * @param c Connection to remove.
 240  *
 241  * @return GNUNET_OK on success.
 242  */
 243 int
 244 GMP_remove_connection (struct MeshPeer *peer, const struct MeshConnection *c);
 245
 246 /**
 247  * Start the DHT search for new paths towards the peer: we don't have
 248  * enough good connections.
 249  *
 250  * @param peer Destination peer.
 251  */
 252 void
 253 GMP_start_search (struct MeshPeer *peer);
 254
 255 /**
 256  * Stop the DHT search for new paths towards the peer: we already have
 257  * enough good connections.
 258  *
 259  * @param peer Destination peer.
 260  */
 261 void
 262 GMP_stop_search (struct MeshPeer *peer);
 263
 264 /**
 265  * Get the Full ID of a peer.
 266  *
 267  * @param peer Peer to get from.
 268  *
 269  * @return Full ID of peer.
 270  */
 271 const struct GNUNET_PeerIdentity *
 272 GMP_get_id (const struct MeshPeer *peer);
 273
 274 /**
 275  * Get the Short ID of a peer.
 276  *
 277  * @param peer Peer to get from.
 278  *
 279  * @return Short ID of peer.
 280  */
 281 GNUNET_PEER_Id
 282 GMP_get_short_id (const struct MeshPeer *peer);
 283
 284 /**
 285  * Get the tunnel towards a peer.
 286  *
 287  * @param peer Peer to get from.
 288  *
 289  * @return Tunnel towards peer.
 290  */
 291 struct MeshTunnel3 *
 292 GMP_get_tunnel (const struct MeshPeer *peer);
 293
 294 /**
 295  * Get the static string for a peer ID.
 296  *
 297  * @param peer Peer.
 298  *
 299  * @return Static string for it's ID.
 300  */
 301 const char *
 302 GMP_2s (const struct MeshPeer *peer);
 303
 304
 305 #if 0                           /* keep Emacsens' auto-indent happy */
 306 {
 307 #endif
 308 #ifdef __cplusplus
 309 }
 310 #endif
 311
 312 /* ifndef GNUNET_MESH_SERVICE_PEER_H */
 313 #endif
 314 /* end of gnunet-mesh-service_peer.h */