aboutsummaryrefslogtreecommitdiff
path: root/src/include
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2014-12-14 13:15:00 +0000
committerChristian Grothoff <christian@grothoff.org>2014-12-14 13:15:00 +0000
commitf1b4a0c1eb8e41b85169204b1339a51cae9b1cbe (patch)
treead9df3f8758ac831f05581b56880565bfa1b1b0a /src/include
parentcc686b89e0e3804486f38019d3b2092c37edf963 (diff)
downloadgnunet-f1b4a0c1eb8e41b85169204b1339a51cae9b1cbe.tar.gz
gnunet-f1b4a0c1eb8e41b85169204b1339a51cae9b1cbe.zip
-do forcestart for gns; doxygen fixes
Diffstat (limited to 'src/include')
-rw-r--r--src/include/gnunet_crypto_lib.h1
-rw-r--r--src/include/gnunet_peerinfo_service.h24
2 files changed, 13 insertions, 12 deletions
diff --git a/src/include/gnunet_crypto_lib.h b/src/include/gnunet_crypto_lib.h
index 21f28370e..0023c0e52 100644
--- a/src/include/gnunet_crypto_lib.h
+++ b/src/include/gnunet_crypto_lib.h
@@ -1159,6 +1159,7 @@ int
1159GNUNET_CRYPTO_get_peer_identity (const struct GNUNET_CONFIGURATION_Handle *cfg, 1159GNUNET_CRYPTO_get_peer_identity (const struct GNUNET_CONFIGURATION_Handle *cfg,
1160 struct GNUNET_PeerIdentity *dst); 1160 struct GNUNET_PeerIdentity *dst);
1161 1161
1162
1162/** 1163/**
1163 * Compare two Peer Identities. 1164 * Compare two Peer Identities.
1164 * 1165 *
diff --git a/src/include/gnunet_peerinfo_service.h b/src/include/gnunet_peerinfo_service.h
index 767625fb4..ff8700861 100644
--- a/src/include/gnunet_peerinfo_service.h
+++ b/src/include/gnunet_peerinfo_service.h
@@ -77,8 +77,9 @@ GNUNET_PEERINFO_disconnect (struct GNUNET_PEERINFO_Handle *h);
77 * @param cls closure 77 * @param cls closure
78 * @param emsg error message, NULL on success 78 * @param emsg error message, NULL on success
79 */ 79 */
80typedef void (*GNUNET_PEERINFO_Continuation)(void *cls, 80typedef void
81 const char *emsg); 81(*GNUNET_PEERINFO_Continuation)(void *cls,
82 const char *emsg);
82 83
83 84
84/** 85/**
@@ -90,7 +91,7 @@ struct GNUNET_PEERINFO_AddContext;
90/** 91/**
91 * Add a host to the persistent list. This method operates in 92 * Add a host to the persistent list. This method operates in
92 * semi-reliable mode: if the transmission is not completed by 93 * semi-reliable mode: if the transmission is not completed by
93 * the time 'GNUNET_PEERINFO_disconnect' is called, it will be 94 * the time #GNUNET_PEERINFO_disconnect() is called, it will be
94 * aborted. Furthermore, if a second HELLO is added for the 95 * aborted. Furthermore, if a second HELLO is added for the
95 * same peer before the first one was transmitted, PEERINFO may 96 * same peer before the first one was transmitted, PEERINFO may
96 * merge the two HELLOs prior to transmission to the service. 97 * merge the two HELLOs prior to transmission to the service.
@@ -98,12 +99,12 @@ struct GNUNET_PEERINFO_AddContext;
98 * @param h handle to the peerinfo service 99 * @param h handle to the peerinfo service
99 * @param hello the verified (!) HELLO message 100 * @param hello the verified (!) HELLO message
100 * @param cont continuation to call when done, NULL is allowed 101 * @param cont continuation to call when done, NULL is allowed
101 * @param cont_cls closure for 'cont' 102 * @param cont_cls closure for @a cont
102 * @return handle to cancel add operation; all pending 103 * @return handle to cancel add operation; all pending
103 * 'add' operations will be cancelled automatically 104 * 'add' operations will be cancelled automatically
104 * on disconnect, so it is not necessary to keep this 105 * on disconnect, so it is not necessary to keep this
105 * handle (unless 'cont' is NULL and at some point 106 * handle (unless @a cont is NULL and at some point
106 * calling 'cont' must be prevented) 107 * calling @a cont must be prevented)
107 */ 108 */
108struct GNUNET_PEERINFO_AddContext * 109struct GNUNET_PEERINFO_AddContext *
109GNUNET_PEERINFO_add_peer (struct GNUNET_PEERINFO_Handle *h, 110GNUNET_PEERINFO_add_peer (struct GNUNET_PEERINFO_Handle *h,
@@ -114,7 +115,7 @@ GNUNET_PEERINFO_add_peer (struct GNUNET_PEERINFO_Handle *h,
114 115
115/** 116/**
116 * Cancel pending 'add' operation. Must only be called before 117 * Cancel pending 'add' operation. Must only be called before
117 * either 'cont' or 'GNUNET_PEERINFO_disconnect' are invoked. 118 * either 'cont' or #GNUNET_PEERINFO_disconnect() are invoked.
118 * 119 *
119 * @param ac handle for the add operation to cancel 120 * @param ac handle for the add operation to cancel
120 */ 121 */
@@ -150,8 +151,8 @@ struct GNUNET_PEERINFO_IteratorContext;
150 * with a NULL pointer. After that final invocation, the iterator 151 * with a NULL pointer. After that final invocation, the iterator
151 * context must no longer be used. 152 * context must no longer be used.
152 * 153 *
153 * Instead of calling this function with 'peer == NULL' it is often 154 * Instead of calling this function with `peer == NULL` it is often
154 * better to use 'GNUNET_PEERINFO_notify'. 155 * better to use #GNUNET_PEERINFO_notify().
155 * 156 *
156 * @param h handle to the peerinfo service 157 * @param h handle to the peerinfo service
157 * @param include_friend_only include HELLO messages for friends only 158 * @param include_friend_only include HELLO messages for friends only
@@ -169,7 +170,6 @@ GNUNET_PEERINFO_iterate (struct GNUNET_PEERINFO_Handle *h,
169 GNUNET_PEERINFO_Processor callback, void *callback_cls); 170 GNUNET_PEERINFO_Processor callback, void *callback_cls);
170 171
171 172
172
173/** 173/**
174 * Cancel an iteration over peer information. 174 * Cancel an iteration over peer information.
175 * 175 *
@@ -179,7 +179,6 @@ void
179GNUNET_PEERINFO_iterate_cancel (struct GNUNET_PEERINFO_IteratorContext *ic); 179GNUNET_PEERINFO_iterate_cancel (struct GNUNET_PEERINFO_IteratorContext *ic);
180 180
181 181
182
183/** 182/**
184 * Handle for notifications about changes to the set of known peers. 183 * Handle for notifications about changes to the set of known peers.
185 */ 184 */
@@ -204,7 +203,8 @@ struct GNUNET_PEERINFO_NotifyContext;
204struct GNUNET_PEERINFO_NotifyContext * 203struct GNUNET_PEERINFO_NotifyContext *
205GNUNET_PEERINFO_notify (const struct GNUNET_CONFIGURATION_Handle *cfg, 204GNUNET_PEERINFO_notify (const struct GNUNET_CONFIGURATION_Handle *cfg,
206 int include_friend_only, 205 int include_friend_only,
207 GNUNET_PEERINFO_Processor callback, void *callback_cls); 206 GNUNET_PEERINFO_Processor callback,
207 void *callback_cls);
208 208
209 209
210/** 210/**