src/include/gnunet_core_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 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.
  55  *
  56  * @param cls closure
  57  * @param peer peer identity this notification is about
  58  * @param latency reported latency of the connection with 'other'
  59  * @param distance reported distance (DV) to 'other'
  60  */
  61 typedef void (*GNUNET_CORE_ConnectEventHandler) (void *cls,
  62                                                  const struct
  63                                                  GNUNET_PeerIdentity * peer,
  64                                                  struct GNUNET_TIME_Relative latency,
  65                                                  uint32_t distance);
  66
  67
  68
  69 /**
  70  * Method called whenever a given peer either disconnects.
  71  *
  72  * @param cls closure
  73  * @param peer peer identity this notification is about
  74  */
  75 typedef void (*GNUNET_CORE_DisconnectEventHandler) (void *cls,
  76                                                     const struct
  77                                                     GNUNET_PeerIdentity * peer);
  78
  79
  80 /**
  81  * Functions with this signature are called whenever a message is
  82  * received or transmitted.
  83  *
  84  * @param cls closure
  85  * @param peer the other peer involved (sender or receiver, NULL
  86  *        for loopback messages where we are both sender and receiver)
  87  * @param message the actual message
  88  * @param latency reported latency of the connection with 'other'
  89  * @param distance reported distance (DV) to 'other'
  90  * @return GNUNET_OK to keep the connection open,
  91  *         GNUNET_SYSERR to close it (signal serious error)
  92  */
  93 typedef int
  94   (*GNUNET_CORE_MessageCallback) (void *cls,
  95                                   const struct GNUNET_PeerIdentity * other,
  96                                   const struct GNUNET_MessageHeader *
  97                                   message,
  98                                   struct GNUNET_TIME_Relative latency,
  99                                   uint32_t distance);
 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 pre_connects function to call on peer pre-connect (no session key yet), can be NULL
 161  * @param connects function to call on peer connect, can be NULL
 162  * @param disconnects function to call on peer disconnect / timeout, 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_ConnectEventHandler pre_connects,
 182                      GNUNET_CORE_ConnectEventHandler connects,
 183                      GNUNET_CORE_DisconnectEventHandler disconnects,
 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  * Handle for a request to the core to connect or disconnect
 201  * from a particular peer.  Can be used to cancel the request
 202  * (before the 'cont'inuation is called).
 203  */
 204 struct GNUNET_CORE_PeerRequestHandle;
 205
 206
 207 /**
 208  * Request that the core should try to connect to a particular peer.
 209  * Once the request has been transmitted to the core, the continuation
 210  * function will be called.  Note that this does NOT mean that a
 211  * connection was successfully established -- it only means that the
 212  * core will now try.  Successful establishment of the connection
 213  * will be signalled to the 'connects' callback argument of
 214  * 'GNUNET_CORE_connect' only.  If the core service does not respond
 215  * to our connection attempt within the given time frame, 'cont' will
 216  * be called with the TIMEOUT reason code.
 217  *
 218  * @param sched scheduler to use
 219  * @param cfg configuration to use
 220  * @param timeout how long to try to talk to core
 221  * @param cont function to call once the request has been completed (or timed out)
 222  * @param cont_cls closure for cont
 223  * @return NULL on error (cont will not be called), otherwise handle for cancellation
 224  */
 225 struct GNUNET_CORE_PeerRequestHandle *
 226 GNUNET_CORE_peer_request_connect (struct GNUNET_SCHEDULER_Handle *sched,
 227                                   const struct GNUNET_CONFIGURATION_Handle *cfg,
 228                                   struct GNUNET_TIME_Relative timeout,
 229                                   const struct GNUNET_PeerIdentity * peer,
 230                                   GNUNET_SCHEDULER_Task cont,
 231                                   void *cont_cls);
 232
 233
 234 /**
 235  * Cancel a pending request to connect to a particular peer.  Must not
 236  * be called after the 'cont' function was invoked.
 237  *
 238  * @param req request handle that was returned for the original request
 239  */
 240 void
 241 GNUNET_CORE_peer_request_connect_cancel (struct GNUNET_CORE_PeerRequestHandle *req);
 242
 243
 244 /**
 245  * Function called with statistics about the given peer.
 246  *
 247  * @param cls closure
 248  * @param peer identifies the peer
 249  * @param bpm_in set to the current bandwidth limit (receiving) for this peer
 250  * @param bpm_out set to the current bandwidth limit (sending) for this peer
 251  * @param latency current latency estimate, "FOREVER" if we have been
 252  *                disconnected
 253  * @param amount set to the amount that was actually reserved or unreserved
 254  * @param preference current traffic preference for the given peer
 255  */
 256 typedef void
 257   (*GNUNET_CORE_PeerConfigurationInfoCallback) (void *cls,
 258                                                 const struct
 259                                                 GNUNET_PeerIdentity * peer,
 260                                                 unsigned int bpm_in,
 261                                                 unsigned int bpm_out,
 262                                                 int amount,
 263                                                 uint64_t preference);
 264
 265
 266
 267 /**
 268  * Context that can be used to cancel a peer information request.
 269  */
 270 struct GNUNET_CORE_InformationRequestContext;
 271
 272 /**
 273  * Obtain statistics and/or change preferences for the given peer.
 274  *
 275  * @param sched scheduler to use
 276  * @param cfg configuration to use
 277  * @param peer identifies the peer
 278  * @param timeout after how long should we give up (and call "info" with NULL
 279  *                for "peer" to signal an error)?
 280  * @param bpm_out set to the current bandwidth limit (sending) for this peer,
 281  *                caller should set "bpm_out" to "-1" to avoid changing
 282  *                the current value; otherwise "bpm_out" will be lowered to
 283  *                the specified value; passing a pointer to "0" can be used to force
 284  *                us to disconnect from the peer; "bpm_out" might not increase
 285  *                as specified since the upper bound is generally
 286  *                determined by the other peer!
 287  * @param amount reserve N bytes for receiving, negative
 288  *                amounts can be used to undo a (recent) reservation;
 289  * @param preference increase incoming traffic share preference by this amount;
 290  *                in the absence of "amount" reservations, we use this
 291  *                preference value to assign proportional bandwidth shares
 292  *                to all connected peers
 293  * @param info function to call with the resulting configuration information
 294  * @param info_cls closure for info
 295  * @return NULL on error
 296  */
 297 struct GNUNET_CORE_InformationRequestContext *
 298 GNUNET_CORE_peer_change_preference (struct GNUNET_SCHEDULER_Handle *sched,
 299                                     const struct GNUNET_CONFIGURATION_Handle *cfg,
 300                                     const struct GNUNET_PeerIdentity *peer,
 301                                     struct GNUNET_TIME_Relative timeout,
 302                                     uint32_t bpm_out,
 303                                     int32_t amount,
 304                                     uint64_t preference,
 305                                     GNUNET_CORE_PeerConfigurationInfoCallback info,
 306                                     void *info_cls);
 307
 308
 309 /**
 310  * Cancel request for getting information about a peer.
 311  *
 312  * @param irc context returned by the original GNUNET_CORE_peer_get_info call
 313  */
 314 void
 315 GNUNET_CORE_peer_change_preference_cancel (struct GNUNET_CORE_InformationRequestContext *irc);
 316
 317
 318 /**
 319  * Handle for a transmission request.
 320  */
 321 struct GNUNET_CORE_TransmitHandle;
 322
 323
 324 /**
 325  * Ask the core to call "notify" once it is ready to transmit the
 326  * given number of bytes to the specified "target".  If we are not yet
 327  * connected to the specified peer, a call to this function will cause
 328  * us to try to establish a connection.
 329  *
 330  * @param handle connection to core service
 331  * @param priority how important is the message?
 332  * @param maxdelay how long can the message wait?
 333  * @param target who should receive the message,
 334  *        use NULL for this peer (loopback)
 335  * @param notify_size how many bytes of buffer space does notify want?
 336  * @param notify function to call when buffer space is available
 337  * @param notify_cls closure for notify
 338  * @return non-NULL if the notify callback was queued,
 339  *         NULL if we can not even queue the request (insufficient
 340  *         memory); if NULL is returned, "notify" will NOT be called.
 341  */
 342 struct GNUNET_CORE_TransmitHandle *
 343 GNUNET_CORE_notify_transmit_ready (struct
 344                                    GNUNET_CORE_Handle
 345                                    *handle,
 346                                    uint32_t priority,
 347                                    struct
 348                                    GNUNET_TIME_Relative
 349                                    maxdelay,
 350                                    const
 351                                    struct
 352                                    GNUNET_PeerIdentity
 353                                    *target,
 354                                    size_t
 355                                    notify_size,
 356                                    GNUNET_CONNECTION_TransmitReadyNotify
 357                                    notify,
 358                                    void
 359                                    *notify_cls);
 360
 361
 362 /**
 363  * Cancel the specified transmission-ready notification.
 364  *
 365  * @param h handle that was returned by "notify_transmit_ready".
 366  */
 367 void
 368 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
 369                                           *h);
 370
 371
 372 #if 0                           /* keep Emacsens' auto-indent happy */
 373 {
 374 #endif
 375 #ifdef __cplusplus
 376 }
 377 #endif
 378
 379 /* ifndef GNUNET_CORE_SERVICE_H */
 380 #endif
 381 /* end of gnunet_core_service.h */