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  * Struct containing info about a queued transmission to this peer
  50  */
  51 struct MeshPeerQueue;
  52
  53 #include "gnunet-service-mesh_connection.h"
  54
  55 /**
  56  * Callback called when a queued message is sent.
  57  *
  58  * @param cls Closure.
  59  * @param c Connection this message was on.
  60  * @param type Type of message sent.
  61  * @param fwd Was this a FWD going message?
  62  * @param size Size of the message.
  63  * @param wait Time spent waiting for core (only the time for THIS message)
  64  */
  65 typedef void (*GMP_sent) (void *cls,
  66                           struct MeshConnection *c, uint16_t type,
  67                           int fwd, size_t size,
  68                           struct GNUNET_TIME_Relative wait);
  69
  70 /******************************************************************************/
  71 /********************************    API    ***********************************/
  72 /******************************************************************************/
  73
  74 /**
  75  * Initialize peer subsystem.
  76  *
  77  * @param c Configuration.
  78  */
  79 void
  80 GMP_init (const struct GNUNET_CONFIGURATION_Handle *c);
  81
  82 /**
  83  * Shut down the peer subsystem.
  84  */
  85 void
  86 GMP_shutdown (void);
  87
  88
  89 /**
  90  * Retrieve the MeshPeer stucture associated with the peer, create one
  91  * and insert it in the appropriate structures if the peer is not known yet.
  92  *
  93  * @param peer_id Full identity of the peer.
  94  *
  95  * @return Existing or newly created peer structure.
  96  */
  97 struct MeshPeer *
  98 GMP_get (const struct GNUNET_PeerIdentity *peer_id);
  99
 100
 101 /**
 102  * Retrieve the MeshPeer stucture associated with the peer, create one
 103  * and insert it in the appropriate structures if the peer is not known yet.
 104  *
 105  * @param peer Short identity of the peer.
 106  *
 107  * @return Existing or newly created peer structure.
 108  */
 109 struct MeshPeer *
 110 GMP_get_short (const GNUNET_PEER_Id peer);
 111
 112 /**
 113  * Try to establish a new connection to this peer (in its tunnel).
 114  * If the peer doesn't have any path to it yet, try to get one.
 115  * If the peer already has some path, send a CREATE CONNECTION towards it.
 116  *
 117  * @param peer Peer to connect to.
 118  */
 119 void
 120 GMP_connect (struct MeshPeer *peer);
 121
 122 /**
 123  * Free a transmission that was already queued with all resources
 124  * associated to the request.
 125  *
 126  * @param queue Queue handler to cancel.
 127  * @param clear_cls Is it necessary to free associated cls?
 128  */
 129 void
 130 GMP_queue_destroy (struct MeshPeerQueue *queue, int clear_cls);
 131
 132 /**
 133  * @brief Queue and pass message to core when possible.
 134  *
 135  * @param peer Peer towards which to queue the message.
 136  * @param cls Closure (@c type dependant). It will be used by queue_send to
 137  *            build the message to be sent if not already prebuilt.
 138  * @param type Type of the message, 0 for a raw message.
 139  * @param size Size of the message.
 140  * @param c Connection this message belongs to (cannot be NULL).
 141  * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
 142  * @param cont Continuation to be called once CORE has taken the message.
 143  * @param cont_cls Closure for @c cont.
 144  *
 145  * @return Handle to cancel the message before it is sent. Once cont is called
 146  *         message has been sent and therefore the handle is no longer valid.
 147  */
 148 struct MeshPeerQueue *
 149 GMP_queue_add (struct MeshPeer *peer, void *cls, uint16_t type, size_t size,
 150                struct MeshConnection *c, int fwd,
 151                GMP_sent cont, void *cont_cls);
 152
 153 /**
 154  * Cancel all queued messages to a peer that belong to a certain connection.
 155  *
 156  * @param peer Peer towards whom to cancel.
 157  * @param c Connection whose queued messages to cancel. Might be destroyed by
 158  *          the sent continuation call.
 159  */
 160 void
 161 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c);
 162
 163 void
 164 GMP_queue_unlock (struct MeshPeer *peer, struct MeshConnection *c);
 165
 166 /**
 167  * Set tunnel.
 168  *
 169  * @param peer Peer.
 170  * @param t Tunnel.
 171  */
 172 void
 173 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t);
 174
 175 /**
 176  * Check whether there is a direct (core level)  connection to peer.
 177  *
 178  * @param peer Peer to check.
 179  *
 180  * @return #GNUNET_YES if there is a direct connection.
 181  */
 182 int
 183 GMP_is_neighbor (const struct MeshPeer *peer);
 184
 185 /**
 186  * Create and initialize a new tunnel towards a peer, in case it has none.
 187  *
 188  * Does not generate any traffic, just creates the local data structures.
 189  *
 190  * @param peer Peer towards which to create the tunnel.
 191  */
 192 void
 193 GMP_add_tunnel (struct MeshPeer *peer);
 194
 195 /**
 196  * Add a connection to a neighboring peer.
 197  *
 198  * Store that the peer is the first hop of the connection in one
 199  * direction and that on peer disconnect the connection must be
 200  * notified and destroyed, for it will no longer be valid.
 201  *
 202  * @param peer Peer to add connection to.
 203  * @param c Connection to add.
 204  *
 205  * @return GNUNET_OK on success.
 206  */
 207 int
 208 GMP_add_connection (struct MeshPeer *peer, struct MeshConnection *c);
 209
 210 /**
 211  * Add the path to the peer and update the path used to reach it in case this
 212  * is the shortest.
 213  *
 214  * @param peer Destination peer to add the path to.
 215  * @param path New path to add. Last peer must be the peer in arg 1.
 216  *             Path will be either used of freed if already known.
 217  * @param trusted Do we trust that this path is real?
 218  *
 219  * @return path if path was taken, pointer to existing duplicate if exists
 220  *         NULL on error.
 221  */
 222 struct MeshPeerPath *
 223 GMP_add_path (struct MeshPeer *peer, struct MeshPeerPath *p, int trusted);
 224
 225 /**
 226  * Add the path to the origin peer and update the path used to reach it in case
 227  * this is the shortest.
 228  * The path is given in peer_info -> destination, therefore we turn the path
 229  * upside down first.
 230  *
 231  * @param peer Peer to add the path to, being the origin of the path.
 232  * @param path New path to add after being inversed.
 233  *             Path will be either used or freed.
 234  * @param trusted Do we trust that this path is real?
 235  *
 236  * @return path if path was taken, pointer to existing duplicate if exists
 237  *         NULL on error.
 238  */
 239 struct MeshPeerPath *
 240 GMP_add_path_to_origin (struct MeshPeer *peer,
 241                         struct MeshPeerPath *path,
 242                         int trusted);
 243
 244 /**
 245  * Adds a path to the info of all the peers in the path
 246  *
 247  * @param p Path to process.
 248  * @param confirmed Whether we know if the path works or not.
 249  */
 250 void
 251 GMP_add_path_to_all (const struct MeshPeerPath *p, int confirmed);
 252
 253 /**
 254  * Remove any path to the peer that has the extact same peers as the one given.
 255  *
 256  * @param peer Peer to remove the path from.
 257  * @param path Path to remove. Is always destroyed .
 258  */
 259 void
 260 GMP_remove_path (struct MeshPeer *peer, struct MeshPeerPath *path);
 261
 262 /**
 263  * Remove a connection from a neighboring peer.
 264  *
 265  * @param peer Peer to remove connection from.
 266  * @param c Connection to remove.
 267  *
 268  * @return GNUNET_OK on success.
 269  */
 270 int
 271 GMP_remove_connection (struct MeshPeer *peer, const struct MeshConnection *c);
 272
 273 /**
 274  * Start the DHT search for new paths towards the peer: we don't have
 275  * enough good connections.
 276  *
 277  * @param peer Destination peer.
 278  */
 279 void
 280 GMP_start_search (struct MeshPeer *peer);
 281
 282 /**
 283  * Stop the DHT search for new paths towards the peer: we already have
 284  * enough good connections.
 285  *
 286  * @param peer Destination peer.
 287  */
 288 void
 289 GMP_stop_search (struct MeshPeer *peer);
 290
 291 /**
 292  * Get the Full ID of a peer.
 293  *
 294  * @param peer Peer to get from.
 295  *
 296  * @return Full ID of peer.
 297  */
 298 const struct GNUNET_PeerIdentity *
 299 GMP_get_id (const struct MeshPeer *peer);
 300
 301 /**
 302  * Get the Short ID of a peer.
 303  *
 304  * @param peer Peer to get from.
 305  *
 306  * @return Short ID of peer.
 307  */
 308 GNUNET_PEER_Id
 309 GMP_get_short_id (const struct MeshPeer *peer);
 310
 311 /**
 312  * Get the tunnel towards a peer.
 313  *
 314  * @param peer Peer to get from.
 315  *
 316  * @return Tunnel towards peer.
 317  */
 318 struct MeshTunnel3 *
 319 GMP_get_tunnel (const struct MeshPeer *peer);
 320
 321 /**
 322  * Set the hello message.
 323  *
 324  * @param peer Peer whose message to set.
 325  * @param hello Hello message.
 326  */
 327 void
 328 GMP_set_hello (struct MeshPeer *peer, const struct GNUNET_HELLO_Message *hello);
 329
 330 /**
 331  * Get the hello message.
 332  *
 333  * @param peer Peer whose message to get.
 334  *
 335  * @return Hello message.
 336  */
 337 struct GNUNET_HELLO_Message *
 338 GMP_get_hello (struct MeshPeer *peer);
 339
 340
 341 /**
 342  * Try to connect to a peer on TRANSPORT level.
 343  *
 344  * @param peer Peer to whom to connect.
 345  */
 346 void
 347 GMP_try_connect (struct MeshPeer *peer);
 348
 349 /**
 350  * Count the number of known paths toward the peer.
 351  *
 352  * @param peer Peer to get path info.
 353  *
 354  * @return Number of known paths.
 355  */
 356 unsigned int
 357 GMP_count_paths (const struct MeshPeer *peer);
 358
 359 /**
 360  * Iterate all known peers.
 361  *
 362  * @param iter Iterator.
 363  * @param cls Closure for @c iter.
 364  */
 365 void
 366 GMP_iterate_all (GNUNET_CONTAINER_PeerMapIterator iter, void *cls);
 367
 368 /**
 369  * Get the static string for a peer ID.
 370  *
 371  * @param peer Peer.
 372  *
 373  * @return Static string for it's ID.
 374  */
 375 const char *
 376 GMP_2s (const struct MeshPeer *peer);
 377
 378
 379 #if 0                           /* keep Emacsens' auto-indent happy */
 380 {
 381 #endif
 382 #ifdef __cplusplus
 383 }
 384 #endif
 385
 386 /* ifndef GNUNET_MESH_SERVICE_PEER_H */
 387 #endif
 388 /* end of gnunet-mesh-service_peer.h */