2 This file is part of GNUnet.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
17 * @file rps/gnunet-service-rps_view.h
18 * @brief wrapper around the "local view"
19 * @author Julius Bünger
21 #include "gnunet_util_lib.h"
26 * Create an empty view.
28 * @param len the maximum length for the view
31 View_create (unsigned int len);
34 * Change length of view
36 * If size is decreased, peers with higher indices are removed.
38 * @param len the (maximum) length for the view
41 View_change_len (unsigned int len);
44 * Get the view as an array
46 * @return the view in array representation
48 const struct GNUNET_PeerIdentity *
52 * Get the size of the view
54 * @return current number of actually contained peers
60 * Insert peer into the view
62 * @param peer the peer to insert
64 * @return GNUNET_OK if peer was actually inserted
65 * GNUNET_NO if peer was not inserted
68 View_put (const struct GNUNET_PeerIdentity *peer);
71 * Check whether view contains a peer
73 * @param peer the peer to check for
75 * @return GNUNET_OK if view contains peer
79 View_contains_peer (const struct GNUNET_PeerIdentity *peer);
82 * Remove peer from view
84 * @param peer the peer to remove
86 * @return GNUNET_OK if view contained peer and removed it successfully
87 * GNUNET_NO if view does not contain peer
90 View_remove_peer (const struct GNUNET_PeerIdentity *peer);
95 * @param index the index of the peer to get
97 * @return peer to the corresponding index.
98 * NULL if this index is not known
100 const struct GNUNET_PeerIdentity *
101 View_get_peer_by_index (uint32_t index);
104 * Clear the custom peer map
106 * @param c_peer_map the custom peer map to look in
108 * @return size of the map
116 * @param c_peer_map the map to destroy
121 /* end of gnunet-service-rps_view.h */