2 This file is part of GNUnet.
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file rps/gnunet-service-rps_view.h
23 * @brief wrapper around the "local view"
24 * @author Julius Bünger
26 #include "gnunet_util_lib.h"
31 * Create an empty view.
33 * @param len the maximum length for the view
36 View_create (unsigned int len);
39 * Change length of view
41 * If size is decreased, peers with higher indices are removed.
43 * @param len the (maximum) length for the view
46 View_change_len (unsigned int len);
49 * Get the view as an array
51 * @return the view in array representation
53 const struct GNUNET_PeerIdentity *
57 * Get the size of the view
59 * @return current number of actually contained peers
65 * Insert peer into the view
67 * @param peer the peer to insert
69 * @return GNUNET_OK if peer was actually inserted
70 * GNUNET_NO if peer was not inserted
73 View_put (const struct GNUNET_PeerIdentity *peer);
76 * Check whether view contains a peer
78 * @param peer the peer to check for
80 * @return GNUNET_OK if view contains peer
84 View_contains_peer (const struct GNUNET_PeerIdentity *peer);
87 * Remove peer from view
89 * @param peer the peer to remove
91 * @return GNUNET_OK if view contained peer and removed it successfully
92 * GNUNET_NO if view does not contain peer
95 View_remove_peer (const struct GNUNET_PeerIdentity *peer);
100 * @param index the index of the peer to get
102 * @return peer to the corresponding index.
103 * NULL if this index is not known
105 const struct GNUNET_PeerIdentity *
106 View_get_peer_by_index (uint32_t index);
109 * Clear the custom peer map
111 * @param c_peer_map the custom peer map to look in
113 * @return size of the map
121 * @param c_peer_map the map to destroy
126 /* end of gnunet-service-rps_view.h */