src/mesh/gnunet-service-mesh_local.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_local.h
  23  * @brief mesh service; dealing with local clients
  24  * @author Bart Polot
  25  *
  26  * All functions in this file should use the prefix GML (Gnunet Mesh Local)
  27  */
  28
  29 #ifndef GNUNET_SERVICE_MESH_LOCAL_H
  30 #define GNUNET_SERVICE_MESH_LOCAL_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 "gnunet_util_lib.h"
  41 #include "gnunet-service-mesh_channel.h"
  42
  43 /**
  44  * Struct containing information about a client of the service
  45  */
  46 struct MeshClient;
  47
  48 /******************************************************************************/
  49 /********************************    API    ***********************************/
  50 /******************************************************************************/
  51
  52 /**
  53  * Initialize server subsystem.
  54  *
  55  * @param handle Server handle.
  56  */
  57 void
  58 GML_init (struct GNUNET_SERVER_Handle *handle);
  59
  60 /**
  61  * Install server (service) handlers and start listening to clients.
  62  */
  63 void
  64 GML_start (void);
  65
  66 /**
  67  * Shutdown server.
  68  */
  69 void
  70 GML_shutdown (void);
  71
  72 /**
  73  * Check if client has registered with the service and has not disconnected
  74  *
  75  * @param client the client to check
  76  *
  77  * @return non-NULL if client exists in the global DLL
  78  */
  79 struct MeshClient *
  80 GML_client_get (struct GNUNET_SERVER_Client *client);
  81
  82 /**
  83  * Deletes a tunnel from a client (either owner or destination).
  84  *
  85  * @param c Client whose tunnel to delete.
  86  * @param ch Channel which should be deleted.
  87  */
  88 void
  89 GML_client_delete_channel (struct MeshClient *c, struct MeshChannel *ch);
  90
  91 /**
  92  * Build a local ACK message and send it to a local client, if needed.
  93  *
  94  * If the client was already allowed to send data, do nothing.
  95  *
  96  * @param ch Channel on which to send the ACK.
  97  * @param c Client to whom send the ACK.
  98  * @param fwd Set to GNUNET_YES for FWD ACK (dest->root)
  99  */
 100 void
 101 GML_send_ack (struct MeshChannel *ch, int fwd);
 102
 103 /**
 104  * Notify the appropriate client that a new incoming channel was created.
 105  *
 106  * @param ch Channel that was created.
 107  */
 108 void
 109 GML_send_channel_create (struct MeshClient *c,
 110                          uint32_t id, uint32_t port, uint32_t opt,
 111                          struct GNUNET_PeerIdentity *peer);
 112
 113 /**
 114  * Notify a client that a channel is no longer valid.
 115  *
 116  * @param c Client.
 117  * @param id ID of the channel that is destroyed.
 118  */
 119 void
 120 GML_send_channel_destroy (struct MeshClient *c, uint32_t id);
 121
 122 /**
 123  * Modify the mesh message TID from global to local and send to client.
 124  *
 125  * @param ch Channel on which to send the message.
 126  * @param msg Message to modify and send.
 127  * @param c Client to send to.
 128  * @param tid Tunnel ID to use (c can be both owner and client).
 129  */
 130 void
 131 GML_send_data (struct MeshChannel *ch,
 132                const struct GNUNET_MESH_Data *msg,
 133                struct MeshClient *c, MESH_ChannelNumber id);
 134
 135
 136 #if 0                           /* keep Emacsens' auto-indent happy */
 137 {
 138 #endif
 139 #ifdef __cplusplus
 140 }
 141 #endif
 142
 143 /* ifndef GNUNET_MESH_SERVICE_LOCAL_H */
 144 #endif
 145 /* end of gnunet-mesh-service_LOCAL.h */