2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
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 2, 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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_pseudonym_lib.h
23 * @brief functions related to pseudonyms
24 * @author Christian Grothoff
27 #ifndef GNUNET_PSEUDONYM_LIB_H
28 #define GNUNET_PSEUDONYM_LIB_H
33 #if 0 /* keep Emacsens' auto-indent happy */
38 #include "gnunet_common.h"
39 #include "gnunet_configuration_lib.h"
40 #include "gnunet_container_lib.h"
43 * Iterator over all known pseudonyms.
46 * @param pseudonym hash code of public key of pseudonym
47 * @param md meta data known about the pseudonym
48 * @param rating the local rating of the pseudonym
49 * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
51 typedef int (*GNUNET_PSEUDONYM_Iterator) (void *cls,
52 const GNUNET_HashCode * pseudonym,
53 const struct GNUNET_CONTAINER_MetaData
57 * Change the ranking of a pseudonym.
59 * @param cfg overall configuration
60 * @param nsid id of the pseudonym
61 * @param delta by how much should the rating be changed?
62 * @return new rating of the namespace
65 GNUNET_PSEUDONYM_rank (const struct GNUNET_CONFIGURATION_Handle *cfg,
66 const GNUNET_HashCode * nsid, int delta);
69 * Add a pseudonym to the set of known pseudonyms.
70 * For all pseudonym advertisements that we discover
71 * FS should automatically call this function.
73 * @param cfg overall configuration
74 * @param id the pseudonym identifier
75 * @param meta metadata for the pseudonym
78 GNUNET_PSEUDONYM_add (const struct GNUNET_CONFIGURATION_Handle *cfg,
79 const GNUNET_HashCode * id,
80 const struct GNUNET_CONTAINER_MetaData *meta);
84 * List all known pseudonyms.
86 * @param cfg overall configuration
87 * @param iterator function to call for each pseudonym
88 * @param closure closure for iterator
89 * @return number of pseudonyms found
92 GNUNET_PSEUDONYM_list_all (const struct GNUNET_CONFIGURATION_Handle *cfg,
93 GNUNET_PSEUDONYM_Iterator iterator, void *closure);
96 * Register callback to be invoked whenever we discover
100 GNUNET_PSEUDONYM_discovery_callback_register (const struct
101 GNUNET_CONFIGURATION_Handle *cfg,
102 GNUNET_PSEUDONYM_Iterator
103 iterator, void *closure);
106 * Unregister namespace discovery callback.
109 GNUNET_PSEUDONYM_discovery_callback_unregister (GNUNET_PSEUDONYM_Iterator
110 iterator, void *closure);
113 * Return the unique, human readable name for the given pseudonym.
115 * @return NULL on failure (should never happen)
118 GNUNET_PSEUDONYM_id_to_name (const struct GNUNET_CONFIGURATION_Handle *cfg,
119 const GNUNET_HashCode * pseudo);
122 * Get the pseudonym ID belonging to the given human readable name.
124 * @return GNUNET_OK on success
127 GNUNET_PSEUDONYM_name_to_id (const struct GNUNET_CONFIGURATION_Handle *cfg,
128 const char *hname, GNUNET_HashCode * psid);
131 #if 0 /* keep Emacsens' auto-indent happy */
138 /* ifndef GNUNET_PSEUDONYM_LIB_H */
140 /* end of gnunet_pseudonym_lib.h */