aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_identity_service.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/gnunet_identity_service.h')
-rw-r--r--src/include/gnunet_identity_service.h32
1 files changed, 16 insertions, 16 deletions
diff --git a/src/include/gnunet_identity_service.h b/src/include/gnunet_identity_service.h
index 6c572e737..79d27fa02 100644
--- a/src/include/gnunet_identity_service.h
+++ b/src/include/gnunet_identity_service.h
@@ -18,7 +18,7 @@
18 Boston, MA 02111-1307, USA. 18 Boston, MA 02111-1307, USA.
19*/ 19*/
20 20
21/** 21/**
22 * @file include/gnunet_identity_service.h 22 * @file include/gnunet_identity_service.h
23 * @brief Identity service; implements identity management for GNUnet 23 * @brief Identity service; implements identity management for GNUnet
24 * @author Christian Grothoff 24 * @author Christian Grothoff
@@ -49,22 +49,22 @@ extern "C"
49#include "gnunet_util_lib.h" 49#include "gnunet_util_lib.h"
50 50
51 51
52/** 52/**
53 * Version number of GNUnet Identity API. 53 * Version number of GNUnet Identity API.
54 */ 54 */
55#define GNUNET_IDENTITY_VERSION 0x00000000 55#define GNUNET_IDENTITY_VERSION 0x00000000
56 56
57/** 57/**
58 * Handle to access the identity service. 58 * Handle to access the identity service.
59 */ 59 */
60struct GNUNET_IDENTITY_Handle; 60struct GNUNET_IDENTITY_Handle;
61 61
62/** 62/**
63 * Handle for a ego. 63 * Handle for a ego.
64 */ 64 */
65struct GNUNET_IDENTITY_Ego; 65struct GNUNET_IDENTITY_Ego;
66 66
67/** 67/**
68 * Handle for an operation with the identity service. 68 * Handle for an operation with the identity service.
69 */ 69 */
70struct GNUNET_IDENTITY_Operation; 70struct GNUNET_IDENTITY_Operation;
@@ -100,9 +100,9 @@ GNUNET_IDENTITY_ego_get_public_key (const struct GNUNET_IDENTITY_Ego *ego,
100 struct GNUNET_CRYPTO_EccPublicSignKey *pk); 100 struct GNUNET_CRYPTO_EccPublicSignKey *pk);
101 101
102 102
103/** 103/**
104 * Method called to inform about the egos of 104 * Method called to inform about the egos of
105 * this peer. 105 * this peer.
106 * 106 *
107 * When used with #GNUNET_IDENTITY_connect, this function is 107 * When used with #GNUNET_IDENTITY_connect, this function is
108 * initially called for all egos and then again whenever a 108 * initially called for all egos and then again whenever a
@@ -116,11 +116,11 @@ GNUNET_IDENTITY_ego_get_public_key (const struct GNUNET_IDENTITY_Ego *ego,
116 * @a ego does indicate an error (i.e. name is taken or no default 116 * @a ego does indicate an error (i.e. name is taken or no default
117 * value is known). If @a ego is non-NULL and if '*ctx' 117 * value is known). If @a ego is non-NULL and if '*ctx'
118 * is set in those callbacks, the value WILL be passed to a subsequent 118 * is set in those callbacks, the value WILL be passed to a subsequent
119 * call to the identity callback of #GNUNET_IDENTITY_connect (if 119 * call to the identity callback of #GNUNET_IDENTITY_connect (if
120 * that one was not NULL). 120 * that one was not NULL).
121 * 121 *
122 * When an identity is renamed, this function is called with the 122 * When an identity is renamed, this function is called with the
123 * (known) @a ego but the NEW @a name. 123 * (known) @a ego but the NEW @a name.
124 * 124 *
125 * When an identity is deleted, this function is called with the 125 * When an identity is deleted, this function is called with the
126 * (known) ego and "NULL" for the @a name. In this case, 126 * (known) ego and "NULL" for the @a name. In this case,
@@ -141,7 +141,7 @@ typedef void (*GNUNET_IDENTITY_Callback)(void *cls,
141 const char *name); 141 const char *name);
142 142
143 143
144/** 144/**
145 * Connect to the identity service. 145 * Connect to the identity service.
146 * 146 *
147 * @param cfg Configuration to contact the identity service. 147 * @param cfg Configuration to contact the identity service.
@@ -205,12 +205,12 @@ GNUNET_IDENTITY_set (struct GNUNET_IDENTITY_Handle *id,
205 * Disconnect from identity service. 205 * Disconnect from identity service.
206 * 206 *
207 * @param h identity service to disconnect 207 * @param h identity service to disconnect
208 */ 208 */
209void 209void
210GNUNET_IDENTITY_disconnect (struct GNUNET_IDENTITY_Handle *h); 210GNUNET_IDENTITY_disconnect (struct GNUNET_IDENTITY_Handle *h);
211 211
212 212
213/** 213/**
214 * Create a new identity with the given name. 214 * Create a new identity with the given name.
215 * 215 *
216 * @param id identity service to use 216 * @param id identity service to use
@@ -226,7 +226,7 @@ GNUNET_IDENTITY_create (struct GNUNET_IDENTITY_Handle *id,
226 void *cont_cls); 226 void *cont_cls);
227 227
228 228
229/** 229/**
230 * Renames an existing identity. 230 * Renames an existing identity.
231 * 231 *
232 * @param id identity service to use 232 * @param id identity service to use
@@ -244,7 +244,7 @@ GNUNET_IDENTITY_rename (struct GNUNET_IDENTITY_Handle *id,
244 void *cb_cls); 244 void *cb_cls);
245 245
246 246
247/** 247/**
248 * Delete an existing identity. 248 * Delete an existing identity.
249 * 249 *
250 * @param id identity service to use 250 * @param id identity service to use
@@ -279,13 +279,13 @@ GNUNET_IDENTITY_cancel (struct GNUNET_IDENTITY_Operation *op);
279 * 279 *
280 * @param cls closure 280 * @param cls closure
281 * @param ego NULL on error / ego not found 281 * @param ego NULL on error / ego not found
282 */ 282 */
283typedef void (*GNUNET_IDENTITY_EgoCallback)(void *cls, 283typedef void (*GNUNET_IDENTITY_EgoCallback)(void *cls,
284 const struct GNUNET_IDENTITY_Ego *ego); 284 const struct GNUNET_IDENTITY_Ego *ego);
285 285
286/** 286/**
287 * Handle for ego lookup. 287 * Handle for ego lookup.
288 */ 288 */
289struct GNUNET_IDENTITY_EgoLookup; 289struct GNUNET_IDENTITY_EgoLookup;
290 290
291 291