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 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_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 with the tunnel is stored
 115  */
 116 typedef void (GNUNET_MESH_TunnelEndHandler) (void *cls,
 117                                              const struct GNUNET_MESH_Tunnel *
 118                                              tunnel, void **tunnel_ctx);
 119
 120
 121 /**
 122  * Type for an application.  Values defined in gnunet_applications.h
 123  */
 124 typedef uint32_t GNUNET_MESH_ApplicationType;
 125
 126
 127 /**
 128  * Connect to the mesh service.
 129  *
 130  * @param cfg configuration to use
 131  * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
 132  * @param cleaner function called when an *inbound* tunnel is destroyed
 133  * @param handlers callbacks for messages we care about, NULL-terminated
 134  *                note that the mesh is allowed to drop notifications about inbound
 135  *                messages if the client does not process them fast enough (for this
 136  *                notification type, a bounded queue is used)
 137  * @param stypes Application Types the client claims to offer
 138  * @return handle to the mesh service
 139  *           NULL on error (in this case, init is never called)
 140  */
 141 struct GNUNET_MESH_Handle *
 142 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
 143                      GNUNET_MESH_TunnelEndHandler cleaner,
 144                      const struct GNUNET_MESH_MessageHandler *handlers,
 145                      const GNUNET_MESH_ApplicationType *stypes);
 146
 147 /**
 148  * Get the peer on the other side of this tunnel if it is just one. Return NULL otherwise
 149  *
 150  * @param tunnel the tunnel
 151  * @return the peer or NULL
 152  */
 153 const struct GNUNET_PeerIdentity *
 154 GNUNET_MESH_get_peer (const struct GNUNET_MESH_Tunnel *tunnel);
 155
 156
 157 /**
 158  * Disconnect from the mesh service.
 159  *
 160  * @param handle connection to mesh to disconnect
 161  */
 162 void
 163 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle);
 164
 165
 166
 167
 168
 169 /**
 170  * Method called whenever a tunnel falls apart.
 171  *
 172  * @param cls closure
 173  * @param peer peer identity the tunnel stopped working with
 174  */
 175 typedef void (*GNUNET_MESH_TunnelDisconnectHandler) (void *cls,
 176                                                      const struct
 177                                                      GNUNET_PeerIdentity *
 178                                                      peer);
 179
 180
 181 /**
 182  * Method called whenever a tunnel is established.
 183  *
 184  * @param cls closure
 185  * @param peer peer identity the tunnel was created to, NULL on timeout
 186  * @param atsi performance data for the connection
 187  */
 188 typedef void (*GNUNET_MESH_TunnelConnectHandler) (void *cls,
 189                                                   const struct
 190                                                   GNUNET_PeerIdentity * peer,
 191                                                   const struct
 192                                                   GNUNET_ATS_Information
 193                                                   * atsi);
 194
 195
 196
 197 /**
 198  * Handle for a request to the mesh to connect or disconnect
 199  * from a particular peer.  Can be used to cancel the request
 200  * (before the 'cont'inuation is called).
 201  */
 202 struct GNUNET_MESH_PeerRequestHandle;
 203
 204
 205 /**
 206  * Request that the mesh should try to connect to any of the given peers.
 207  *
 208  * @param h mesh handle
 209  * @param timeout how long to try to establish a connection
 210  * @param num_peers length of the peers array
 211  * @param peers list of candidates to connect to
 212  * @param connect_handler function to call on successful connect (or timeout)
 213  * @param disconnect_handler function to call on disconnect
 214  * @param handler_cls closure for handler
 215  * @return NULL on error (handler will not be called), otherwise handle for cancellation
 216  */
 217 struct GNUNET_MESH_Tunnel *
 218 GNUNET_MESH_peer_request_connect_any (struct GNUNET_MESH_Handle *h,
 219                                       struct GNUNET_TIME_Relative timeout,
 220                                       unsigned int num_peers,
 221                                       const struct GNUNET_PeerIdentity *peers,
 222                                       GNUNET_MESH_TunnelConnectHandler
 223                                       connect_handler,
 224                                       GNUNET_MESH_TunnelDisconnectHandler
 225                                       disconnect_handler, void *handler_cls);
 226
 227
 228 /**
 229  * Request that the mesh should try to connect to all of the given peers.
 230  * Messages send to the tunnel will be broadcast.
 231  *
 232  * @param h mesh handle
 233  * @param timeout how long to try to establish a connection
 234  * @param num_peers length of the peers array
 235  * @param peers list of candidates to connect to
 236  * @param connect_handler function to call on successful connect (or timeout);
 237  *                will be called for EACH of the peers in the list and
 238  *                once at the end with 'NULL' on timeout or once we've connected
 239  *                to each of the peers in the list
 240  * @param disconnect_handler function called if a peer drops out of the tunnel;
 241  *                the mesh will NOT try to add it back automatically
 242  * @param handler_cls closure for handler
 243  * @return NULL on error (handler will not be called), otherwise handle for cancellation
 244  */
 245 struct GNUNET_MESH_Tunnel *
 246 GNUNET_MESH_peer_request_connect_all (struct GNUNET_MESH_Handle *h,
 247                                       struct GNUNET_TIME_Relative timeout,
 248                                       unsigned int num_peers,
 249                                       const struct GNUNET_PeerIdentity *peers,
 250                                       GNUNET_MESH_TunnelConnectHandler
 251                                       connect_handler,
 252                                       GNUNET_MESH_TunnelDisconnectHandler
 253                                       disconnect_handler, void *handler_cls);
 254
 255
 256 /**
 257  * Request that a peer should be added to the tunnel.  The existing
 258  * connect handler will be called ONCE with either success or failure.
 259  *
 260  * @param tunnel handle to existing tunnel
 261  * @param timeout how long to try to establish a connection
 262  * @param peer peer to add
 263  */
 264 void
 265 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
 266                                       struct GNUNET_TIME_Relative timeout,
 267                                       const struct GNUNET_PeerIdentity *peer);
 268
 269
 270 /**
 271  * Request that a peer should be removed from the tunnel.  The existing
 272  * disconnect handler will be called ONCE if we were connected.
 273  *
 274  * @param tunnel handle to existing tunnel
 275  * @param peer peer to remove
 276  */
 277 void
 278 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
 279                                       const struct GNUNET_PeerIdentity *peer);
 280
 281
 282 /**
 283  * Request that the mesh should try to connect to a peer supporting the given
 284  * message type.
 285  *
 286  * @param h mesh handle
 287  * @param timeout how long to try to establish a connection
 288  * @param app_type application type that must be supported by the peer (MESH should
 289  *                discover peer in proximity handling this type)
 290  * @param connect_handler function to call on successful connect (or timeout);
 291  *                will be called for EACH of the peers in the list and
 292  *                once at the end with 'NULL' on timeout or once we've connected
 293  *                to each of the peers in the list
 294  * @param disconnect_handler function called if a peer drops out of the tunnel;
 295  *                the mesh will NOT try to add it back automatically
 296  * @param handler_cls closure for handler
 297  * @return NULL on error (handler will not be called), otherwise handle for cancellation
 298  */
 299 struct GNUNET_MESH_Tunnel *
 300 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Handle *h,
 301                                           struct GNUNET_TIME_Relative timeout,
 302                                           GNUNET_MESH_ApplicationType app_type,
 303                                           GNUNET_MESH_TunnelConnectHandler
 304                                           connect_handler,
 305                                           GNUNET_MESH_TunnelDisconnectHandler
 306                                           disconnect_handler,
 307                                           void *handler_cls);
 308
 309
 310 /**
 311  * Cancel a pending request to connect to a particular peer.  Destroys the
 312  * tunnel.
 313  *
 314  * @param req request handle that was returned for the original request
 315  */
 316 void
 317 GNUNET_MESH_peer_request_connect_cancel (struct GNUNET_MESH_Tunnel *req);
 318
 319
 320 /**
 321  * Handle for a transmission request.
 322  */
 323 struct GNUNET_MESH_TransmitHandle;
 324
 325
 326 /**
 327  * Ask the mesh to call "notify" once it is ready to transmit the
 328  * given number of bytes to the specified "target".  If we are not yet
 329  * connected to the specified peer, a call to this function will cause
 330  * us to try to establish a connection.
 331  *
 332  * @param tunnel tunnel to use for transmission
 333  * @param cork is corking allowed for this transmission?
 334  * @param priority how important is the message?
 335  * @param maxdelay how long can the message wait?
 336  * @param target destination for the message, NULL for multicast to all tunnel targets
 337  * @param notify_size how many bytes of buffer space does notify want?
 338  * @param notify function to call when buffer space is available;
 339  *        will be called with NULL on timeout or if the overall queue
 340  *        for this peer is larger than queue_size and this is currently
 341  *        the message with the lowest priority
 342  * @param notify_cls closure for notify
 343  * @return non-NULL if the notify callback was queued,
 344  *         NULL if we can not even queue the request (insufficient
 345  *         memory); if NULL is returned, "notify" will NOT be called.
 346  */
 347 struct GNUNET_MESH_TransmitHandle *
 348 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
 349                                    uint32_t priority,
 350                                    struct GNUNET_TIME_Relative maxdelay,
 351                                    const struct GNUNET_PeerIdentity *target,
 352                                    size_t notify_size,
 353                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
 354                                    void *notify_cls);
 355
 356
 357 /**
 358  * Cancel the specified transmission-ready notification.
 359  *
 360  * @param th handle that was returned by "notify_transmit_ready".
 361  */
 362 void
 363 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle
 364                                           *th);
 365
 366 void
 367 GNUNET_MESH_tunnel_set_head (struct GNUNET_MESH_Tunnel *tunnel, void *head);
 368 void
 369 GNUNET_MESH_tunnel_set_tail (struct GNUNET_MESH_Tunnel *tunnel, void *tail);
 370 void *
 371 GNUNET_MESH_tunnel_get_head (struct GNUNET_MESH_Tunnel *tunnel);
 372 void *
 373 GNUNET_MESH_tunnel_get_tail (struct GNUNET_MESH_Tunnel *tunnel);
 374
 375 void
 376 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data);
 377 void *
 378 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel);
 379
 380 #if 0                           /* keep Emacsens' auto-indent happy */
 381 {
 382 #endif
 383 #ifdef __cplusplus
 384 }
 385 #endif
 386
 387 /* ifndef GNUNET_MESH_SERVICE_H */
 388 #endif
 389 /* end of gnunet_mesh_service.h */