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 /******************************************************************************/
  52 /********************************    API    ***********************************/
  53 /******************************************************************************/
  54
  55 /**
  56  * Initialize peer subsystem.
  57  *
  58  * @param c Configuration.
  59  */
  60 void
  61 GMP_init (const struct GNUNET_CONFIGURATION_Handle *c);
  62
  63 /**
  64  * Shut down the peer subsystem.
  65  */
  66 void
  67 GMP_shutdown (void);
  68
  69 /**
  70  * @brief Queue and pass message to core when possible.
  71  *
  72  * @param cls Closure (@c type dependant). It will be used by queue_send to
  73  *            build the message to be sent if not already prebuilt.
  74  * @param type Type of the message, 0 for a raw message.
  75  * @param size Size of the message.
  76  * @param c Connection this message belongs to (cannot be NULL).
  77  * @param ch Channel this message belongs to, if applicable (otherwise NULL).
  78  * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
  79  */
  80 void
  81 GMP_queue_add (void *cls, uint16_t type, size_t size,
  82                struct MeshConnection *c,
  83                struct MeshChannel *ch,
  84                int fwd);
  85
  86 /**
  87  * Set tunnel.
  88  *
  89  * @param peer Peer.
  90  * @param t Tunnel.
  91  */
  92 void
  93 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t);
  94
  95 /**
  96  * Check whether there is a direct (core level)  connection to peer.
  97  *
  98  * @param peer Peer to check.
  99  *
 100  * @return GNUNET_YES if there is a direct connection.
 101  */
 102 int
 103 GMP_is_neighbor (const struct MeshPeer *peer);
 104
 105
 106 /**
 107  * Add a connection to a neighboring peer.
 108  *
 109  * Store that the peer is the first hop of the connection in one
 110  * direction and that on peer disconnect the connection must be
 111  * notified and destroyed, for it will no longer be valid.
 112  *
 113  * @param peer Peer to add connection to.
 114  * @param c Connection to add.
 115  *
 116  * @return GNUNET_OK on success.
 117  */
 118 int
 119 GMP_add_connection (struct MeshPeer *peer, struct MeshConnection *c);
 120
 121 int
 122 GMP_remove_connection (struct MeshPeer *peer, struct MeshConnection *c);
 123
 124 /**
 125  * Get the Full ID of a peer.
 126  *
 127  * @param peer Peer to get from.
 128  *
 129  * @return Full ID of peer.
 130  */
 131 struct GNUNET_PeerIdentity *
 132 GMP_get_id (const struct MeshPeer *peer);
 133
 134 /**
 135  * Get the Short ID of a peer.
 136  *
 137  * @param peer Peer to get from.
 138  *
 139  * @return Short ID of peer.
 140  */
 141 GNUNET_PEER_Id
 142 GMP_get_short_id (const struct MeshPeer *peer);
 143
 144 /**
 145  * Get the static string for a peer ID.
 146  *
 147  * @param peer Peer.
 148  *
 149  * @return Static string for it's ID.
 150  */
 151 const char *
 152 GMP_2s (const struct MeshPeer *peer);
 153
 154
 155 #if 0                           /* keep Emacsens' auto-indent happy */
 156 {
 157 #endif
 158 #ifdef __cplusplus
 159 }
 160 #endif
 161
 162 /* ifndef GNUNET_MESH_SERVICE_PEER_H */
 163 #endif
 164 /* end of gnunet-mesh-service_peer.h */