moved sampler functionality in file of its own

1 files changed, 147 insertions, 0 deletions

diff --git a/src/rps/gnunet-service-rps_sampler.h b/src/rps/gnunet-service-rps_sampler.h
new file mode 100644
index 000000000..3772f9f0b
--- /dev/null
+++ b/src/rps/gnunet-service-rps_sampler.h
@@ -0,0 +1,147 @@
+/*
+     This file is part of GNUnet.
+     (C)
+
+     GNUnet is free software; you can redistribute it and/or modify
+     it under the terms of the GNU General Public License as published
+     by the Free Software Foundation; either version 3, or (at your
+     option) any later version.
+
+     GNUnet is distributed in the hope that it will be useful, but
+     WITHOUT ANY WARRANTY; without even the implied warranty of
+     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+     General Public License for more details.
+
+     You should have received a copy of the GNU General Public License
+     along with GNUnet; see the file COPYING.  If not, write to the
+     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+     Boston, MA 02111-1307, USA.
+*/
+
+/**
+ * @file rps/gnunet-service-rps_sampler.h
+ * @brief sampler implementation
+ * @author Julius Bünger
+ */
+
+#ifndef RPS_SAMPLER_H
+#define RPS_SAMPLER_H
+#include <inttypes.h>
+
+/**
+ * Callback that is called when a new PeerID is inserted into a sampler.
+ *
+ * @param cls the closure given alongside this function.
+ * @param id the PeerID that is inserted
+ */
+typedef void
+(*RPS_sampler_insert_cb) (void *cls,
+    const struct GNUNET_PeerIdentity *id);
+
+/**
+ * Callback that is called when a new PeerID is removed from a sampler.
+ *
+ * @param cls the closure given alongside this function.
+ * @param id the PeerID that is removed
+ */
+typedef void
+(*RPS_sampler_remove_cb) (void *cls,
+    const struct GNUNET_PeerIdentity *id);
+
+/**
+ * A sampler sampling a stream of PeerIDs.
+ */
+//struct RPS_Sampler;
+
+
+/**
+ * Grow or shrink the size of the sampler.
+ *
+ * @param new_size the new size of the sampler
+ */
+  void
+RPS_sampler_resize (unsigned int new_size);
+
+
+/**
+ * Initialise a tuple of samplers.
+ *
+ * @param init_size the size the sampler is initialised with
+ * @param id with which all newly created sampler elements are initialised
+ * @param ins_cb the callback that will be called on every PeerID that is 
+ *               newly inserted into a sampler element
+ * @param ins_cls the closure given to #ins_cb
+ * @param rem_cb the callback that will be called on every PeerID that is
+ *               removed from a sampler element
+ * @param rem_cls the closure given to #rem_cb
+ */
+  void
+RPS_sampler_init (size_t init_size, const struct GNUNET_PeerIdentity *id,
+    RPS_sampler_insert_cb ins_cb, void *ins_cls,
+    RPS_sampler_remove_cb rem_cb, void *rem_cls);
+
+
+/**
+ * A fuction to update every sampler in the given list
+ *
+ * @param id the PeerID that is put in the sampler
+ */
+  void
+RPS_sampler_update_list (const struct GNUNET_PeerIdentity *id);
+
+
+/**
+ * Reinitialise all previously initialised sampler elements with the given value.
+ *
+ * Used to get rid of a PeerID.
+ *
+ * @param id the id of the samplers to update.
+ */
+  void
+RPS_sampler_reinitialise_by_value (const struct GNUNET_PeerIdentity *id);
+
+
+/**
+ * Get one random peer out of the sampled peers.
+ *
+ * We might want to reinitialise this sampler after giving the
+ * corrsponding peer to the client.
+ *
+ * @return a random PeerID of the PeerIDs previously put into the sampler.
+ */
+  const struct GNUNET_PeerIdentity * 
+RPS_sampler_get_rand_peer ();
+
+
+/**
+ * Get n random peers out of the sampled peers.
+ *
+ * We might want to reinitialise this sampler after giving the
+ * corrsponding peer to the client.
+ * Random with or without consumption?
+ *
+ * @return n random PeerIDs of the PeerIDs previously put into the sampler.
+ */
+  const struct GNUNET_PeerIdentity *
+RPS_sampler_get_n_rand_peers (uint64_t n);
+
+
+/**
+ * Counts how many Samplers currently hold a given PeerID.
+ *
+ * @param id the PeerID to count.
+ *
+ * @return the number of occurrences of id.
+ */
+  uint64_t
+RPS_sampler_count_id (const struct GNUNET_PeerIdentity *id);
+
+
+/**
+ * Cleans the samplers.
+ */
+  void
+RPS_sampler_destroy ();
+
+#endif
+/* end of gnunet-service-rps.c */