src/include/gnunet_mesh_service_new.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010 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 include/gnunet_mesh_service.h
  23  * @brief mesh service; establish tunnels to distant peers
  24  * @author Christian Grothoff
  25  */
  26
  27 #ifndef GNUNET_MESH_SERVICE_H
  28 #define GNUNET_MESH_SERVICE_H
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  38 #include "gnunet_util_lib.h"
  39 #include "gnunet_transport_service.h"
  40
  41 /**
  42  * Version number of GNUnet-mesh API.
  43  */
  44 #define GNUNET_MESH_VERSION 0x00000000
  45
  46
  47 /**
  48  * Opaque handle to the service.
  49  */
  50 struct GNUNET_MESH_Handle;
  51
  52 /**
  53  * Opaque handle to a tunnel.
  54  */
  55 struct GNUNET_MESH_Tunnel;
  56
  57 /**
  58  * Functions with this signature are called whenever a message is
  59  * received or transmitted.
  60  *
  61  * @param cls closure (set from GNUNET_MESH_connect)
  62  * @param tunnel connection to the other end
  63  * @param tunnel_ctx place to store local state associated with the tunnel
  64  * @param sender who sent the message
  65  * @param message the actual message
  66  * @param atsi performance data for the connection
  67  * @return GNUNET_OK to keep the connection open,
  68  *         GNUNET_SYSERR to close it (signal serious error)
  69  */
  70 typedef int (*GNUNET_MESH_MessageCallback) (void *cls,
  71                                             struct GNUNET_MESH_Tunnel * tunnel,
  72                                             void **tunnel_ctx,
  73                                             const struct GNUNET_PeerIdentity *
  74                                             sender,
  75                                             const struct GNUNET_MessageHeader *
  76                                             message,
  77                                             const struct
  78                                             GNUNET_TRANSPORT_ATS_Information *
  79                                             atsi);
  80
  81
  82 /**
  83  * Message handler.  Each struct specifies how to handle on particular
  84  * type of message received.
  85  */
  86 struct GNUNET_MESH_MessageHandler
  87 {
  88   /**
  89    * Function to call for messages of "type".
  90    */
  91   GNUNET_MESH_MessageCallback callback;
  92
  93   /**
  94    * Type of the message this handler covers.
  95    */
  96   uint16_t type;
  97
  98   /**
  99    * Expected size of messages of this type.  Use 0 for variable-size.
 100    * If non-zero, messages of the given type will be discarded if they
 101    * do not have the right size.
 102    */
 103   uint16_t expected_size;
 104
 105 };
 106
 107
 108 /**
 109  * Function called whenever an inbound tunnel is destroyed.  Should clean up
 110  * any associated state.
 111  *
 112  * @param cls closure (set from GNUNET_MESH_connect)
 113  * @param tunnel connection to the other end (henceforth invalid)
 114  * @param tunnel_ctx place where local state associated
 115  *                   with the tunnel is stored
 116  */
 117 typedef void (GNUNET_MESH_TunnelEndHandler) (void *cls,
 118                                              const struct GNUNET_MESH_Tunnel *
 119                                              tunnel, void **tunnel_ctx);
 120
 121
 122 /**
 123  * Type for an application.  Values defined in gnunet_applications.h
 124  */
 125 typedef uint32_t GNUNET_MESH_ApplicationType;
 126
 127
 128 /**
 129  * Connect to the mesh service.
 130  *
 131  * @param cfg configuration to use
 132  * @param cls closure for the various callbacks that follow
 133  *            (including handlers in the handlers array)
 134  * @param cleaner function called when an *inbound* tunnel is destroyed
 135  * @param handlers callbacks for messages we care about, NULL-terminated
 136  *                note that the mesh is allowed to drop notifications about
 137  *                inbound messages if the client does not process them fast
 138  *                enough (for this notification type, a bounded queue is used)
 139  * @param stypes list of the applications that this client claims to provide
 140  * @return handle to the mesh service NULL on error
 141  *         (in this case, init is never called)
 142  */
 143 struct GNUNET_MESH_Handle *
 144 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
 145                      GNUNET_MESH_TunnelEndHandler cleaner,
 146                      const struct GNUNET_MESH_MessageHandler *handlers,
 147                      const GNUNET_MESH_ApplicationType *stypes);
 148
 149
 150 /**
 151  * Disconnect from the mesh service.
 152  *
 153  * @param handle connection to mesh to disconnect
 154  */
 155 void
 156 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle);
 157
 158
 159 /**
 160  * Method called whenever a tunnel falls apart.
 161  *
 162  * @param cls closure
 163  * @param peer peer identity the tunnel stopped working with
 164  */
 165 typedef void (*GNUNET_MESH_TunnelDisconnectHandler) (void *cls,
 166                                                      const struct
 167                                                      GNUNET_PeerIdentity *
 168                                                      peer);
 169
 170
 171 /**
 172  * Method called whenever a tunnel is established.
 173  *
 174  * @param cls closure
 175  * @param peer peer identity the tunnel was created to, NULL on timeout
 176  * @param atsi performance data for the connection
 177  */
 178 typedef void (*GNUNET_MESH_TunnelConnectHandler) (void *cls,
 179                                                   const struct
 180                                                   GNUNET_PeerIdentity * peer,
 181                                                   const struct
 182                                                   GNUNET_TRANSPORT_ATS_Information
 183                                                   * atsi);
 184
 185
 186
 187 /**
 188  * Create a new tunnel (we're initiator and will be allowed to add/remove peers
 189  * and to broadcast).
 190  *
 191  * @param h mesh handle
 192  * @param connect_handler function to call when peers are actually connected
 193  * @param disconnect_handler function to call when peers are disconnected
 194  * @param handler_cls closure for connect/disconnect handlers
 195  */
 196 struct GNUNET_MESH_Tunnel *
 197 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h,
 198                            GNUNET_MESH_TunnelConnectHandler connect_handler,
 199                            GNUNET_MESH_TunnelDisconnectHandler
 200                            disconnect_handler, void *handler_cls);
 201
 202 /**
 203  * Destroy an existing tunnel.
 204  *
 205  * @param tun tunnel handle
 206  */
 207 void
 208 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tun);
 209
 210
 211 /**
 212  * Request that a peer should be added to the tunnel.  The existing
 213  * connect handler will be called ONCE with either success or failure.
 214  *
 215  * @param tunnel handle to existing tunnel
 216  * @param timeout how long to try to establish a connection
 217  * @param peer peer to add
 218  */
 219 void
 220 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
 221                                       struct GNUNET_TIME_Relative timeout,
 222                                       const struct GNUNET_PeerIdentity *peer);
 223
 224
 225 /**
 226  * Request that a peer should be removed from the tunnel.  The existing
 227  * disconnect handler will be called ONCE if we were connected.
 228  *
 229  * @param tunnel handle to existing tunnel
 230  * @param peer peer to remove
 231  */
 232 void
 233 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
 234                                       const struct GNUNET_PeerIdentity *peer);
 235
 236
 237 /**
 238  * Request that the mesh should try to connect to a peer supporting the given
 239  * message type.
 240  *
 241  * @param tunnel handle to existing tunnel
 242  * @param timeout how long to try to establish a connection
 243  * @param app_type application type that must be supported by the peer
 244  *                 (MESH should discover peer in proximity handling this type)
 245  */
 246 void
 247 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
 248                                           struct GNUNET_TIME_Relative timeout,
 249                                           GNUNET_MESH_ApplicationType app_type);
 250
 251
 252 /**
 253  * Handle for a transmission request.
 254  */
 255 struct GNUNET_MESH_TransmitHandle;
 256
 257
 258 /**
 259  * Ask the mesh to call "notify" once it is ready to transmit the
 260  * given number of bytes to the specified tunnel or target.
 261  *
 262  * @param tunnel tunnel to use for transmission
 263  * @param cork is corking allowed for this transmission?
 264  * @param priority how important is the message?
 265  * @param maxdelay how long can the message wait?
 266  * @param target destination for the message
 267  *               NULL for multicast to all tunnel targets
 268  * @param notify_size how many bytes of buffer space does notify want?
 269  * @param notify function to call when buffer space is available;
 270  *        will be called with NULL on timeout or if the overall queue
 271  *        for this peer is larger than queue_size and this is currently
 272  *        the message with the lowest priority
 273  * @param notify_cls closure for notify
 274  * @return non-NULL if the notify callback was queued,
 275  *         NULL if we can not even queue the request (insufficient
 276  *         memory); if NULL is returned, "notify" will NOT be called.
 277  */
 278 struct GNUNET_MESH_TransmitHandle *
 279 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
 280                                    uint32_t priority,
 281                                    struct GNUNET_TIME_Relative maxdelay,
 282                                    const struct GNUNET_PeerIdentity *target,
 283                                    size_t notify_size,
 284                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
 285                                    void *notify_cls);
 286
 287
 288 /**
 289  * Cancel the specified transmission-ready notification.
 290  *
 291  * @param th handle that was returned by "notify_transmit_ready".
 292  */
 293 void
 294 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle
 295                                           *th);
 296
 297
 298 #if 0                           /* keep Emacsens' auto-indent happy */
 299 {
 300 #endif
 301 #ifdef __cplusplus
 302 }
 303 #endif
 304
 305 /* ifndef GNUNET_MESH_SERVICE_H */
 306 #endif
 307 /* end of gnunet_mesh_service.h */