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