for w32 port
[oweals/gnunet.git] / src / include / gnunet_pseudonym_lib.h
index ced9bf387ddfe7f982f959bf50196da713f8e86f..db06d33eedce9c1c4bf2f884bf32cab0980d865c 100644 (file)
@@ -42,6 +42,9 @@ extern "C"
 /**
  * Iterator over all known pseudonyms.
  *
+ * @param cls closure
+ * @param pseudonym hash code of public key of pseudonym
+ * @param md meta data known about the pseudonym
  * @param rating the local rating of the pseudonym
  * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
  */
@@ -55,25 +58,35 @@ typedef int (*GNUNET_PSEUDONYM_Iterator) (void *cls,
 /**
  * Change the ranking of a pseudonym.
  *
- * @param pseudonym id of the pseudonym
+ * @param cfg overall configuration
+ * @param nsid id of the pseudonym
  * @param delta by how much should the rating be changed?
  * @return new rating of the namespace
  */
 int GNUNET_PSEUDONYM_rank (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                           const GNUNET_HashCode * pseudonym, int delta);
+                           const GNUNET_HashCode *nsid, int delta);
 
 /**
  * Add a pseudonym to the set of known pseudonyms.
+ * For all pseudonym advertisements that we discover
+ * FS should automatically call this function.
  *
- * @param pseudonym the pseudonym's identifier
+ * @param cfg overall configuration
+ * @param id the pseudonym identifier
+ * @param meta metadata for the pseudonym
  */
 void GNUNET_PSEUDONYM_add (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                           const GNUNET_HashCode * pseudo,
+                           const GNUNET_HashCode *id,
                            const struct GNUNET_CONTAINER_MetaData *meta);
 
 
 /**
  * List all known pseudonyms.
+ *
+ * @param cfg overall configuration 
+ * @param iterator function to call for each pseudonym
+ * @param closure closure for iterator
+ * @return number of pseudonyms found
  */
 int GNUNET_PSEUDONYM_list_all (const struct GNUNET_CONFIGURATION_Handle *cfg,
                                GNUNET_PSEUDONYM_Iterator iterator,