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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
/*
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
*/
/**
* @file rps/gnunet-service-rps_custommap.h
* @brief utilities for managing (information about) peers
* @author Julius Bünger
*/
#include "gnunet_util_lib.h"
#include <inttypes.h>
/**
* Peer map to store peers with specialised use-cases (push_list, pull_list,
* view, ...)
*
* It is aimed for use as unordered list-like structures that can be indexed.
* Main use-case:
*
* permut = GNUNET_CRYPTO_random_permute (GNUNET_CRYPTO_QUALITY_STRONG,
* CustomPeerMap_size (peer_map));
* for (i = 0; i < some_border; i++)
* some_array[i] = *CustomPeerMap_get_peer_by_index (peer_map, permut[i]);
* for (i = some_border; i < CustomPeerMap_size (peer_map); i++)
* other_array[i-some_border] =
* *CustomPeerMap_get_peer_by_index (peer_map, permut[i]);
*
* This list is expected to
* - be altered in small steps frequently
* - be cleared regularily
* - often being queried whether a peer is contained
* - alter indices of peers
* - contain continous indices 0 <= i < len
* - not contain duplicate peers
*/
struct CustomPeerMap;
/**
* Create an empty peermap.
*
* @param len the initial length for the internal maps
*
* @return the newly created custom peer map
*/
struct CustomPeerMap *
CustomPeerMap_create (unsigned int len);
/**
* Get the size of the custom peer map
*
* @param c_peer_map the custom peer map to look in
*
* @return size of the map
*/
unsigned int
CustomPeerMap_size (const struct CustomPeerMap *c_peer_map);
/**
* Insert peer into the custom peer map
*
* @param c_peer_map the custom peer map to insert peer
* @param peer the peer to insert
*
* @return GNUNET_OK if map did not contain peer previously
* GNUNET_NO if map did contain peer previously
*/
int
CustomPeerMap_put (const struct CustomPeerMap *c_peer_map,
const struct GNUNET_PeerIdentity *peer);
/**
* Check whether custom peer map contains a peer
*
* @param c_peer_map the custom peer map to look in
* @param peer the peer to check for
*
* @return GNUNET_OK if map contains peer
* GNUNET_NO otherwise
*/
int
CustomPeerMap_contains_peer (const struct CustomPeerMap *c_peer_map,
const struct GNUNET_PeerIdentity *peer);
/**
* Remove peer from custom peer map
*
* @param c_peer_map the custom peer map to remove the peer from
* @param peer the peer to remove
*
* @return GNUNET_OK if map contained peer and removed it successfully
* GNUNET_NO if map does not contain peer
*/
int
CustomPeerMap_remove_peer (const struct CustomPeerMap *c_peer_map,
const struct GNUNET_PeerIdentity *peer);
/**
* Get a peer by index
*
* @param c_peer_map the custom peer map to look in
* @param index the index of the peer to get
*
* @return peer to the corresponding index.
* if this index is not known, return NULL
*/
struct GNUNET_PeerIdentity *
CustomPeerMap_get_peer_by_index (const struct CustomPeerMap *c_peer_map,
uint32_t index);
/**
* Remove peer from custom peer map by index
*
* @param c_peer_map the custom peer map to remove the peer from
* @param index the index of the peer to remove
*
* @return GNUNET_OK if map contained peer and removed it successfully
* GNUNET_NO if map does not contain (index of) peer
*/
int
CustomPeerMap_remove_peer_by_index (const struct CustomPeerMap *c_peer_map,
uint32_t index);
/**
* Clear the custom peer map
*
* @param c_peer_map the custom peer map to look in
*
* @return size of the map
*/
void
CustomPeerMap_clear (const struct CustomPeerMap *c_peer_map);
/**
* Destroy peermap.
*
* @param c_peer_map the map to destroy
*/
void
CustomPeerMap_destroy (struct CustomPeerMap *c_peer_map);
/* end of gnunet-service-rps_custommap.h */
|
