123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158 |
- /*
- 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 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., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA.
- */
- /**
- * @author Julius Bünger
- *
- * @file
- * API to the rps service
- *
- * @defgroup rps RPS service
- * Random Peer Sampling
- * @{
- */
- #ifndef GNUNET_RPS_SERVICE_H
- #define GNUNET_RPS_SERVICE_H
- #ifdef __cplusplus
- extern "C"
- {
- #if 0 /* keep Emacsens' auto-indent happy */
- }
- #endif
- #endif
- /**
- * Version of the rps API.
- */
- #define GNUNET_RPS_VERSION 0x00000000
- /**
- * Handle for the random peer sampling service
- */
- struct GNUNET_RPS_Handle;
- /**
- * Handle for one request to the rps service
- */
- struct GNUNET_RPS_Request_Handle;
- /**
- * Callback called when requested random peers are available.
- *
- * @param cls the closure given with the request
- * @param num_peers the number of peers returned
- * @param peers array with num_peers PeerIDs
- */
- typedef void (* GNUNET_RPS_NotifyReadyCB) (void *cls,
- uint64_t num_peers,
- const struct GNUNET_PeerIdentity *peers);
- /**
- * Connect to the rps service
- *
- * @param cfg configuration to use
- * @return handle to the rps service
- */
- struct GNUNET_RPS_Handle *
- GNUNET_RPS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
- /**
- * Request n random peers.
- *
- * This does exacly the same as GNUNET_RPS_request_peers_single_call
- * but needs a GNUNET_RPS_Handle.
- * This exists only for other parts of GNUnet that expect having to
- * (dis)connect from/to a service.
- *
- * @param h handle to the rps service
- * @param n number of random peers to return
- * @param ready_cb the callback to be called when the peers are available
- * @param cls a closure that will be given to the callback
- * @return handle to this request
- */
- struct GNUNET_RPS_Request_Handle *
- GNUNET_RPS_request_peers (struct GNUNET_RPS_Handle *h, uint32_t n,
- GNUNET_RPS_NotifyReadyCB ready_cb,
- void *cls);
- /**
- * Seed rps service with peerIDs.
- *
- * @param h handle to the rps service
- * @param n number of peers to seed
- * @param ids the ids of the peers seeded
- */
- void
- GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h, uint32_t n,
- const struct GNUNET_PeerIdentity * ids);
- /**
- * Cancle an issued request.
- *
- * @param rh handle of the pending request to be canceled
- */
- void
- GNUNET_RPS_request_cancel (struct GNUNET_RPS_Request_Handle *rh);
- #ifdef ENABLE_MALICIOUS
- /**
- * Turn RPS service to act malicious.
- *
- * @param h handle to the rps service
- * @param type which type of malicious peer to turn to.
- * 0 Don't act malicious at all
- * 1 Try to maximise representation
- * 2 Try to partition the network
- * (isolate one peer from the rest)
- * @param n number of @a ids
- * @param ids the ids of the malicious peers
- * if @type is 2 the last id is the id of the
- * peer to be isolated from the rest
- */
- void
- GNUNET_RPS_act_malicious (struct GNUNET_RPS_Handle *h,
- uint32_t type,
- uint32_t num_peers,
- const struct GNUNET_PeerIdentity *ids,
- const struct GNUNET_PeerIdentity *target_peer);
- #endif /* ENABLE_MALICIOUS */
- /**
- * Disconnect from the rps service
- *
- * @param h the handle to the rps service
- */
- void
- GNUNET_RPS_disconnect (struct GNUNET_RPS_Handle *h);
- #if 0 /* keep Emacsens' auto-indent happy */
- {
- #endif
- #ifdef __cplusplus
- }
- #endif
- #endif
- /** @} */ /* end of group */
|