src/include/gnunet_mesh_service.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010, 2011, 2012, 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 include/gnunet_mesh_service.h
  23  * @brief mesh service; establish tunnels to distant peers
  24  * @author Christian Grothoff
  25  *
  26  * TODO:
  27  * - need to do sanity check that this is consistent
  28  *   with current ideas for the multicast layer's needs
  29  */
  30
  31 #ifndef GNUNET_MESH_SERVICE_H
  32 #define GNUNET_MESH_SERVICE_H
  33
  34 #ifdef __cplusplus
  35 extern "C"
  36 {
  37 #if 0                           /* keep Emacsens' auto-indent happy */
  38 }
  39 #endif
  40 #endif
  41
  42 #include "gnunet_util_lib.h"
  43 #include "gnunet_transport_service.h"
  44
  45 /**
  46  * Version number of GNUnet-mesh API.
  47  */
  48 #define GNUNET_MESH_VERSION 0x00000001
  49
  50
  51 /**
  52  * Opaque handle to the service.
  53  */
  54 struct GNUNET_MESH_Handle;
  55
  56 /**
  57  * Opaque handle to a tunnel.
  58  */
  59 struct GNUNET_MESH_Tunnel;
  60
  61
  62 /**
  63  * Functions with this signature are called whenever a message is
  64  * received.
  65  *
  66  * Each time the function must call GNUNET_MESH_receive_done on the tunnel
  67  * in order to receive the next message. This doesn't need to be immediate:
  68  * can be delayed if some processing is done on the message.
  69  *
  70  * @param cls Closure (set from GNUNET_MESH_connect).
  71  * @param tunnel Connection to the other end.
  72  * @param tunnel_ctx Place to store local state associated with the tunnel.
  73  * @param message The actual message.
  74  *
  75  * @return GNUNET_OK to keep the tunnel open,
  76  *         GNUNET_SYSERR to close it (signal serious error).
  77  */
  78 typedef int (*GNUNET_MESH_MessageCallback) (void *cls,
  79                                             struct GNUNET_MESH_Tunnel *tunnel,
  80                                             void **tunnel_ctx,
  81                                             const struct GNUNET_MessageHeader *message);
  82
  83
  84 /**
  85  * Message handler.  Each struct specifies how to handle on particular
  86  * type of message received.
  87  */
  88 struct GNUNET_MESH_MessageHandler
  89 {
  90   /**
  91    * Function to call for messages of "type".
  92    */
  93   GNUNET_MESH_MessageCallback callback;
  94
  95   /**
  96    * Type of the message this handler covers.
  97    */
  98   uint16_t type;
  99
 100   /**
 101    * Expected size of messages of this type.  Use 0 for variable-size.
 102    * If non-zero, messages of the given type will be discarded if they
 103    * do not have the right size.
 104    */
 105   uint16_t expected_size;
 106 };
 107
 108
 109 /**
 110  * Method called whenever another peer has added us to a tunnel
 111  * the other peer initiated.
 112  * Only called (once) upon reception of data with a message type which was
 113  * subscribed to in GNUNET_MESH_connect. A call to GNUNET_MESH_tunnel_destroy
 114  * causes te tunnel to be ignored and no further notifications are sent about
 115  * the same tunnel.
 116  *
 117  * @param cls closure
 118  * @param tunnel new handle to the tunnel
 119  * @param initiator peer that started the tunnel
 120  * @param port Port this tunnel is for.
 121  * @return initial tunnel context for the tunnel
 122  *         (can be NULL -- that's not an error)
 123  */
 124 typedef void *(GNUNET_MESH_InboundTunnelNotificationHandler) (void *cls,
 125                                                               struct
 126                                                               GNUNET_MESH_Tunnel
 127                                                               * tunnel,
 128                                                               const struct
 129                                                               GNUNET_PeerIdentity
 130                                                               * initiator,
 131                                                               uint32_t port);
 132
 133
 134 /**
 135  * Function called whenever a tunnel is destroyed.  Should clean up
 136  * any associated state.
 137  *
 138  * It must NOT call GNUNET_MESH_tunnel_destroy on the tunnel.
 139  *
 140  * @param cls closure (set from GNUNET_MESH_connect)
 141  * @param tunnel connection to the other end (henceforth invalid)
 142  * @param tunnel_ctx place where local state associated
 143  *                   with the tunnel is stored
 144  */
 145 typedef void (GNUNET_MESH_TunnelEndHandler) (void *cls,
 146                                              const struct GNUNET_MESH_Tunnel *
 147                                              tunnel, void *tunnel_ctx);
 148
 149
 150 /**
 151  * Connect to the mesh service.
 152  *
 153  * @param cfg Configuration to use.
 154  * @param cls Closure for the various callbacks that follow (including
 155  *            handlers in the handlers array).
 156  * @param new_tunnel Function called when an *inbound* tunnel is created.
 157  *                   Can be NULL if no inbound tunnels are desired.
 158  * @param cleaner Function called when a tunnel is destroyed by the remote peer.
 159  *                It is NOT called if GNUNET_MESH_tunnel_destroy is called on
 160  *                the tunnel.
 161  * @param handlers Callbacks for messages we care about, NULL-terminated. Each
 162  *                 one must call GNUNET_MESH_receive_done on the tunnel to
 163  *                 receive the next message.  Messages of a type that is not
 164  *                 in the handlers array are ignored if received.
 165  * @param ports NULL or 0-terminated array of port numbers for incoming tunnels.
 166  *
 167  * @return handle to the mesh service NULL on error
 168  *         (in this case, init is never called)
 169  */
 170 struct GNUNET_MESH_Handle *
 171 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
 172                      GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
 173                      GNUNET_MESH_TunnelEndHandler cleaner,
 174                      const struct GNUNET_MESH_MessageHandler *handlers,
 175                      const uint32_t *ports);
 176
 177
 178 /**
 179  * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
 180  * disconnect callbacks will be called on any still connected peers, notifying
 181  * about their disconnection. The registered inbound tunnel cleaner will be
 182  * called should any inbound tunnels still exist.
 183  *
 184  * @param handle connection to mesh to disconnect
 185  */
 186 void
 187 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle);
 188
 189
 190 /**
 191  * Create a new tunnel (we're initiator and will be allowed to add/remove peers
 192  * and to broadcast).
 193  *
 194  * @param h mesh handle
 195  * @param tunnel_ctx client's tunnel context to associate with the tunnel
 196  * @param peer peer identity the tunnel should go to
 197  * @param port Port number.
 198  * @return handle to the tunnel
 199  */
 200 struct GNUNET_MESH_Tunnel *
 201 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h,
 202                            void *tunnel_ctx,
 203                            const struct GNUNET_PeerIdentity *peer,
 204                            uint32_t port);
 205
 206
 207 /**
 208  * Destroy an existing tunnel.
 209  *
 210  * The existing end callback for the tunnel will be called immediately.
 211  * Any pending outgoing messages will be sent but no incoming messages will be
 212  * accepted and no data callbacks will be called.
 213  *
 214  * @param tunnel Tunnel handle, becomes invalid after this call.
 215  */
 216 void
 217 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel);
 218
 219
 220 /**
 221  * Turn on/off the buffering status of the tunnel.
 222  *
 223  * @param tunnel Tunnel affected.
 224  * @param buffer GNUNET_YES to turn buffering on (default),
 225  *               GNUNET_NO otherwise.
 226  */
 227 void
 228 GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer);
 229
 230
 231 /**
 232  * Turn on/off the reliability of the tunnel.
 233  *
 234  * If reliability is on, mesh will resend lost messages, similar to TCP.
 235  * If reliability is off, mesh just do best effort, similar to UDP.
 236  *
 237  * @param tunnel Tunnel affected.
 238  * @param reliable GNUNET_YES to turn reliability on,
 239  *                 GNUNET_NO to have a best effort tunnel (default).
 240  */
 241 void
 242 GNUNET_MESH_tunnel_reliable (struct GNUNET_MESH_Tunnel *tunnel, int reliable);
 243
 244
 245 /**
 246  * Handle for a transmission request.
 247  */
 248 struct GNUNET_MESH_TransmitHandle;
 249
 250
 251 /**
 252  * Ask the mesh to call "notify" once it is ready to transmit the
 253  * given number of bytes to the specified tunnel.
 254  * Only one call can be active at any time, to issue another request,
 255  * wait for the callback or cancel the current request.
 256  *
 257  * @param tunnel tunnel to use for transmission
 258  * @param cork is corking allowed for this transmission?
 259  * @param maxdelay how long can the message wait?
 260  * @param notify_size how many bytes of buffer space does notify want?
 261  * @param notify function to call when buffer space is available;
 262  *        will be called with NULL on timeout or if the overall queue
 263  *        for this peer is larger than queue_size and this is currently
 264  *        the message with the lowest priority
 265  * @param notify_cls closure for notify
 266  * @return non-NULL if the notify callback was queued,
 267  *         NULL if we can not even queue the request (insufficient
 268  *         memory); if NULL is returned, "notify" will NOT be called.
 269  */
 270 struct GNUNET_MESH_TransmitHandle *
 271 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
 272                                    struct GNUNET_TIME_Relative maxdelay,
 273                                    size_t notify_size,
 274                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
 275                                    void *notify_cls);
 276
 277
 278 /**
 279  * Cancel the specified transmission-ready notification.
 280  *
 281  * @param th handle that was returned by "notify_transmit_ready".
 282  */
 283 void
 284 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle
 285                                           *th);
 286
 287
 288 /**
 289  * Indicate readiness to receive the next message on a tunnel.
 290  *
 291  * Should only be called once per handler called.
 292  *
 293  * @param tunnel Tunnel that will be allowed to call another handler.
 294  */
 295 void
 296 GNUNET_MESH_receive_done (struct GNUNET_MESH_Tunnel *tunnel);
 297
 298
 299
 300 /******************************************************************************/
 301 /********************       MONITORING /DEBUG API     *************************/
 302 /******************************************************************************/
 303 /* The following calls are not useful for normal MESH operation, but for      */
 304 /* debug and monitoring of the mesh state. They can be safely ignored.        */
 305 /* The API can change at any point without notice.                            */
 306 /* Please contact the developer if you consider any of this calls useful for  */
 307 /* normal mesh applications.                                                  */
 308 /******************************************************************************/
 309
 310 /**
 311  * Method called to retrieve information about each tunnel the mesh peer
 312  * is aware of.
 313  *
 314  * @param cls Closure.
 315  * @param tunnel_number Tunnel number.
 316  * @param origin that started the tunnel (owner).
 317  * @param target other endpoint of the tunnel
 318  */
 319 typedef void (*GNUNET_MESH_TunnelsCB) (void *cls,
 320                                        uint32_t tunnel_number,
 321                                        const struct GNUNET_PeerIdentity *origin,
 322                                        const struct GNUNET_PeerIdentity *target);
 323
 324
 325 /**
 326  * Method called to retrieve information about a specific tunnel the mesh peer
 327  * is aware of, including all transit nodes.
 328  *
 329  * @param cls Closure.
 330  * @param peer Peer in the tunnel's tree.
 331  * @param parent Parent of the current peer. All 0 when peer is root.
 332  */
 333 typedef void (*GNUNET_MESH_TunnelCB) (void *cls,
 334                                       const struct GNUNET_PeerIdentity *peer,
 335                                       const struct GNUNET_PeerIdentity *parent);
 336
 337
 338 /**
 339  * Request information about the running mesh peer.
 340  * The callback will be called for every tunnel known to the service,
 341  * listing all active peers that belong to the tunnel.
 342  *
 343  * If called again on the same handle, it will overwrite the previous
 344  * callback and cls. To retrieve the cls, monitor_cancel must be
 345  * called first.
 346  *
 347  * WARNING: unstable API, likely to change in the future!
 348  *
 349  * @param h Handle to the mesh peer.
 350  * @param callback Function to call with the requested data.
 351  * @param callback_cls Closure for @c callback.
 352  */
 353 void
 354 GNUNET_MESH_get_tunnels (struct GNUNET_MESH_Handle *h,
 355                          GNUNET_MESH_TunnelsCB callback,
 356                          void *callback_cls);
 357
 358
 359 /**
 360  * Request information about a specific tunnel of the running mesh peer.
 361  *
 362  * WARNING: unstable API, likely to change in the future!
 363  *
 364  * @param h Handle to the mesh peer.
 365  * @param initiator ID of the owner of the tunnel.
 366  * @param tunnel_number Tunnel number.
 367  * @param callback Function to call with the requested data.
 368  * @param callback_cls Closure for @c callback.
 369  */
 370 void
 371 GNUNET_MESH_show_tunnel (struct GNUNET_MESH_Handle *h,
 372                          struct GNUNET_PeerIdentity *initiator,
 373                          uint32_t tunnel_number,
 374                          GNUNET_MESH_TunnelCB callback,
 375                          void *callback_cls);
 376
 377
 378 /**
 379  * Cancel a monitor request. The monitor callback will not be called.
 380  *
 381  * WARNING: unstable API, likely to change in the future!
 382  *
 383  * @param h Mesh handle.
 384  *
 385  * @return Closure given to GNUNET_MESH_monitor, if any.
 386  */
 387 void *
 388 GNUNET_MESH_get_tunnels_cancel (struct GNUNET_MESH_Handle *h);
 389
 390
 391 /**
 392  * Create a message queue for a mesh tunnel.
 393  * The message queue can only be used to transmit messages,
 394  * not to receive them.
 395  *
 396  * @param tunnel the tunnel to create the message qeue for
 397  * @return a message queue to messages over the tunnel
 398  */
 399 struct GNUNET_MQ_Handle *
 400 GNUNET_MESH_mq_create (struct GNUNET_MESH_Tunnel *tunnel);
 401
 402
 403 #if 0                           /* keep Emacsens' auto-indent happy */
 404 {
 405 #endif
 406 #ifdef __cplusplus
 407 }
 408 #endif
 409
 410 /* ifndef GNUNET_MESH_SERVICE_H */
 411 #endif
 412 /* end of gnunet_mesh_service.h */