2 This file is part of GNUnet.
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.
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.
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.
22 * @file rps/gnunet-service-rps_sampler.h
23 * @brief sampler implementation
24 * @author Julius Bünger
32 * Callback that is called when a new PeerID is inserted into a sampler.
34 * @param cls the closure given alongside this function.
35 * @param id the PeerID that is inserted
38 (*RPS_sampler_insert_cb) (void *cls,
39 const struct GNUNET_PeerIdentity *id);
42 * Callback that is called when a new PeerID is removed from a sampler.
44 * @param cls the closure given alongside this function.
45 * @param id the PeerID that is removed
48 (*RPS_sampler_remove_cb) (void *cls,
49 const struct GNUNET_PeerIdentity *id);
52 * Callback that is called from _get_n_rand_peers() when the PeerIDs are ready.
54 * @param cls the closure given alongside this function.
55 * @param ids the PeerIDs that were returned
59 (*RPS_sampler_n_rand_peers_ready_cb) (void *cls,
60 struct GNUNET_PeerIdentity *ids, uint32_t num_peers);
64 * A sampler sampling a stream of PeerIDs.
69 * Get the size of the sampler.
71 * @return the size of the sampler
74 RPS_sampler_get_size ();
78 * Grow or shrink the size of the sampler.
80 * @param new_size the new size of the sampler
83 RPS_sampler_resize (unsigned int new_size);
89 * @param new_size the new size of the sampler
96 * Initialise a tuple of samplers.
98 * @param init_size the size the sampler is initialised with
99 * @param id with which all newly created sampler elements are initialised
100 * @param ins_cb the callback that will be called on every PeerID that is
101 * newly inserted into a sampler element
102 * @param ins_cls the closure given to #ins_cb
103 * @param rem_cb the callback that will be called on every PeerID that is
104 * removed from a sampler element
105 * @param rem_cls the closure given to #rem_cb
108 RPS_sampler_init (size_t init_size,
109 struct GNUNET_TIME_Relative max_round_interval,
110 RPS_sampler_insert_cb ins_cb, void *ins_cls,
111 RPS_sampler_remove_cb rem_cb, void *rem_cls);
115 * A fuction to update every sampler in the given list
117 * @param id the PeerID that is put in the sampler
120 RPS_sampler_update_list (const struct GNUNET_PeerIdentity *id);
124 * Reinitialise all previously initialised sampler elements with the given value.
126 * Used to get rid of a PeerID.
128 * @param id the id of the samplers to update.
131 RPS_sampler_reinitialise_by_value (const struct GNUNET_PeerIdentity *id);
135 * Get n random peers out of the sampled peers.
137 * We might want to reinitialise this sampler after giving the
138 * corrsponding peer to the client.
139 * Random with or without consumption?
141 * @param cb callback that will be called once the ids are ready.
142 * @param cls closure given to @a cb
143 * @param for_client #GNUNET_YES if result is used for client,
144 * #GNUNET_NO if used internally
145 * @param num_peers the number of peers requested
148 RPS_sampler_get_n_rand_peers (RPS_sampler_n_rand_peers_ready_cb cb,
149 void *cls, uint32_t num_peers, int for_client);
153 * Counts how many Samplers currently hold a given PeerID.
155 * @param id the PeerID to count.
157 * @return the number of occurrences of id.
160 RPS_sampler_count_id (const struct GNUNET_PeerIdentity *id);
164 * Cleans the samplers.
167 RPS_sampler_destroy ();
170 /* end of gnunet-service-rps.c */