2 This file is part of GNUnet.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * @file rps/rps-sampler_client.h
21 * @brief client sampler implementation
22 * @author Julius Bünger
25 #ifndef RPS_SAMPLER_CLIENT_H
26 #define RPS_SAMPLER_CLIENT_H
28 #include "rps-sampler_common.h"
32 * A sampler sampling a stream of PeerIDs.
37 * A handle to cancel a request.
39 struct RPS_SamplerRequestHandle;
43 * Get the size of the sampler.
45 * @param sampler the sampler to return the size of.
46 * @return the size of the sampler
49 RPS_sampler_get_size (struct RPS_Sampler *sampler);
53 * Grow or shrink the size of the sampler.
55 * @param sampler the sampler to resize.
56 * @param new_size the new size of the sampler (not 0)
59 RPS_sampler_resize (struct RPS_Sampler *sampler, unsigned int new_size);
63 * Initialise a modified tuple of sampler elements.
65 * @param init_size the size the sampler is initialised with
66 * @param max_round_interval maximum time a round takes
67 * @return a handle to a sampler that consists of sampler elements.
70 RPS_sampler_mod_init (size_t init_size,
71 struct GNUNET_TIME_Relative max_round_interval);
75 * Update every sampler element of this sampler with given peer
77 * @param sampler the sampler to update.
78 * @param id the PeerID that is put in the sampler
81 RPS_sampler_update (struct RPS_Sampler *sampler,
82 const struct GNUNET_PeerIdentity *id);
86 * Reinitialise all previously initialised sampler elements with the given
89 * Used to get rid of a PeerID.
91 * @param sampler the sampler to reinitialise a sampler in.
92 * @param id the id of the samplers to update.
95 RPS_sampler_reinitialise_by_value (struct RPS_Sampler *sampler,
96 const struct GNUNET_PeerIdentity *id);
100 * Get n random peers out of the sampled peers.
102 * We might want to reinitialise this sampler after giving the
103 * corrsponding peer to the client.
104 * Random with or without consumption?
106 * @param sampler the sampler to get peers from.
107 * @param cb callback that will be called once the ids are ready.
108 * @param cls closure given to @a cb
109 * @param for_client #GNUNET_YES if result is used for client,
110 * #GNUNET_NO if used internally
111 * @param num_peers the number of peers requested
113 struct RPS_SamplerRequestHandle *
114 RPS_sampler_get_n_rand_peers (struct RPS_Sampler *sampler,
116 RPS_sampler_n_rand_peers_ready_cb cb,
120 * Cancle a request issued through #RPS_sampler_n_rand_peers_ready_cb.
122 * @param req_handle the handle to the request
125 RPS_sampler_request_cancel (struct RPS_SamplerRequestHandle *req_handle);
129 * Counts how many Samplers currently hold a given PeerID.
131 * @param sampler the sampler to cound ids in.
132 * @param id the PeerID to count.
134 * @return the number of occurrences of id.
137 RPS_sampler_count_id (struct RPS_Sampler *sampler,
138 const struct GNUNET_PeerIdentity *id);
142 * Cleans the samplers.
144 * @param sampler the sampler to destroy.
147 RPS_sampler_destroy (struct RPS_Sampler *sampler);
149 #endif /* RPS_SAMPLER_CLIENT_H */
150 /* end of gnunet-service-rps.c */