src/rps/gnunet-service-rps_sampler.h

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