1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
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., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
/**
* @file include/gnunet_rps_service.h
* @brief API to the rps service
* @author Julius Bünger
*/
#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);
/**
* 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
|
