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  * @brief Queue and pass message to core when possible.
  82  *
  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.
  92  */
  93 void
  94 GMP_queue_add (void *cls, uint16_t type, size_t size,
  95                struct MeshConnection *c,
  96                struct MeshChannel *ch,
  97                int fwd,
  98                GMP_sent callback, void *callback_cls);
  99
 100 /**
 101  * Cancel all queued messages to a peer that belong to a certain connection.
 102  *
 103  * @param peer Peer towards whom to cancel.
 104  * @param c Connection whose queued messages to cancel.
 105  */
 106 void
 107 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c);
 108
 109 void
 110 GMP_queue_unlock (struct MeshPeer *peer, struct MeshConnection *c);
 111
 112 /**
 113  * Set tunnel.
 114  *
 115  * @param peer Peer.
 116  * @param t Tunnel.
 117  */
 118 void
 119 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t);
 120
 121 /**
 122  * Check whether there is a direct (core level)  connection to peer.
 123  *
 124  * @param peer Peer to check.
 125  *
 126  * @return GNUNET_YES if there is a direct connection.
 127  */
 128 int
 129 GMP_is_neighbor (const struct MeshPeer *peer);
 130
 131
 132 /**
 133  * Add a connection to a neighboring peer.
 134  *
 135  * Store that the peer is the first hop of the connection in one
 136  * direction and that on peer disconnect the connection must be
 137  * notified and destroyed, for it will no longer be valid.
 138  *
 139  * @param peer Peer to add connection to.
 140  * @param c Connection to add.
 141  *
 142  * @return GNUNET_OK on success.
 143  */
 144 int
 145 GMP_add_connection (struct MeshPeer *peer, struct MeshConnection *c);
 146
 147 /**
 148  * Add the path to the peer and update the path used to reach it in case this
 149  * is the shortest.
 150  *
 151  * @param peer_info Destination peer to add the path to.
 152  * @param path New path to add. Last peer must be the peer in arg 1.
 153  *             Path will be either used of freed if already known.
 154  * @param trusted Do we trust that this path is real?
 155  */
 156 void
 157 GMP_add_path (struct MeshPeer *peer, struct MeshPeerPath *p, int trusted);
 158
 159 /**
 160  * Add the path to the origin peer and update the path used to reach it in case
 161  * this is the shortest.
 162  * The path is given in peer_info -> destination, therefore we turn the path
 163  * upside down first.
 164  *
 165  * @param peer_info Peer to add the path to, being the origin of the path.
 166  * @param path New path to add after being inversed.
 167  *             Path will be either used or freed.
 168  * @param trusted Do we trust that this path is real?
 169  */
 170 void
 171 GMP_add_path_to_origin (struct MeshPeer *peer_info,
 172                         struct MeshPeerPath *path,
 173                         int trusted);
 174
 175 /**
 176  * Adds a path to the info of all the peers in the path
 177  *
 178  * @param p Path to process.
 179  * @param confirmed Whether we know if the path works or not.
 180  */
 181 void
 182 GMP_add_path_to_all (struct MeshPeerPath *p, int confirmed);
 183
 184 /**
 185  * Remove a connection from a neighboring peer.
 186  *
 187  * @param peer Peer to remove connection from.
 188  * @param c Connection to remove.
 189  *
 190  * @return GNUNET_OK on success.
 191  */
 192 int
 193 GMP_remove_connection (struct MeshPeer *peer, struct MeshConnection *c);
 194
 195 void
 196 GMP_start_search (struct MeshPeer *peer);
 197
 198 void
 199 GMP_stop_search (struct MeshPeer *peer);
 200
 201 /**
 202  * Get the Full ID of a peer.
 203  *
 204  * @param peer Peer to get from.
 205  *
 206  * @return Full ID of peer.
 207  */
 208 struct GNUNET_PeerIdentity *
 209 GMP_get_id (const struct MeshPeer *peer);
 210
 211 /**
 212  * Get the Short ID of a peer.
 213  *
 214  * @param peer Peer to get from.
 215  *
 216  * @return Short ID of peer.
 217  */
 218 GNUNET_PEER_Id
 219 GMP_get_short_id (const struct MeshPeer *peer);
 220
 221 /**
 222  * Get the static string for a peer ID.
 223  *
 224  * @param peer Peer.
 225  *
 226  * @return Static string for it's ID.
 227  */
 228 const char *
 229 GMP_2s (const struct MeshPeer *peer);
 230
 231
 232 #if 0                           /* keep Emacsens' auto-indent happy */
 233 {
 234 #endif
 235 #ifdef __cplusplus
 236 }
 237 #endif
 238
 239 /* ifndef GNUNET_MESH_SERVICE_PEER_H */
 240 #endif
 241 /* end of gnunet-mesh-service_peer.h */