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  * Set tunnel.
 102  *
 103  * @param peer Peer.
 104  * @param t Tunnel.
 105  */
 106 void
 107 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t);
 108
 109 /**
 110  * Check whether there is a direct (core level)  connection to peer.
 111  *
 112  * @param peer Peer to check.
 113  *
 114  * @return GNUNET_YES if there is a direct connection.
 115  */
 116 int
 117 GMP_is_neighbor (const struct MeshPeer *peer);
 118
 119
 120 /**
 121  * Add a connection to a neighboring peer.
 122  *
 123  * Store that the peer is the first hop of the connection in one
 124  * direction and that on peer disconnect the connection must be
 125  * notified and destroyed, for it will no longer be valid.
 126  *
 127  * @param peer Peer to add connection to.
 128  * @param c Connection to add.
 129  *
 130  * @return GNUNET_OK on success.
 131  */
 132 int
 133 GMP_add_connection (struct MeshPeer *peer, struct MeshConnection *c);
 134
 135 int
 136 GMP_remove_connection (struct MeshPeer *peer, struct MeshConnection *c);
 137
 138 void
 139 GMP_start_search (struct MeshPeer *peer);
 140
 141 void
 142 GMP_stop_search (struct MeshPeer *peer);
 143
 144 /**
 145  * Get the Full ID of a peer.
 146  *
 147  * @param peer Peer to get from.
 148  *
 149  * @return Full ID of peer.
 150  */
 151 struct GNUNET_PeerIdentity *
 152 GMP_get_id (const struct MeshPeer *peer);
 153
 154 /**
 155  * Get the Short ID of a peer.
 156  *
 157  * @param peer Peer to get from.
 158  *
 159  * @return Short ID of peer.
 160  */
 161 GNUNET_PEER_Id
 162 GMP_get_short_id (const struct MeshPeer *peer);
 163
 164 /**
 165  * Get the static string for a peer ID.
 166  *
 167  * @param peer Peer.
 168  *
 169  * @return Static string for it's ID.
 170  */
 171 const char *
 172 GMP_2s (const struct MeshPeer *peer);
 173
 174
 175 #if 0                           /* keep Emacsens' auto-indent happy */
 176 {
 177 #endif
 178 #ifdef __cplusplus
 179 }
 180 #endif
 181
 182 /* ifndef GNUNET_MESH_SERVICE_PEER_H */
 183 #endif
 184 /* end of gnunet-mesh-service_peer.h */