src/include/gnunet_mesh_service.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.
  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 GNUNET_ATS_Information
  78                                             * atsi);
  79
  80
  81 /**
  82  * Message handler.  Each struct specifies how to handle on particular
  83  * type of message received.
  84  */
  85 struct GNUNET_MESH_MessageHandler
  86 {
  87   /**
  88    * Function to call for messages of "type".
  89    */
  90   GNUNET_MESH_MessageCallback callback;
  91
  92   /**
  93    * Type of the message this handler covers.
  94    */
  95   uint16_t type;
  96
  97   /**
  98    * Expected size of messages of this type.  Use 0 for variable-size.
  99    * If non-zero, messages of the given type will be discarded if they
 100    * do not have the right size.
 101    */
 102   uint16_t expected_size;
 103
 104 };
 105
 106
 107 /**
 108  * Method called whenever another peer has added us to a tunnel
 109  * the other peer initiated.
 110  *
 111  * @param cls closure
 112  * @param tunnel new handle to the tunnel
 113  * @param initiator peer that started the tunnel
 114  * @param atsi performance information for the tunnel
 115  * @return initial tunnel context for the tunnel
 116  *         (can be NULL -- that's not an error)
 117  */
 118 typedef void *(GNUNET_MESH_InboundTunnelNotificationHandler) (void *cls,
 119                                                               struct
 120                                                               GNUNET_MESH_Tunnel
 121                                                               * tunnel,
 122                                                               const struct
 123                                                               GNUNET_PeerIdentity
 124                                                               * initiator,
 125                                                               const struct
 126                                                               GNUNET_ATS_Information
 127                                                               * atsi);
 128
 129
 130 /**
 131  * Function called whenever an inbound tunnel is destroyed.  Should clean up
 132  * any associated state.  This function is NOT called if the client has
 133  * explicitly asked for the tunnel to be destroyed using
 134  * GNUNET_MESH_tunnel_destroy.
 135  *
 136  * @param cls closure (set from GNUNET_MESH_connect)
 137  * @param tunnel connection to the other end (henceforth invalid)
 138  * @param tunnel_ctx place where local state associated
 139  *                   with the tunnel is stored
 140  */
 141 typedef void (GNUNET_MESH_TunnelEndHandler) (void *cls,
 142                                              const struct GNUNET_MESH_Tunnel *
 143                                              tunnel, void *tunnel_ctx);
 144
 145
 146 /**
 147  * Type for an application.  Values defined in gnunet_applications.h
 148  */
 149 typedef uint32_t GNUNET_MESH_ApplicationType;
 150
 151
 152 /**
 153  * Connect to the mesh service.
 154  *
 155  * @param cfg configuration to use
 156  * @param queue_size size of the data message queue, shared among all tunnels
 157  *                   (each tunnel is guaranteed to accept at least one message,
 158  *                    no matter what is the status of other tunnels)
 159  * @param cls closure for the various callbacks that follow
 160  *            (including handlers in the handlers array)
 161  * @param new_tunnel function called when an *inbound* tunnel is created
 162  * @param cleaner function called when an *inbound* tunnel is destroyed
 163  * @param handlers callbacks for messages we care about, NULL-terminated
 164  *                note that the mesh is allowed to drop notifications about
 165  *                inbound messages if the client does not process them fast
 166  *                enough (for this notification type, a bounded queue is used)
 167  * @param stypes list of the applications that this client claims to provide
 168  * @return handle to the mesh service NULL on error
 169  *         (in this case, init is never called)
 170  */
 171 struct GNUNET_MESH_Handle *
 172 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 173                      unsigned int queue_size, void *cls,
 174                      GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
 175                      GNUNET_MESH_TunnelEndHandler cleaner,
 176                      const struct GNUNET_MESH_MessageHandler *handlers,
 177                      const GNUNET_MESH_ApplicationType *stypes);
 178
 179
 180 /**
 181  * Disconnect from the mesh service.
 182  *
 183  * @param handle connection to mesh to disconnect
 184  */
 185 void
 186 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle);
 187
 188
 189 /**
 190  * Method called whenever a peer has disconnected from the tunnel.
 191  * Implementations of this callback must NOT call
 192  * GNUNET_MESH_tunnel_destroy immediately, but instead schedule those
 193  * to run in some other task later.  However, calling
 194  * "GNUNET_MESH_notify_transmit_ready_cancel" is allowed.
 195  *
 196  * @param cls closure
 197  * @param peer peer identity the tunnel stopped working with
 198  */
 199 typedef void (*GNUNET_MESH_PeerDisconnectHandler) (void *cls,
 200                                                    const struct
 201                                                    GNUNET_PeerIdentity * peer);
 202
 203
 204 /**
 205  * Method called whenever a peer has connected to the tunnel.
 206  *
 207  * @param cls closure
 208  * @param peer peer identity the tunnel was created to, NULL on timeout
 209  * @param atsi performance data for the connection
 210  *
 211  * TODO: change to return int to let client allow the new peer or not?
 212  */
 213 typedef void (*GNUNET_MESH_PeerConnectHandler) (void *cls,
 214                                                 const struct GNUNET_PeerIdentity
 215                                                 * peer,
 216                                                 const struct
 217                                                 GNUNET_ATS_Information * atsi);
 218
 219
 220
 221 /**
 222  * Create a new tunnel (we're initiator and will be allowed to add/remove peers
 223  * and to broadcast).
 224  *
 225  * @param h mesh handle
 226  * @param tunnel_ctx client's tunnel context to associate with the tunnel
 227  * @param connect_handler function to call when peers are actually connected
 228  * @param disconnect_handler function to call when peers are disconnected
 229  * @param handler_cls closure for connect/disconnect handlers
 230  */
 231 struct GNUNET_MESH_Tunnel *
 232 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
 233                            GNUNET_MESH_PeerConnectHandler connect_handler,
 234                            GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
 235                            void *handler_cls);
 236
 237 /**
 238  * Destroy an existing tunnel.
 239  *
 240  * @param tunnel tunnel handle
 241  */
 242 void
 243 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel);
 244
 245
 246 /**
 247  * Request that a peer should be added to the tunnel.  The connect handler
 248  * will be called when the peer connects
 249  *
 250  * @param tunnel handle to existing tunnel
 251  * @param peer peer to add
 252  */
 253 void
 254 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
 255                                       const struct GNUNET_PeerIdentity *peer);
 256
 257
 258 /**
 259  * Request that a peer should be removed from the tunnel.  The existing
 260  * disconnect handler will be called ONCE if we were connected.
 261  *
 262  * @param tunnel handle to existing tunnel
 263  * @param peer peer to remove
 264  */
 265 void
 266 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
 267                                       const struct GNUNET_PeerIdentity *peer);
 268
 269
 270 /**
 271  * Request that the mesh should try to connect to a peer supporting the given
 272  * message type.
 273  *
 274  * @param tunnel handle to existing tunnel
 275  * @param app_type application type that must be supported by the peer
 276  *                 (MESH should discover peer in proximity handling this type)
 277  */
 278 void
 279 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
 280                                           GNUNET_MESH_ApplicationType app_type);
 281
 282
 283 /**
 284  * Handle for a transmission request.
 285  */
 286 struct GNUNET_MESH_TransmitHandle;
 287
 288
 289 /**
 290  * Ask the mesh to call "notify" once it is ready to transmit the
 291  * given number of bytes to the specified tunnel or target.
 292  *
 293  * @param tunnel tunnel to use for transmission
 294  * @param cork is corking allowed for this transmission?
 295  * @param priority how important is the message?
 296  * @param maxdelay how long can the message wait?
 297  * @param target destination for the message
 298  *               NULL for multicast to all tunnel targets
 299  * @param notify_size how many bytes of buffer space does notify want?
 300  * @param notify function to call when buffer space is available;
 301  *        will be called with NULL on timeout or if the overall queue
 302  *        for this peer is larger than queue_size and this is currently
 303  *        the message with the lowest priority
 304  * @param notify_cls closure for notify
 305  * @return non-NULL if the notify callback was queued,
 306  *         NULL if we can not even queue the request (insufficient
 307  *         memory); if NULL is returned, "notify" will NOT be called.
 308  */
 309 struct GNUNET_MESH_TransmitHandle *
 310 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
 311                                    uint32_t priority,
 312                                    struct GNUNET_TIME_Relative maxdelay,
 313                                    const struct GNUNET_PeerIdentity *target,
 314                                    size_t notify_size,
 315                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
 316                                    void *notify_cls);
 317
 318
 319 /**
 320  * Cancel the specified transmission-ready notification.
 321  *
 322  * @param th handle that was returned by "notify_transmit_ready".
 323  */
 324 void
 325 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle
 326                                           *th);
 327
 328
 329 /**
 330  * Transition API for tunnel ctx management
 331  */
 332 void
 333 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data);
 334
 335 /**
 336  * Transition API for tunnel ctx management
 337  */
 338 void *
 339 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel);
 340
 341
 342 #if 0                           /* keep Emacsens' auto-indent happy */
 343 {
 344 #endif
 345 #ifdef __cplusplus
 346 }
 347 #endif
 348
 349 /* ifndef GNUNET_MESH_SERVICE_H */
 350 #endif
 351 /* end of gnunet_mesh_service.h */