src/include/gnunet_pseudonym_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file include/gnunet_pseudonym_lib.h
  23  * @brief functions related to pseudonyms
  24  * @author Christian Grothoff
  25  */
  26
  27 #ifndef GNUNET_PSEUDONYM_LIB_H
  28 #define GNUNET_PSEUDONYM_LIB_H
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  38 #include "gnunet_common.h"
  39 #include "gnunet_configuration_lib.h"
  40 #include "gnunet_container_lib.h"
  41
  42 /**
  43  * Iterator over all known pseudonyms.
  44  *
  45  * @param rating the local rating of the pseudonym
  46  * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
  47  */
  48 typedef int (*GNUNET_PSEUDONYM_Iterator) (void *cls,
  49                                           const GNUNET_HashCode *
  50                                           pseudonym,
  51                                           const struct
  52                                           GNUNET_CONTAINER_MetaData * md,
  53                                           int rating);
  54
  55 /**
  56  * Change the ranking of a pseudonym.
  57  *
  58  * @param cfg overall configuration
  59  * @param nsid id of the pseudonym
  60  * @param delta by how much should the rating be changed?
  61  * @return new rating of the namespace
  62  */
  63 int GNUNET_PSEUDONYM_rank (const struct GNUNET_CONFIGURATION_Handle *cfg,
  64                            const GNUNET_HashCode *nsid, int delta);
  65
  66 /**
  67  * Add a pseudonym to the set of known pseudonyms.
  68  * For all pseudonym advertisements that we discover
  69  * FS should automatically call this function.
  70  *
  71  * @param cfg overall configuration
  72  * @param id the pseudonym identifier
  73  * @param meta metadata for the pseudonym
  74  */
  75 void GNUNET_PSEUDONYM_add (const struct GNUNET_CONFIGURATION_Handle *cfg,
  76                            const GNUNET_HashCode *id,
  77                            const struct GNUNET_CONTAINER_MetaData *meta);
  78
  79
  80 /**
  81  * List all known pseudonyms.
  82  */
  83 int GNUNET_PSEUDONYM_list_all (const struct GNUNET_CONFIGURATION_Handle *cfg,
  84                                GNUNET_PSEUDONYM_Iterator iterator,
  85                                void *closure);
  86
  87 /**
  88  * Register callback to be invoked whenever we discover
  89  * a new pseudonym.
  90  */
  91 int GNUNET_PSEUDONYM_discovery_callback_register (const struct
  92                                                   GNUNET_CONFIGURATION_Handle
  93                                                   *cfg,
  94                                                   GNUNET_PSEUDONYM_Iterator
  95                                                   iterator, void *closure);
  96
  97 /**
  98  * Unregister namespace discovery callback.
  99  */
 100 int
 101 GNUNET_PSEUDONYM_discovery_callback_unregister (GNUNET_PSEUDONYM_Iterator
 102                                                 iterator, void *closure);
 103
 104 /**
 105  * Return the unique, human readable name for the given pseudonym.
 106  *
 107  * @return NULL on failure (should never happen)
 108  */
 109 char *GNUNET_PSEUDONYM_id_to_name (const struct GNUNET_CONFIGURATION_Handle *cfg,
 110                                    const GNUNET_HashCode * pseudo);
 111
 112 /**
 113  * Get the pseudonym ID belonging to the given human readable name.
 114  *
 115  * @return GNUNET_OK on success
 116  */
 117 int GNUNET_PSEUDONYM_name_to_id (const struct GNUNET_CONFIGURATION_Handle *cfg,
 118                                  const char *hname, GNUNET_HashCode * psid);
 119
 120
 121 #if 0                           /* keep Emacsens' auto-indent happy */
 122 {
 123 #endif
 124 #ifdef __cplusplus
 125 }
 126 #endif
 127
 128 /* ifndef GNUNET_PSEUDONYM_LIB_H */
 129 #endif
 130 /* end of gnunet_pseudonym_lib.h */