src/rps/gnunet-service-rps_sampler.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 rps/gnunet-service-rps_sampler.h
  23  * @brief sampler implementation
  24  * @author Julius Bünger
  25  */
  26
  27 #ifndef RPS_SAMPLER_H
  28 #define RPS_SAMPLER_H
  29 #include <inttypes.h>
  30
  31 /**
  32  * Callback that is called when a new PeerID is inserted into a sampler.
  33  *
  34  * @param cls the closure given alongside this function.
  35  * @param id the PeerID that is inserted
  36  */
  37 typedef void
  38 (*RPS_sampler_insert_cb) (void *cls,
  39     const struct GNUNET_PeerIdentity *id);
  40
  41 /**
  42  * Callback that is called when a new PeerID is removed from a sampler.
  43  *
  44  * @param cls the closure given alongside this function.
  45  * @param id the PeerID that is removed
  46  */
  47 typedef void
  48 (*RPS_sampler_remove_cb) (void *cls,
  49     const struct GNUNET_PeerIdentity *id);
  50
  51 /**
  52  * Callback that is called from _get_n_rand_peers() when the PeerIDs are ready.
  53  *
  54  * @param cls the closure given alongside this function.
  55  * @param ids the PeerIDs that were returned
  56  *        to be freed
  57  */
  58   typedef void
  59 (*RPS_sampler_n_rand_peers_ready_cb) (void *cls,
  60     struct GNUNET_PeerIdentity *ids, uint32_t num_peers);
  61
  62
  63 /**
  64  * A sampler sampling a stream of PeerIDs.
  65  */
  66 //struct RPS_Sampler;
  67
  68 /**
  69  * Get the size of the sampler.
  70  *
  71  * @return the size of the sampler
  72  */
  73 unsigned int
  74 RPS_sampler_get_size ();
  75
  76
  77 /**
  78  * Grow or shrink the size of the sampler.
  79  *
  80  * @param new_size the new size of the sampler
  81  */
  82   void
  83 RPS_sampler_resize (unsigned int new_size);
  84
  85
  86 /**
  87  * Initialise a tuple of samplers.
  88  *
  89  * @param init_size the size the sampler is initialised with
  90  * @param id with which all newly created sampler elements are initialised
  91  * @param ins_cb the callback that will be called on every PeerID that is
  92  *               newly inserted into a sampler element
  93  * @param ins_cls the closure given to #ins_cb
  94  * @param rem_cb the callback that will be called on every PeerID that is
  95  *               removed from a sampler element
  96  * @param rem_cls the closure given to #rem_cb
  97  */
  98   void
  99 RPS_sampler_init (size_t init_size,
 100     struct GNUNET_TIME_Relative max_round_interval,
 101     RPS_sampler_insert_cb ins_cb, void *ins_cls,
 102     RPS_sampler_remove_cb rem_cb, void *rem_cls);
 103
 104
 105 /**
 106  * A fuction to update every sampler in the given list
 107  *
 108  * @param id the PeerID that is put in the sampler
 109  */
 110   void
 111 RPS_sampler_update_list (const struct GNUNET_PeerIdentity *id);
 112
 113
 114 /**
 115  * Reinitialise all previously initialised sampler elements with the given value.
 116  *
 117  * Used to get rid of a PeerID.
 118  *
 119  * @param id the id of the samplers to update.
 120  */
 121   void
 122 RPS_sampler_reinitialise_by_value (const struct GNUNET_PeerIdentity *id);
 123
 124
 125 /**
 126  * Get n random peers out of the sampled peers.
 127  *
 128  * We might want to reinitialise this sampler after giving the
 129  * corrsponding peer to the client.
 130  * Random with or without consumption?
 131  *
 132  * @param cb callback that will be called once the ids are ready.
 133  * @param cls closure given to @a cb
 134  * @param for_client #GNUNET_YES if result is used for client,
 135  *                   #GNUNET_NO if used internally
 136  * @param num_peers the number of peers requested
 137  */
 138     void
 139 RPS_sampler_get_n_rand_peers (RPS_sampler_n_rand_peers_ready_cb cb,
 140     void *cls, uint32_t num_peers, int for_client);
 141
 142
 143 /**
 144  * Counts how many Samplers currently hold a given PeerID.
 145  *
 146  * @param id the PeerID to count.
 147  *
 148  * @return the number of occurrences of id.
 149  */
 150   uint32_t
 151 RPS_sampler_count_id (const struct GNUNET_PeerIdentity *id);
 152
 153
 154 /**
 155  * Cleans the samplers.
 156  */
 157   void
 158 RPS_sampler_destroy ();
 159
 160 #endif
 161 /* end of gnunet-service-rps.c */