aboutsummaryrefslogtreecommitdiff
path: root/src/include
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2014-11-30 00:21:56 +0000
committerChristian Grothoff <christian@grothoff.org>2014-11-30 00:21:56 +0000
commit7dc458f1c96853831b607c61572270d62efd86d2 (patch)
treebd6eb0244d155080fac1198f9455c184fd5df301 /src/include
parentbeccfee0add2579a9beb65af41ac266f04635f3c (diff)
downloadgnunet-7dc458f1c96853831b607c61572270d62efd86d2.tar.gz
gnunet-7dc458f1c96853831b607c61572270d62efd86d2.zip
-doxygen, style
Diffstat (limited to 'src/include')
-rw-r--r--src/include/gnunet_container_lib.h54
1 files changed, 30 insertions, 24 deletions
diff --git a/src/include/gnunet_container_lib.h b/src/include/gnunet_container_lib.h
index d377bb016..68e62c750 100644
--- a/src/include/gnunet_container_lib.h
+++ b/src/include/gnunet_container_lib.h
@@ -59,6 +59,7 @@ extern "C"
59 */ 59 */
60struct GNUNET_CONTAINER_BloomFilter; 60struct GNUNET_CONTAINER_BloomFilter;
61 61
62
62/** 63/**
63 * @ingroup bloomfilter 64 * @ingroup bloomfilter
64 * Iterator over `struct GNUNET_HashCode`. 65 * Iterator over `struct GNUNET_HashCode`.
@@ -68,8 +69,9 @@ struct GNUNET_CONTAINER_BloomFilter;
68 * @return #GNUNET_YES if next was updated 69 * @return #GNUNET_YES if next was updated
69 * #GNUNET_NO if there are no more entries 70 * #GNUNET_NO if there are no more entries
70 */ 71 */
71typedef int (*GNUNET_CONTAINER_HashCodeIterator) (void *cls, 72typedef int
72 struct GNUNET_HashCode *next); 73(*GNUNET_CONTAINER_HashCodeIterator) (void *cls,
74 struct GNUNET_HashCode *next);
73 75
74 76
75/** 77/**
@@ -121,7 +123,8 @@ GNUNET_CONTAINER_bloomfilter_init (const char *data,
121 */ 123 */
122int 124int
123GNUNET_CONTAINER_bloomfilter_get_raw_data (const struct GNUNET_CONTAINER_BloomFilter *bf, 125GNUNET_CONTAINER_bloomfilter_get_raw_data (const struct GNUNET_CONTAINER_BloomFilter *bf,
124 char *data, size_t size); 126 char *data,
127 size_t size);
125 128
126 129
127/** 130/**
@@ -194,6 +197,7 @@ GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter *bf);
194size_t 197size_t
195GNUNET_CONTAINER_bloomfilter_get_element_addresses (const struct GNUNET_CONTAINER_BloomFilter *bf); 198GNUNET_CONTAINER_bloomfilter_get_element_addresses (const struct GNUNET_CONTAINER_BloomFilter *bf);
196 199
200
197/** 201/**
198 * @ingroup bloomfilter 202 * @ingroup bloomfilter
199 * Get size of the bloom filter. 203 * Get size of the bloom filter.
@@ -246,6 +250,7 @@ int
246GNUNET_CONTAINER_bloomfilter_or2 (struct GNUNET_CONTAINER_BloomFilter *bf, 250GNUNET_CONTAINER_bloomfilter_or2 (struct GNUNET_CONTAINER_BloomFilter *bf,
247 const struct GNUNET_CONTAINER_BloomFilter *to_or); 251 const struct GNUNET_CONTAINER_BloomFilter *to_or);
248 252
253
249/** 254/**
250 * @ingroup bloomfilter 255 * @ingroup bloomfilter
251 * Resize a bloom filter. Note that this operation 256 * Resize a bloom filter. Note that this operation
@@ -261,7 +266,8 @@ GNUNET_CONTAINER_bloomfilter_or2 (struct GNUNET_CONTAINER_BloomFilter *bf,
261void 266void
262GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter *bf, 267GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter *bf,
263 GNUNET_CONTAINER_HashCodeIterator iterator, 268 GNUNET_CONTAINER_HashCodeIterator iterator,
264 void *iterator_cls, size_t size, 269 void *iterator_cls,
270 size_t size,
265 unsigned int k); 271 unsigned int k);
266 272
267 273
@@ -273,6 +279,7 @@ GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter *bf,
273 */ 279 */
274struct GNUNET_CONTAINER_MetaData; 280struct GNUNET_CONTAINER_MetaData;
275 281
282
276/** 283/**
277 * @ingroup metadata 284 * @ingroup metadata
278 * Create a fresh meta data container. 285 * Create a fresh meta data container.
@@ -291,8 +298,8 @@ GNUNET_CONTAINER_meta_data_create (void);
291 * @return duplicate meta-data container 298 * @return duplicate meta-data container
292 */ 299 */
293struct GNUNET_CONTAINER_MetaData * 300struct GNUNET_CONTAINER_MetaData *
294GNUNET_CONTAINER_meta_data_duplicate (const struct GNUNET_CONTAINER_MetaData 301GNUNET_CONTAINER_meta_data_duplicate (const struct GNUNET_CONTAINER_MetaData *md);
295 *md); 302
296 303
297/** 304/**
298 * @ingroup metadata 305 * @ingroup metadata
@@ -343,7 +350,8 @@ GNUNET_CONTAINER_meta_data_insert (struct GNUNET_CONTAINER_MetaData *md,
343 const char *plugin_name, 350 const char *plugin_name,
344 enum EXTRACTOR_MetaType type, 351 enum EXTRACTOR_MetaType type,
345 enum EXTRACTOR_MetaFormat format, 352 enum EXTRACTOR_MetaFormat format,
346 const char *data_mime_type, const char *data, 353 const char *data_mime_type,
354 const char *data,
347 size_t data_size); 355 size_t data_size);
348 356
349 357
@@ -374,7 +382,8 @@ GNUNET_CONTAINER_meta_data_merge (struct GNUNET_CONTAINER_MetaData *md,
374int 382int
375GNUNET_CONTAINER_meta_data_delete (struct GNUNET_CONTAINER_MetaData *md, 383GNUNET_CONTAINER_meta_data_delete (struct GNUNET_CONTAINER_MetaData *md,
376 enum EXTRACTOR_MetaType type, 384 enum EXTRACTOR_MetaType type,
377 const char *data, size_t data_size); 385 const char *data,
386 size_t data_size);
378 387
379 388
380/** 389/**
@@ -395,8 +404,7 @@ GNUNET_CONTAINER_meta_data_clear (struct GNUNET_CONTAINER_MetaData *md);
395 * @param md metadata to modify 404 * @param md metadata to modify
396 */ 405 */
397void 406void
398GNUNET_CONTAINER_meta_data_add_publication_date (struct 407GNUNET_CONTAINER_meta_data_add_publication_date (struct GNUNET_CONTAINER_MetaData *md);
399 GNUNET_CONTAINER_MetaData *md);
400 408
401 409
402/** 410/**
@@ -427,8 +435,8 @@ GNUNET_CONTAINER_meta_data_iterate (const struct GNUNET_CONTAINER_MetaData *md,
427 * @return NULL if no entry was found 435 * @return NULL if no entry was found
428 */ 436 */
429char * 437char *
430GNUNET_CONTAINER_meta_data_get_by_type (const struct GNUNET_CONTAINER_MetaData 438GNUNET_CONTAINER_meta_data_get_by_type (const struct GNUNET_CONTAINER_MetaData *md,
431 *md, enum EXTRACTOR_MetaType type); 439 enum EXTRACTOR_MetaType type);
432 440
433 441
434/** 442/**
@@ -444,8 +452,7 @@ GNUNET_CONTAINER_meta_data_get_by_type (const struct GNUNET_CONTAINER_MetaData
444 * otherwise client is responsible for freeing the value! 452 * otherwise client is responsible for freeing the value!
445 */ 453 */
446char * 454char *
447GNUNET_CONTAINER_meta_data_get_first_by_types (const struct 455GNUNET_CONTAINER_meta_data_get_first_by_types (const struct GNUNET_CONTAINER_MetaData *md,
448 GNUNET_CONTAINER_MetaData *md,
449 ...); 456 ...);
450 457
451/** 458/**
@@ -459,8 +466,8 @@ GNUNET_CONTAINER_meta_data_get_first_by_types (const struct
459 * @return number of bytes in thumbnail, 0 if not available 466 * @return number of bytes in thumbnail, 0 if not available
460 */ 467 */
461size_t 468size_t
462GNUNET_CONTAINER_meta_data_get_thumbnail (const struct GNUNET_CONTAINER_MetaData 469GNUNET_CONTAINER_meta_data_get_thumbnail (const struct GNUNET_CONTAINER_MetaData *md,
463 *md, unsigned char **thumb); 470 unsigned char **thumb);
464 471
465 472
466 473
@@ -507,11 +514,10 @@ enum GNUNET_CONTAINER_MetaDataSerializationOptions
507 * space) 514 * space)
508 */ 515 */
509ssize_t 516ssize_t
510GNUNET_CONTAINER_meta_data_serialize (const struct GNUNET_CONTAINER_MetaData 517GNUNET_CONTAINER_meta_data_serialize (const struct GNUNET_CONTAINER_MetaData *md,
511 *md, char **target, size_t max, 518 char **target,
512 enum 519 size_t max,
513 GNUNET_CONTAINER_MetaDataSerializationOptions 520 enum GNUNET_CONTAINER_MetaDataSerializationOptions opt);
514 opt);
515 521
516 522
517/** 523/**
@@ -522,8 +528,7 @@ GNUNET_CONTAINER_meta_data_serialize (const struct GNUNET_CONTAINER_MetaData
522 * @return number of bytes needed for serialization, -1 on error 528 * @return number of bytes needed for serialization, -1 on error
523 */ 529 */
524ssize_t 530ssize_t
525GNUNET_CONTAINER_meta_data_get_serialized_size (const struct 531GNUNET_CONTAINER_meta_data_get_serialized_size (const struct GNUNET_CONTAINER_MetaData *md);
526 GNUNET_CONTAINER_MetaData *md);
527 532
528 533
529/** 534/**
@@ -536,7 +541,8 @@ GNUNET_CONTAINER_meta_data_get_serialized_size (const struct
536 * bad format) 541 * bad format)
537 */ 542 */
538struct GNUNET_CONTAINER_MetaData * 543struct GNUNET_CONTAINER_MetaData *
539GNUNET_CONTAINER_meta_data_deserialize (const char *input, size_t size); 544GNUNET_CONTAINER_meta_data_deserialize (const char *input,
545 size_t size);
540 546
541 547
542/* ******************************* HashMap **************************** */ 548/* ******************************* HashMap **************************** */