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  * 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.
 108  *
 109  * @param peer Peer to connect to.
 110  */
 111 void
 112 GMP_connect (struct MeshPeer *peer);
 113
 114 /**
 115  * @brief Queue and pass message to core when possible.
 116  *
 117  * @param peer Peer towards which to queue the message.
 118  * @param cls Closure (@c type dependant). It will be used by queue_send to
 119  *            build the message to be sent if not already prebuilt.
 120  * @param type Type of the message, 0 for a raw message.
 121  * @param size Size of the message.
 122  * @param c Connection this message belongs to (cannot be NULL).
 123  * @param ch Channel this message belongs to, if applicable (otherwise NULL).
 124  * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
 125  * @param cont Continuation to be called once CORE has taken the message.
 126  * @param cont_cls Closure for @c cont.
 127  */
 128 void
 129 GMP_queue_add (struct MeshPeer *peer, void *cls, uint16_t type, size_t size,
 130                struct MeshConnection *c, struct MeshChannel *ch, int fwd,
 131                GMP_sent cont, void *cont_cls);
 132
 133 /**
 134  * Cancel all queued messages to a peer that belong to a certain connection.
 135  *
 136  * @param peer Peer towards whom to cancel.
 137  * @param c Connection whose queued messages to cancel.
 138  */
 139 void
 140 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c);
 141
 142 void
 143 GMP_queue_unlock (struct MeshPeer *peer, struct MeshConnection *c);
 144
 145 /**
 146  * Set tunnel.
 147  *
 148  * @param peer Peer.
 149  * @param t Tunnel.
 150  */
 151 void
 152 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t);
 153
 154 /**
 155  * Check whether there is a direct (core level)  connection to peer.
 156  *
 157  * @param peer Peer to check.
 158  *
 159  * @return GNUNET_YES if there is a direct connection.
 160  */
 161 int
 162 GMP_is_neighbor (const struct MeshPeer *peer);
 163
 164 /**
 165  * Create and initialize a new tunnel towards a peer, in case it has none.
 166  *
 167  * Does not generate any traffic, just creates the local data structures.
 168  *
 169  * @param peer Peer towards which to create the tunnel.
 170  */
 171 void
 172 GMP_add_tunnel (struct MeshPeer *peer);
 173
 174 /**
 175  * Add a connection to a neighboring peer.
 176  *
 177  * Store that the peer is the first hop of the connection in one
 178  * direction and that on peer disconnect the connection must be
 179  * notified and destroyed, for it will no longer be valid.
 180  *
 181  * @param peer Peer to add connection to.
 182  * @param c Connection to add.
 183  *
 184  * @return GNUNET_OK on success.
 185  */
 186 int
 187 GMP_add_connection (struct MeshPeer *peer, struct MeshConnection *c);
 188
 189 /**
 190  * Add the path to the peer and update the path used to reach it in case this
 191  * is the shortest.
 192  *
 193  * @param peer_info Destination peer to add the path to.
 194  * @param path New path to add. Last peer must be the peer in arg 1.
 195  *             Path will be either used of freed if already known.
 196  * @param trusted Do we trust that this path is real?
 197  */
 198 void
 199 GMP_add_path (struct MeshPeer *peer, struct MeshPeerPath *p, int trusted);
 200
 201 /**
 202  * Add the path to the origin peer and update the path used to reach it in case
 203  * this is the shortest.
 204  * The path is given in peer_info -> destination, therefore we turn the path
 205  * upside down first.
 206  *
 207  * @param peer_info Peer to add the path to, being the origin of the path.
 208  * @param path New path to add after being inversed.
 209  *             Path will be either used or freed.
 210  * @param trusted Do we trust that this path is real?
 211  */
 212 void
 213 GMP_add_path_to_origin (struct MeshPeer *peer_info,
 214                         struct MeshPeerPath *path,
 215                         int trusted);
 216
 217 /**
 218  * Adds a path to the info of all the peers in the path
 219  *
 220  * @param p Path to process.
 221  * @param confirmed Whether we know if the path works or not.
 222  */
 223 void
 224 GMP_add_path_to_all (struct MeshPeerPath *p, int confirmed);
 225
 226 /**
 227  * Remove a connection from a neighboring peer.
 228  *
 229  * @param peer Peer to remove connection from.
 230  * @param c Connection to remove.
 231  *
 232  * @return GNUNET_OK on success.
 233  */
 234 int
 235 GMP_remove_connection (struct MeshPeer *peer, const struct MeshConnection *c);
 236
 237 void
 238 GMP_start_search (struct MeshPeer *peer);
 239
 240 void
 241 GMP_stop_search (struct MeshPeer *peer);
 242
 243 /**
 244  * Get the Full ID of a peer.
 245  *
 246  * @param peer Peer to get from.
 247  *
 248  * @return Full ID of peer.
 249  */
 250 const struct GNUNET_PeerIdentity *
 251 GMP_get_id (const struct MeshPeer *peer);
 252
 253 /**
 254  * Get the Short ID of a peer.
 255  *
 256  * @param peer Peer to get from.
 257  *
 258  * @return Short ID of peer.
 259  */
 260 GNUNET_PEER_Id
 261 GMP_get_short_id (const struct MeshPeer *peer);
 262
 263 /**
 264  * Get the static string for a peer ID.
 265  *
 266  * @param peer Peer.
 267  *
 268  * @return Static string for it's ID.
 269  */
 270 const char *
 271 GMP_2s (const struct MeshPeer *peer);
 272
 273
 274 #if 0                           /* keep Emacsens' auto-indent happy */
 275 {
 276 #endif
 277 #ifdef __cplusplus
 278 }
 279 #endif
 280
 281 /* ifndef GNUNET_MESH_SERVICE_PEER_H */
 282 #endif
 283 /* end of gnunet-mesh-service_peer.h */