aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_set_service.h
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2013-11-19 19:47:44 +0000
committerChristian Grothoff <christian@grothoff.org>2013-11-19 19:47:44 +0000
commit5ccd7acfa1ed8157feda8ff53dff7d2772f3d1ed (patch)
tree2f1745246adb076b9c17b456d304ff1bbaf010e3 /src/include/gnunet_set_service.h
parentf93a17240ae3e809ff6ef84af917c600306df3ff (diff)
downloadgnunet-5ccd7acfa1ed8157feda8ff53dff7d2772f3d1ed.tar.gz
gnunet-5ccd7acfa1ed8157feda8ff53dff7d2772f3d1ed.zip
-doxygen
Diffstat (limited to 'src/include/gnunet_set_service.h')
-rw-r--r--src/include/gnunet_set_service.h26
1 files changed, 13 insertions, 13 deletions
diff --git a/src/include/gnunet_set_service.h b/src/include/gnunet_set_service.h
index 920424b80..b088e335f 100644
--- a/src/include/gnunet_set_service.h
+++ b/src/include/gnunet_set_service.h
@@ -181,8 +181,8 @@ typedef void (*GNUNET_SET_Continuation) (void *cls);
181 * in the result set. 181 * in the result set.
182 * 182 *
183 * @param cls closure 183 * @param cls closure
184 * @param element a result element, only valid if status is GNUNET_SET_STATUS_OK 184 * @param element a result element, only valid if status is #GNUNET_SET_STATUS_OK
185 * @param status see enum GNUNET_SET_Status 185 * @param status see `enum GNUNET_SET_Status`
186 */ 186 */
187typedef void (*GNUNET_SET_ResultIterator) (void *cls, 187typedef void (*GNUNET_SET_ResultIterator) (void *cls,
188 const struct GNUNET_SET_Element *element, 188 const struct GNUNET_SET_Element *element,
@@ -194,7 +194,7 @@ typedef void (*GNUNET_SET_ResultIterator) (void *cls,
194 * @param cls closure 194 * @param cls closure
195 * @param element the current element, NULL if all elements have been 195 * @param element the current element, NULL if all elements have been
196 * iterated over 196 * iterated over
197 * @return GNUNET_YES to continue iterating, GNUNET_NO to stop. 197 * @return #GNUNET_YES to continue iterating, #GNUNET_NO to stop.
198 */ 198 */
199typedef int (*GNUNET_SET_ElementIterator) (void *cls, 199typedef int (*GNUNET_SET_ElementIterator) (void *cls,
200 const struct GNUNET_SET_Element *element); 200 const struct GNUNET_SET_Element *element);
@@ -202,13 +202,13 @@ typedef int (*GNUNET_SET_ElementIterator) (void *cls,
202 202
203/** 203/**
204 * Called when another peer wants to do a set operation with the 204 * Called when another peer wants to do a set operation with the
205 * local peer. If a listen error occurs, the 'request' is NULL. 205 * local peer. If a listen error occurs, the @a request is NULL.
206 * 206 *
207 * @param cls closure 207 * @param cls closure
208 * @param other_peer the other peer 208 * @param other_peer the other peer
209 * @param context_msg message with application specific information from 209 * @param context_msg message with application specific information from
210 * the other peer 210 * the other peer
211 * @param request request from the other peer (never NULL), use GNUNET_SET_accept 211 * @param request request from the other peer (never NULL), use GNUNET_SET_accept()
212 * to accept it, otherwise the request will be refused 212 * to accept it, otherwise the request will be refused
213 * Note that we can't just return value from the listen callback, 213 * Note that we can't just return value from the listen callback,
214 * as it is also necessary to specify the set we want to do the 214 * as it is also necessary to specify the set we want to do the
@@ -289,7 +289,7 @@ GNUNET_SET_destroy (struct GNUNET_SET_Handle *set);
289/** 289/**
290 * Prepare a set operation to be evaluated with another peer. 290 * Prepare a set operation to be evaluated with another peer.
291 * The evaluation will not start until the client provides 291 * The evaluation will not start until the client provides
292 * a local set with GNUNET_SET_commit. 292 * a local set with GNUNET_SET_commit().
293 * 293 *
294 * @param other_peer peer with the other set 294 * @param other_peer peer with the other set
295 * @param app_id hash for the application using the set 295 * @param app_id hash for the application using the set
@@ -298,7 +298,7 @@ GNUNET_SET_destroy (struct GNUNET_SET_Handle *set);
298 * fail due to hash collisions, using a different salt for each operation 298 * fail due to hash collisions, using a different salt for each operation
299 * makes it harder for an attacker to exploit this 299 * makes it harder for an attacker to exploit this
300 * @param result_mode specified how results will be returned, 300 * @param result_mode specified how results will be returned,
301 * see 'GNUNET_SET_ResultMode'. 301 * see `enum GNUNET_SET_ResultMode`.
302 * @param result_cb called on error or success 302 * @param result_cb called on error or success
303 * @param result_cls closure for @a result_cb 303 * @param result_cls closure for @a result_cb
304 * @return a handle to cancel the operation 304 * @return a handle to cancel the operation
@@ -347,17 +347,17 @@ GNUNET_SET_listen_cancel (struct GNUNET_SET_ListenHandle *lh);
347 347
348 348
349/** 349/**
350 * Accept a request we got via GNUNET_SET_listen. Must be called during 350 * Accept a request we got via GNUNET_SET_listen(). Must be called during
351 * GNUNET_SET_listen, as the 'struct GNUNET_SET_Request' becomes invalid 351 * GNUNET_SET_listen(), as the `struct GNUNET_SET_Request` becomes invalid
352 * afterwards. 352 * afterwards.
353 * Call GNUNET_SET_commit to provide the local set to use for the operation, 353 * Call GNUNET_SET_commit() to provide the local set to use for the operation,
354 * and to begin the exchange with the remote peer. 354 * and to begin the exchange with the remote peer.
355 * 355 *
356 * @param request request to accept 356 * @param request request to accept
357 * @param result_mode specified how results will be returned, 357 * @param result_mode specified how results will be returned,
358 * see 'GNUNET_SET_ResultMode'. 358 * see `enum GNUNET_SET_ResultMode`.
359 * @param result_cb callback for the results 359 * @param result_cb callback for the results
360 * @param result_cls closure for result_cb 360 * @param result_cls closure for @a result_cb
361 * @return a handle to cancel the operation 361 * @return a handle to cancel the operation
362 */ 362 */
363struct GNUNET_SET_OperationHandle * 363struct GNUNET_SET_OperationHandle *
@@ -377,7 +377,7 @@ GNUNET_SET_accept (struct GNUNET_SET_Request *request,
377 * 377 *
378 * @param oh handle to the set operation 378 * @param oh handle to the set operation
379 * @param set the set to use for the operation 379 * @param set the set to use for the operation
380 * @return GNUNET_OK on success, GNUNET_SYSERR if the 380 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
381 * set is invalid (e.g. the set service crashed) 381 * set is invalid (e.g. the set service crashed)
382 */ 382 */
383int 383int