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
  71   (*GNUNET_MESH_MessageCallback) (void *cls,
  72                                   struct GNUNET_MESH_Tunnel *tunnel,
  73                                   void **tunnel_ctx,
  74                                   const struct GNUNET_PeerIdentity *sender,
  75                                   const struct GNUNET_MessageHeader *message,
  76                                   const struct GNUNET_TRANSPORT_ATS_Information *atsi);
  77
  78
  79 /**
  80  * Message handler.  Each struct specifies how to handle on particular
  81  * type of message received.
  82  */
  83 struct GNUNET_MESH_MessageHandler
  84 {
  85   /**
  86    * Function to call for messages of "type".
  87    */
  88   GNUNET_MESH_MessageCallback callback;
  89
  90   /**
  91    * Type of the message this handler covers.
  92    */
  93   uint16_t type;
  94
  95   /**
  96    * Expected size of messages of this type.  Use 0 for variable-size.
  97    * If non-zero, messages of the given type will be discarded if they
  98    * do not have the right size.
  99    */
 100   uint16_t expected_size;
 101
 102 };
 103
 104
 105 /**
 106  * Function called whenever an inbound tunnel is destroyed.  Should clean up
 107  * any associated state.
 108  *
 109  * @param cls closure (set from GNUNET_MESH_connect)
 110  * @param tunnel connection to the other end (henceforth invalid)
 111  * @param tunnel_ctx place where local state associated with the tunnel is stored
 112  */
 113 typedef void (GNUNET_MESH_TunnelEndHandler)(void *cls,
 114                                             const struct GNUNET_MESH_Tunnel *tunnel,
 115                                             void **tunnel_ctx);
 116
 117
 118 /**
 119  * Type for an application.  Values defined in gnunet_applications.h
 120  */
 121 typedef uint32_t GNUNET_MESH_ApplicationType;
 122
 123
 124 /**
 125  * Connect to the mesh service.
 126  *
 127  * @param cfg configuration to use
 128  * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
 129  * @param cleaner function called when an *inbound* tunnel is destroyed
 130  * @param handlers callbacks for messages we care about, NULL-terminated
 131  *                note that the mesh is allowed to drop notifications about inbound
 132  *                messages if the client does not process them fast enough (for this
 133  *                notification type, a bounded queue is used)
 134  * @return handle to the mesh service
 135  *           NULL on error (in this case, init is never called)
 136  */
 137 struct GNUNET_MESH_Handle *
 138 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 139                      void *cls,
 140                      GNUNET_MESH_TunnelEndHandler cleaner,
 141                      const struct GNUNET_MESH_MessageHandler *handlers,
 142                      const GNUNET_MESH_ApplicationType *stypes);
 143
 144 /**
 145  * Get the peer on the other side of this tunnel if it is just one. Return NULL otherwise
 146  *
 147  * @deprecated
 148  * @param tunnel the tunnel
 149  * @return the peer or NULL
 150  */
 151 const struct GNUNET_PeerIdentity*
 152 GNUNET_MESH_get_peer (const struct GNUNET_MESH_Tunnel* tunnel);
 153
 154
 155 /**
 156  * Disconnect from the mesh service.
 157  *
 158  * @param handle connection to mesh to disconnect
 159  */
 160 void GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle);
 161
 162
 163 /**
 164  * Method called whenever a tunnel falls apart.
 165  *
 166  * @param cls closure
 167  * @param peer peer identity the tunnel stopped working with
 168  */
 169 typedef void (*GNUNET_MESH_TunnelDisconnectHandler) (void *cls,
 170                                                      const struct GNUNET_PeerIdentity *peer);
 171
 172
 173 /**
 174  * Method called whenever a tunnel is established.
 175  *
 176  * @param cls closure
 177  * @param peer peer identity the tunnel was created to, NULL on timeout
 178  * @param atsi performance data for the connection
 179  */
 180 typedef void (*GNUNET_MESH_TunnelConnectHandler) (void *cls,
 181                                                   const struct GNUNET_PeerIdentity *peer,
 182                                                   const struct GNUNET_TRANSPORT_ATS_Information *atsi);
 183
 184
 185
 186 /**
 187  * Create a new tunnel (we're initiator and will be allowed to add/remove peers and
 188  * to broadcast).
 189  *
 190  * @param h mesh handle
 191  * @param connect_handler function to call when peers are actually connected
 192  * @param disconnect_handler function to call when peers are disconnected
 193  * @param handler_cls closure for connect/disconnect handlers
 194  */
 195 struct GNUNET_MESH_Tunnel *
 196 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h,
 197                            GNUNET_MESH_TunnelConnectHandler connect_handler,
 198                            GNUNET_MESH_TunnelDisconnectHandler disconnect_handler,
 199                            void *handler_cls);
 200
 201 /**
 202  * Destroy an existing tunnel.
 203  *
 204  * @param tun tunnel handle
 205  */
 206 void
 207 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tun);
 208
 209
 210 /**
 211  * Request that a peer should be added to the tunnel.  The existing
 212  * connect handler will be called ONCE with either success or failure.
 213  *
 214  * @param tunnel handle to existing tunnel
 215  * @param timeout how long to try to establish a connection
 216  * @param peer peer to add
 217  */
 218 void
 219 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
 220                                       struct GNUNET_TIME_Relative timeout,
 221                                       const struct GNUNET_PeerIdentity *peer);
 222
 223
 224 /**
 225  * Request that a peer should be removed from the tunnel.  The existing
 226  * disconnect handler will be called ONCE if we were connected.
 227  *
 228  * @param tunnel handle to existing tunnel
 229  * @param peer peer to remove
 230  */
 231 void
 232 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
 233                                       const struct GNUNET_PeerIdentity *peer);
 234
 235
 236 /**
 237  * Request that the mesh should try to connect to a peer supporting the given
 238  * message type.
 239  *
 240  * @param tunnel handle to existing tunnel
 241  * @param timeout how long to try to establish a connection
 242  * @param app_type application type that must be supported by the peer (MESH should
 243  *                discover peer in proximity handling this type)
 244  * @return NULL on error (handler will not be called), otherwise handle for cancellation
 245  */
 246 struct GNUNET_MESH_Tunnel *
 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 "target".  If we are not yet
 261  * connected to the specified peer, a call to this function will cause
 262  * us to try to establish a connection.
 263  *
 264  * @param tunnel tunnel to use for transmission
 265  * @param cork is corking allowed for this transmission?
 266  * @param priority how important is the message?
 267  * @param maxdelay how long can the message wait?
 268  * @param target destination for the message, NULL for multicast to all tunnel targets
 269  * @param notify_size how many bytes of buffer space does notify want?
 270  * @param notify function to call when buffer space is available;
 271  *        will be called with NULL on timeout or if the overall queue
 272  *        for this peer is larger than queue_size and this is currently
 273  *        the message with the lowest priority
 274  * @param notify_cls closure for notify
 275  * @return non-NULL if the notify callback was queued,
 276  *         NULL if we can not even queue the request (insufficient
 277  *         memory); if NULL is returned, "notify" will NOT be called.
 278  */
 279 struct GNUNET_MESH_TransmitHandle *
 280 GNUNET_MESH_notify_transmit_ready (struct
 281                                    GNUNET_MESH_Tunnel
 282                                    *tunnel,
 283                                    int cork,
 284                                    uint32_t priority,
 285                                    struct
 286                                    GNUNET_TIME_Relative
 287                                    maxdelay,
 288                                    const struct GNUNET_PeerIdentity *target,
 289                                    size_t
 290                                    notify_size,
 291                                    GNUNET_CONNECTION_TransmitReadyNotify
 292                                    notify,
 293                                    void
 294                                    *notify_cls);
 295
 296
 297 /**
 298  * Cancel the specified transmission-ready notification.
 299  *
 300  * @param th handle that was returned by "notify_transmit_ready".
 301  */
 302 void
 303 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle
 304                                           *th);
 305
 306
 307 #if 0                           /* keep Emacsens' auto-indent happy */
 308 {
 309 #endif
 310 #ifdef __cplusplus
 311 }
 312 #endif
 313
 314 /* ifndef GNUNET_MESH_SERVICE_H */
 315 #endif
 316 /* end of gnunet_mesh_service.h */