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