src/include/gnunet_dv_service.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 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  * @author Christian Grothoff
  23  * @file include/gnunet_dv_service.h
  24  * @brief DV service API (should only be used by the DV plugin)
  25  */
  26 #ifndef GNUNET_SERVICE_DV_H
  27 #define GNUNET_SERVICE_DV_H
  28
  29 #include "gnunet_util_lib.h"
  30
  31
  32 /**
  33  * Signature of a function to be called if DV
  34  * starts to be able to talk to a peer.
  35  *
  36  * @param cls closure
  37  * @param peer newly connected peer
  38  * @param distance distance to the peer
  39  * @param network the peer is located in
  40  */
  41 typedef void (*GNUNET_DV_ConnectCallback)(void *cls,
  42                                           const struct GNUNET_PeerIdentity *peer,
  43                                           uint32_t distance, uint32_t network);
  44
  45
  46 /**
  47  * Signature of a function to be called if DV
  48  * distance to a peer is changed.
  49  *
  50  * @param cls closure
  51  * @param peer connected peer
  52  * @param distance new distance to the peer
  53  */
  54 typedef void (*GNUNET_DV_DistanceChangedCallback)(void *cls,
  55                                                   const struct GNUNET_PeerIdentity *peer,
  56                                                   uint32_t distance);
  57
  58
  59 /**
  60  * Signature of a function to be called if DV
  61  * is no longer able to talk to a peer.
  62  *
  63  * @param cls closure
  64  * @param peer peer that disconnected
  65  */
  66 typedef void (*GNUNET_DV_DisconnectCallback)(void *cls,
  67                                              const struct GNUNET_PeerIdentity *peer);
  68
  69
  70 /**
  71  * Signature of a function to be called if DV
  72  * receives a message for this peer.
  73  *
  74  * @param cls closure
  75  * @param sender sender of the message
  76  * @param distance how far did the message travel
  77  * @param msg actual message payload
  78  */
  79 typedef void (*GNUNET_DV_MessageReceivedCallback)(void *cls,
  80                                                   const struct GNUNET_PeerIdentity *sender,
  81                                                   uint32_t distance,
  82                                                   const struct GNUNET_MessageHeader *msg);
  83
  84
  85 /**
  86  * Signature of a function called once the delivery of a
  87  * message has been successful.
  88  *
  89  * @param cls closure
  90  * @param ok GNUNET_OK on success, GNUNET_SYSERR on error
  91  */
  92 typedef void (*GNUNET_DV_MessageSentCallback)(void *cls,
  93                                               int ok);
  94
  95
  96 /**
  97  * Handle to the DV service.
  98  */
  99 struct GNUNET_DV_ServiceHandle;
 100
 101
 102 /**
 103  * Connect to the DV service.
 104  *
 105  * @param cfg configuration
 106  * @param cls closure for callbacks
 107  * @param connect_cb function to call on connects
 108  * @param distance_cb function to call if distances change
 109  * @param disconnect_cb function to call on disconnects
 110  * @param message_cb function to call if we receive messages
 111  * @return handle to access the service
 112  */
 113 struct GNUNET_DV_ServiceHandle *
 114 GNUNET_DV_service_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 115                            void *cls,
 116                            GNUNET_DV_ConnectCallback connect_cb,
 117                            GNUNET_DV_DistanceChangedCallback distance_cb,
 118                            GNUNET_DV_DisconnectCallback disconnect_cb,
 119                            GNUNET_DV_MessageReceivedCallback message_cb);
 120
 121
 122 /**
 123  * Disconnect from DV service.
 124  *
 125  * @param sh service handle
 126  */
 127 void
 128 GNUNET_DV_service_disconnect (struct GNUNET_DV_ServiceHandle *sh);
 129
 130
 131 /**
 132  * Handle for a send operation.
 133  */
 134 struct GNUNET_DV_TransmitHandle;
 135
 136
 137 /**
 138  * Send a message via DV service.
 139  *
 140  * @param sh service handle
 141  * @param target intended recpient
 142  * @param msg message payload
 143  * @param cb function to invoke when done
 144  * @param cb_cls closure for 'cb'
 145  * @return handle to cancel the operation
 146  */
 147 struct GNUNET_DV_TransmitHandle *
 148 GNUNET_DV_send (struct GNUNET_DV_ServiceHandle *sh,
 149                 const struct GNUNET_PeerIdentity *target,
 150                 const struct GNUNET_MessageHeader *msg,
 151                 GNUNET_DV_MessageSentCallback cb,
 152                 void *cb_cls);
 153
 154
 155 /**
 156  * Abort send operation (naturally, the message may have
 157  * already been transmitted; this only stops the 'cb'
 158  * from being called again).
 159  *
 160  * @param th send operation to cancel
 161  */
 162 void
 163 GNUNET_DV_send_cancel (struct GNUNET_DV_TransmitHandle *th);
 164
 165
 166 #endif