src/include/gnunet_core_service.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 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 2, 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_core_service.h
  23  * @brief core service; this is the main API for encrypted P2P
  24  *        communications
  25  * @author Christian Grothoff
  26  */
  27
  28 #ifndef GNUNET_CORE_SERVICE_H
  29 #define GNUNET_CORE_SERVICE_H
  30
  31 #ifdef __cplusplus
  32 extern "C"
  33 {
  34 #if 0                           /* keep Emacsens' auto-indent happy */
  35 }
  36 #endif
  37 #endif
  38
  39 #include "gnunet_util_lib.h"
  40
  41 /**
  42  * Version number of GNUnet-core API.
  43  */
  44 #define GNUNET_CORE_VERSION 0x00000000
  45
  46
  47 /**
  48  * Opaque handle to the service.
  49  */
  50 struct GNUNET_CORE_Handle;
  51
  52
  53 /**
  54  * Method called whenever a given peer either connects or
  55  * disconnects (or list of connections was requested).
  56  *
  57  * @param cls closure
  58  * @param peer peer identity this notification is about
  59  */
  60 typedef void (*GNUNET_CORE_ClientEventHandler) (void *cls,
  61                                                 const struct
  62                                                 GNUNET_PeerIdentity * peer);
  63
  64
  65 /**
  66  * Type of a send callback to fill up buffers.
  67  *
  68  * @param receiver the receiver of the message
  69  * @param position is the reference to the
  70  *        first unused position in the buffer where GNUnet is building
  71  *        the message
  72  * @param padding is the number of bytes left in that buffer.
  73  * @return the number of bytes written to
  74  *   that buffer (must be a positive number).
  75  */
  76 typedef unsigned int
  77   (*GNUNET_CORE_BufferFillCallback) (void *cls,
  78                                      const struct GNUNET_PeerIdentity *
  79                                      receiver,
  80                                      void *position,
  81                                      size_t padding);
  82
  83
  84 /**
  85  * Functions with this signature are called whenever a message is
  86  * received or transmitted.
  87  *
  88  * @param cls closure
  89  * @param peer the other peer involved (sender or receiver, NULL
  90  *        for loopback messages where we are both sender and receiver)
  91  * @param message the actual message
  92  * @return GNUNET_OK to keep the connection open,
  93  *         GNUNET_SYSERR to close it (signal serious error)
  94  */
  95 typedef int
  96   (*GNUNET_CORE_MessageCallback) (void *cls,
  97                                   const struct GNUNET_PeerIdentity * other,
  98                                   const struct GNUNET_MessageHeader *
  99                                   message);
 100
 101
 102 /**
 103  * Message handler.  Each struct specifies how to handle on particular
 104  * type of message received.
 105  */
 106 struct GNUNET_CORE_MessageHandler
 107 {
 108   /**
 109    * Function to call for messages of "type".
 110    */
 111   GNUNET_CORE_MessageCallback callback;
 112
 113   /**
 114    * Type of the message this handler covers.
 115    */
 116   uint16_t type;
 117
 118   /**
 119    * Expected size of messages of this type.  Use 0 for variable-size.
 120    * If non-zero, messages of the given type will be discarded if they
 121    * do not have the right size.
 122    */
 123   uint16_t expected_size;
 124
 125 };
 126
 127
 128 /**
 129  * Function called after GNUNET_CORE_connect has succeeded
 130  * (or failed for good).  Note that the private key of the
 131  * peer is intentionally not exposed here; if you need it,
 132  * your process should try to read the private key file
 133  * directly (which should work if you are authorized...).
 134  *
 135  * @param cls closure
 136  * @param server handle to the server, NULL if we failed
 137  * @param my_identity ID of this peer, NULL if we failed
 138  * @param publicKey public key of this peer, NULL if we failed
 139  */
 140 typedef void
 141   (*GNUNET_CORE_StartupCallback) (void *cls,
 142                                   struct GNUNET_CORE_Handle * server,
 143                                   const struct GNUNET_PeerIdentity *
 144                                   my_identity,
 145                                   const struct
 146                                   GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *
 147                                   publicKey);
 148
 149
 150 /**
 151  * Connect to the core service.  Note that the connection may
 152  * complete (or fail) asynchronously.
 153  *
 154  * @param sched scheduler to use
 155  * @param cfg configuration to use
 156  * @param timeout after how long should we give up trying to connect to the core service?
 157  * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
 158  * @param init callback to call on timeout or once we have successfully
 159  *        connected to the core service; note that timeout is only meaningful if init is not NULL
 160  * @param connects function to call on peer connect, can be NULL
 161  * @param disconnects function to call on peer disconnect / timeout, can be NULL
 162  * @param bfc function to call to fill up spare bandwidth, can be NULL
 163  * @param inbound_notify function to call for all inbound messages, can be NULL
 164  * @param inbound_hdr_only set to GNUNET_YES if inbound_notify will only read the
 165  *                GNUNET_MessageHeader and hence we do not need to give it the full message;
 166  *                can be used to improve efficiency, ignored if inbound_notify is NULLL
 167  * @param outbound_notify function to call for all outbound messages, can be NULL
 168  * @param outbound_hdr_only set to GNUNET_YES if outbound_notify will only read the
 169  *                GNUNET_MessageHeader and hence we do not need to give it the full message
 170  *                can be used to improve efficiency, ignored if outbound_notify is NULLL
 171  * @param handlers callbacks for messages we care about, NULL-terminated
 172  * @return handle to the core service (only useful for disconnect until 'init' is called),
 173  *           NULL on error (in this case, init is never called)
 174  */
 175 struct GNUNET_CORE_Handle *
 176 GNUNET_CORE_connect (struct GNUNET_SCHEDULER_Handle *sched,
 177                      const struct GNUNET_CONFIGURATION_Handle *cfg,
 178                      struct GNUNET_TIME_Relative timeout,
 179                      void *cls,
 180                      GNUNET_CORE_StartupCallback init,
 181                      GNUNET_CORE_ClientEventHandler connects,
 182                      GNUNET_CORE_ClientEventHandler disconnects,
 183                      GNUNET_CORE_BufferFillCallback bfc,
 184                      GNUNET_CORE_MessageCallback inbound_notify,
 185                      int inbound_hdr_only,
 186                      GNUNET_CORE_MessageCallback outbound_notify,
 187                      int outbound_hdr_only,
 188                      const struct GNUNET_CORE_MessageHandler *handlers);
 189
 190
 191 /**
 192  * Disconnect from the core service.
 193  *
 194  * @param handle connection to core to disconnect
 195  */
 196 void GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle);
 197
 198
 199 /**
 200  * Function called with statistics about the given peer.
 201  *
 202  * @param cls closure
 203  * @param peer identifies the peer
 204  * @param latency current latency estimate, "FOREVER" if we have been
 205  *                disconnected
 206  * @param bpm_in set to the current bandwidth limit (receiving) for this peer
 207  * @param bpm_out set to the current bandwidth limit (sending) for this peer
 208  * @param amount set to the amount that was actually reserved or unreserved
 209  * @param preference current traffic preference for the given peer
 210  */
 211 typedef void
 212   (*GNUNET_CORE_PeerConfigurationInfoCallback) (void *cls,
 213                                                 const struct
 214                                                 GNUNET_PeerIdentity * peer,
 215                                                 unsigned int bpm_in,
 216                                                 unsigned int bpm_out,
 217                                                 struct GNUNET_TIME_Relative
 218                                                 latency, int amount,
 219                                                 unsigned long long preference);
 220
 221
 222 /**
 223  * Obtain statistics and/or change preferences for the given peer.
 224  *
 225  * @param handle connection to core to use
 226  * @param peer identifies the peer
 227  * @param timeout after how long should we give up (and call "info" with NULL
 228  *                for "peer" to signal an error)?
 229  * @param bpm_out set to the current bandwidth limit (sending) for this peer,
 230  *                caller should set "bpm_out" to "-1" to avoid changing
 231  *                the current value; otherwise "bpm_out" will be lowered to
 232  *                the specified value; passing a pointer to "0" can be used to force
 233  *                us to disconnect from the peer; "bpm_out" might not increase
 234  *                as specified since the upper bound is generally
 235  *                determined by the other peer!
 236  * @param amount reserve N bytes for receiving, negative
 237  *                amounts can be used to undo a (recent) reservation;
 238  * @param preference increase incoming traffic share preference by this amount;
 239  *                in the absence of "amount" reservations, we use this
 240  *                preference value to assign proportional bandwidth shares
 241  *                to all connected peers
 242  * @param info function to call with the resulting configuration information
 243  * @param info_cls closure for info
 244  */
 245 // FIXME: should return handle for cancellation!
 246 void
 247 GNUNET_CORE_peer_configure (struct GNUNET_CORE_Handle *handle,
 248                             const struct GNUNET_PeerIdentity *peer,
 249                             struct GNUNET_TIME_Relative timeout,
 250                             unsigned int bpm_out,
 251                             int amount,
 252                             unsigned long long preference,
 253                             GNUNET_CORE_PeerConfigurationInfoCallback info,
 254                             void *info_cls);
 255
 256
 257 /**
 258  * Handle for a transmission request.
 259  */
 260 struct GNUNET_CORE_TransmitHandle;
 261
 262
 263 /**
 264  * Ask the core to call "notify" once it is ready to transmit the
 265  * given number of bytes to the specified "target".  If we are not yet
 266  * connected to the specified peer, a call to this function will cause
 267  * us to try to establish a connection.
 268  *
 269  * @param handle connection to core service
 270  * @param priority how important is the message?
 271  * @param maxdelay how long can the message wait?
 272  * @param target who should receive the message,
 273  *        use NULL for this peer (loopback)
 274  * @param notify_size how many bytes of buffer space does notify want?
 275  * @param notify function to call when buffer space is available
 276  * @param notify_cls closure for notify
 277  * @return non-NULL if the notify callback was queued,
 278  *         NULL if we can not even queue the request (insufficient
 279  *         memory); if NULL is returned, "notify" will NOT be called.
 280  */
 281 struct GNUNET_CORE_TransmitHandle *
 282 GNUNET_CORE_notify_transmit_ready (struct
 283                                    GNUNET_CORE_Handle
 284                                    *handle,
 285                                    unsigned
 286                                    int
 287                                    priority,
 288                                    struct
 289                                    GNUNET_TIME_Relative
 290                                    maxdelay,
 291                                    const
 292                                    struct
 293                                    GNUNET_PeerIdentity
 294                                    *target,
 295                                    size_t
 296                                    notify_size,
 297                                    GNUNET_CONNECTION_TransmitReadyNotify
 298                                    notify,
 299                                    void
 300                                    *notify_cls);
 301
 302
 303 /**
 304  * Cancel the specified transmission-ready notification.
 305  *
 306  * @param h handle that was returned by "notify_transmit_ready".
 307  */
 308 void
 309 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
 310                                           *h);
 311
 312
 313 #if 0                           /* keep Emacsens' auto-indent happy */
 314 {
 315 #endif
 316 #ifdef __cplusplus
 317 }
 318 #endif
 319
 320 /* ifndef GNUNET_CORE_SERVICE_H */
 321 #endif
 322 /* end of gnunet_core_service.h */