X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_rps_service.h;h=8ae9f1e936fc56b21fa5cd2f4eafb7122ccd3317;hb=a5a54c51011a9498e72b2a9341b35333c6beef1a;hp=c91804a60230833da493c350195b6356945c450c;hpb=219e64fe613c47eab4c143791128c2b453be3bf8;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_rps_service.h b/src/include/gnunet_rps_service.h index c91804a60..8ae9f1e93 100644 --- a/src/include/gnunet_rps_service.h +++ b/src/include/gnunet_rps_service.h @@ -2,20 +2,20 @@ 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 General Public License as published - by the Free Software Foundation; either version 3, or (at your - option) any later version. + 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 - General Public License for more details. + 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 . - 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., 51 Franklin Street, Fifth Floor, - Boston, MA 02110-1301, USA. + SPDX-License-Identifier: AGPL3.0-or-later */ /** @@ -65,6 +65,7 @@ typedef void (* GNUNET_RPS_NotifyReadyCB) (void *cls, uint64_t num_peers, const struct GNUNET_PeerIdentity *peers); + /** * Connect to the rps service * @@ -74,6 +75,29 @@ typedef void (* GNUNET_RPS_NotifyReadyCB) (void *cls, struct GNUNET_RPS_Handle * GNUNET_RPS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg); + +/** + * @brief Start a sub with the given shared value + * + * @param h Handle to rps + * @param shared_value The shared value that defines the members of the sub (-gorup) + */ +void +GNUNET_RPS_sub_start (struct GNUNET_RPS_Handle *h, + const char *shared_value); + + +/** + * @brief Stop a sub with the given shared value + * + * @param h Handle to rps + * @param shared_value The shared value that defines the members of the sub (-gorup) + */ +void +GNUNET_RPS_sub_stop (struct GNUNET_RPS_Handle *h, + const char *shared_value); + + /** * Request n random peers. * @@ -136,6 +160,45 @@ GNUNET_RPS_act_malicious (struct GNUNET_RPS_Handle *h, const struct GNUNET_PeerIdentity *target_peer); #endif /* ENABLE_MALICIOUS */ +/* Get internals for debugging/profiling purposes */ + +/** + * Request updates of view + * + * @param rps_handle handle to the rps service + * @param num_req_peers number of peers we want to receive + * (0 for infinite updates) + * @param cls a closure that will be given to the callback + * @param ready_cb the callback called when the peers are available + */ +void +GNUNET_RPS_view_request (struct GNUNET_RPS_Handle *rps_handle, + uint32_t num_updates, + GNUNET_RPS_NotifyReadyCB view_update_cb, + void *cls); + + +/** + * Request biased stream of peers that are being put into the sampler + * + * @param rps_handle handle to the rps service + * @param cls a closure that will be given to the callback + * @param ready_cb the callback called when the peers are available + */ +struct GNUNET_RPS_StreamRequestHandle * +GNUNET_RPS_stream_request (struct GNUNET_RPS_Handle *rps_handle, + GNUNET_RPS_NotifyReadyCB stream_input_cb, + void *cls); + + +/** + * @brief Cancel a specific request for updates from the biased peer stream + * + * @param srh The request handle to cancel + */ +void +GNUNET_RPS_stream_cancel (struct GNUNET_RPS_StreamRequestHandle *srh); + /** * Disconnect from the rps service