2 This file is part of GNUnet.
3 Copyright (C) 2006, 2009 GNUnet e.V.
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.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @author Christian Grothoff
25 * Helper library for interning of peer identifiers
27 * @defgroup peer Peer library
28 * Helper library for interning of peer identifiers
32 #ifndef GNUNET_PEER_LIB_H
33 #define GNUNET_PEER_LIB_H
35 #include "gnunet_util_lib.h"
40 #if 0 /* keep Emacsens' auto-indent happy */
46 * A GNUNET_PEER_Id is simply a shorter version of a "struct
47 * GNUNET_PeerIdentifier" that can be used inside of a GNUnet peer to
48 * save memory when the same identifier needs to be used over and over
51 typedef unsigned int GNUNET_PEER_Id;
55 * Search for a peer identity. The reference counter is not changed.
57 * @param pid identity to find
58 * @return the interned identity or 0.
61 GNUNET_PEER_search (const struct GNUNET_PeerIdentity *pid);
65 * Intern an peer identity. If the identity is already known, its
66 * reference counter will be increased by one.
68 * @param pid identity to intern
69 * @return the interned identity.
72 GNUNET_PEER_intern (const struct GNUNET_PeerIdentity *pid);
76 * Change the reference counter of an interned PID.
78 * @param id identity to change the RC of
79 * @param delta how much to change the RC
82 GNUNET_PEER_change_rc (GNUNET_PEER_Id id, int delta);
86 * Decrement multiple RCs of peer identities by one.
88 * @param ids array of PIDs to decrement the RCs of
89 * @param count size of the @a ids array
92 GNUNET_PEER_decrement_rcs (const GNUNET_PEER_Id *ids,
97 * Convert an interned PID to a normal peer identity.
99 * @param id interned PID to convert
100 * @param pid where to write the normal peer identity
103 GNUNET_PEER_resolve (GNUNET_PEER_Id id,
104 struct GNUNET_PeerIdentity *pid);
108 * Convert an interned PID to a normal peer identity.
110 * @param id interned PID to convert
111 * @return pointer to peer identity, valid as long @a id is valid
113 const struct GNUNET_PeerIdentity *
114 GNUNET_PEER_resolve2 (GNUNET_PEER_Id id);
117 #if 0 /* keep Emacsens' auto-indent happy */
124 /* ifndef GNUNET_PEER_LIB_H */
127 /** @} */ /* end of group */
129 /* end of gnunet_peer_lib.h */