src/include/gnunet_rps_service.h

   1 /*
   2       This file is part of GNUnet
   3       (C)
   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_rps_service.h
  23  * @brief API to the rps service
  24  * @author Julius Bünger
  25  */
  26 #ifndef GNUNET_RPS_SERVICE_H
  27 #define GNUNET_RPS_SERVICE_H
  28
  29 #ifdef __cplusplus
  30 extern "C"
  31 {
  32 #if 0                           /* keep Emacsens' auto-indent happy */
  33 }
  34 #endif
  35 #endif
  36
  37 /**
  38  * Version of the rps API.
  39  */
  40 #define GNUNET_RPS_VERSION 0x00000000
  41
  42 /**
  43  * Handle for the random peer sampling service
  44  */
  45 struct GNUNET_RPS_Handle;
  46
  47 /**
  48  * Handle for one request to the rps service
  49  */
  50 struct GNUNET_RPS_Request_Handle;
  51
  52 /**
  53  * Callback called when requested random peers are available.
  54  *
  55  * @param cls the closure given with the request
  56  * @param num_peers the number of peers returned
  57  * @param peers array with num_peers PeerIDs
  58  */
  59 typedef void (* GNUNET_RPS_NotifyReadyCB) (void *cls, uint64_t num_peers, const struct GNUNET_PeerIdentity *peers);
  60
  61 /**
  62  * Request n random peers.
  63  *
  64  * This is a wrapper function that makes it unnecessary to have to
  65  * (dis)connect from/to the service.
  66  *
  67  * @param cfg the configuration to use
  68  * @param n number of peers to be returned
  69  * @param ready_cb the callback to be called when the PeerIDs are available
  70  * @param cls closure given to the callback
  71  * @return handle to this request
  72  */
  73   struct GNUNET_RPS_Request_Handle *
  74 GNUNET_RPS_request_peers_single_call (const struct GNUNET_CONFIGURATION_Handle *cfg,
  75                           uint64_t n,
  76                           GNUNET_RPS_NotifyReadyCB ready_cb,
  77                           void *cls);
  78
  79 /**
  80  * Connect to the rps service
  81  *
  82  * @param cfg configuration to use
  83  * @return handle to the rps service
  84  */
  85   struct GNUNET_RPS_Handle *
  86 GNUNET_RPS_connect( const struct GNUNET_CONFIGURATION_Handle *cfg );
  87
  88 /**
  89  * Request n random peers.
  90  *
  91  * This does exacly the same as GNUNET_RPS_request_peers_single_call
  92  * but needs a GNUNET_RPS_Handle.
  93  * This exists only for other parts of GNUnet that expect having to
  94  * (dis)connect from/to a service.
  95  *
  96  * @param h handle to the rps service
  97  * @param n number of random peers to return
  98  * @param ready_cb the callback to be called when the peers are available
  99  * @param cls a closure that will be given to the callback
 100  * @return handle to this request
 101  */
 102   struct GNUNET_RPS_Request_Handle *
 103 GNUNET_RPS_request_peers (struct GNUNET_RPS_Handle *h, uint64_t n,
 104                           GNUNET_RPS_NotifyReadyCB ready_cb,
 105                           void *cls);
 106
 107 /**
 108  * Seed rps service with peerIDs.
 109  */
 110   void
 111 GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h, uint64_t n,
 112                      struct GNUNET_PeerIdentity * ids);
 113
 114 /**
 115  * Cancle an issued request.
 116  *
 117  * @param rh handle of the pending request to be canceled
 118  */
 119   void
 120 GNUNET_RPS_request_cancel ( struct GNUNET_RPS_Request_Handle *rh );
 121
 122 /**
 123  * Disconnect from the rps service
 124  *
 125  * @param h the handle to the rps service
 126  */
 127   void
 128 GNUNET_RPS_disconnect ( struct GNUNET_RPS_Handle *h );
 129
 130 #if 0                           /* keep Emacsens' auto-indent happy */
 131 {
 132 #endif
 133 #ifdef __cplusplus
 134 }
 135 #endif
 136
 137 #endif