rps-sampler_common.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C)
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     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
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#ifndef RPS_SAMPLER_COMMON_H
#define RPS_SAMPLER_COMMON_H
 
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_statistics_service.h"
 
#include "gnunet-service-rps_sampler_elem.h"
 
#include <math.h>
#include <inttypes.h>
 
#include "rps-test_util.h"
 
 
typedef void
(*RPS_sampler_rand_peer_ready_cont) (void *cls,
                                     const struct GNUNET_PeerIdentity *id,
                                     double probability,
                                     uint32_t num_observed);
 
 
typedef void
(*RPS_get_peers_type) (void *cls);
 
 
typedef void
(*RPS_sampler_n_rand_peers_ready_cb) (const struct GNUNET_PeerIdentity *ids,
                                      uint32_t num_peers,
                                      void *cls);
 
 
typedef void
(*RPS_sampler_sinlge_info_ready_cb) (const struct GNUNET_PeerIdentity *ids,
                                     void *cls,
                                     double probability,
                                     uint32_t num_observed);
 
 
typedef void
(*SamplerNotifyUpdateCB) (void *cls);
 
 
struct GetPeerCls
{
  struct GetPeerCls *next;
  struct GetPeerCls *prev;
 
  struct RPS_SamplerRequestHandle *req_handle;
 
  struct RPS_SamplerRequestHandleSingleInfo *req_single_info_handle;
 
  struct GNUNET_SCHEDULER_Task *get_peer_task;
 
  struct SamplerNotifyUpdateCTX *notify_ctx;
 
  RPS_sampler_rand_peer_ready_cont cont;
 
  void *cont_cls;
 
  struct GNUNET_PeerIdentity *id;
};
 
 
struct RPS_Sampler
{
  unsigned int sampler_size;
  // size_t size;
 
  struct RPS_SamplerElement **sampler_elements;
 
  struct GNUNET_TIME_Relative max_round_interval;
 
  uint32_t num_peers_estim;
 
  double desired_probability;
 
  double deficiency_factor;
 
  RPS_get_peers_type get_peers;
 
  struct RPS_SamplerRequestHandle *req_handle_head;
  struct RPS_SamplerRequestHandle *req_handle_tail;
 
  struct RPS_SamplerRequestHandleSingleInfo *req_handle_single_head;
  struct RPS_SamplerRequestHandleSingleInfo *req_handle_single_tail;
 
  struct SamplerNotifyUpdateCTX *notify_ctx_head;
  struct SamplerNotifyUpdateCTX *notify_ctx_tail;
};
 
 
void
RPS_sampler_update_with_nw_size (struct RPS_Sampler *sampler,
                                 uint32_t num_peers);
 
 
void
RPS_sampler_set_desired_probability (struct RPS_Sampler *sampler,
                                     double desired_probability);
 
 
void
RPS_sampler_set_deficiency_factor (struct RPS_Sampler *sampler,
                                   double deficiency_factor);
 
 
struct SamplerNotifyUpdateCTX *
sampler_notify_on_update (struct RPS_Sampler *sampler,
                          SamplerNotifyUpdateCB notify_cb,
                          void *cls);
 
 
void
RPS_sampler_update (struct RPS_Sampler *sampler,
                    const struct GNUNET_PeerIdentity *id);
 
 
void
RPS_sampler_reinitialise_by_value (struct RPS_Sampler *sampler,
                                   const struct GNUNET_PeerIdentity *id);
 
 
unsigned int
RPS_sampler_get_size (struct RPS_Sampler *sampler);
 
 
void
RPS_sampler_resize (struct RPS_Sampler *sampler, unsigned int new_size);
 
 
struct RPS_SamplerRequestHandle *
RPS_sampler_get_n_rand_peers (struct RPS_Sampler *sampler,
                              uint32_t num_peers,
                              RPS_sampler_n_rand_peers_ready_cb cb,
                              void *cls);
 
 
struct RPS_SamplerRequestHandleSingleInfo *
RPS_sampler_get_rand_peer_info (struct RPS_Sampler *sampler,
                                RPS_sampler_sinlge_info_ready_cb cb,
                                void *cls);
 
 
uint32_t
RPS_sampler_count_id (struct RPS_Sampler *sampler,
                      const struct GNUNET_PeerIdentity *id);
 
 
void
RPS_sampler_request_cancel (struct RPS_SamplerRequestHandle *req_handle);
 
 
void
RPS_sampler_request_single_info_cancel (
  struct RPS_SamplerRequestHandleSingleInfo *req_single_info_handle);
 
 
void
RPS_sampler_destroy (struct RPS_Sampler *sampler);
 
#endif /* RPS_SAMPLER_COMMON_H */
/* end of rps-sampler_common.h */