diff options
author | Omar Tarabai <tarabai@devegypt.com> | 2014-07-24 12:44:24 +0000 |
---|---|---|
committer | Omar Tarabai <tarabai@devegypt.com> | 2014-07-24 12:44:24 +0000 |
commit | c057bd312c783e0a2f3783dfd888a66f490b0a30 (patch) | |
tree | ff87b7bf7189a723045d7c851d2d383b786724ec /src/peerstore/peerstore_api.c | |
parent | f2594744c121f45f3b36867b051220e7186d6f9b (diff) | |
download | gnunet-c057bd312c783e0a2f3783dfd888a66f490b0a30.tar.gz gnunet-c057bd312c783e0a2f3783dfd888a66f490b0a30.zip |
peerstore: doxygen
Diffstat (limited to 'src/peerstore/peerstore_api.c')
-rw-r--r-- | src/peerstore/peerstore_api.c | 41 |
1 files changed, 22 insertions, 19 deletions
diff --git a/src/peerstore/peerstore_api.c b/src/peerstore/peerstore_api.c index 81d287b53..3c67846e6 100644 --- a/src/peerstore/peerstore_api.c +++ b/src/peerstore/peerstore_api.c | |||
@@ -454,7 +454,8 @@ GNUNET_PEERSTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg) | |||
454 | 454 | ||
455 | /** | 455 | /** |
456 | * Disconnect from the PEERSTORE service. Any pending ITERATE and WATCH requests | 456 | * Disconnect from the PEERSTORE service. Any pending ITERATE and WATCH requests |
457 | * will be canceled. Any pending STORE requests will depend on @snyc_first flag. | 457 | * will be canceled. |
458 | * Any pending STORE requests will depend on @e snyc_first flag. | ||
458 | * | 459 | * |
459 | * @param h handle to disconnect | 460 | * @param h handle to disconnect |
460 | * @param sync_first send any pending STORE requests before disconnecting | 461 | * @param sync_first send any pending STORE requests before disconnecting |
@@ -556,22 +557,23 @@ GNUNET_PEERSTORE_store_cancel (struct GNUNET_PEERSTORE_StoreContext *sc) | |||
556 | * @param peer Peer Identity | 557 | * @param peer Peer Identity |
557 | * @param key entry key | 558 | * @param key entry key |
558 | * @param value entry value BLOB | 559 | * @param value entry value BLOB |
559 | * @param size size of 'value' | 560 | * @param size size of @e value |
560 | * @param expiry absolute time after which the entry is (possibly) deleted | 561 | * @param expiry absolute time after which the entry is (possibly) deleted |
562 | * @param options options specific to the storage operation | ||
561 | * @param cont Continuation function after the store request is sent | 563 | * @param cont Continuation function after the store request is sent |
562 | * @param cont_cls Closure for 'cont' | 564 | * @param cont_cls Closure for 'cont' |
563 | */ | 565 | */ |
564 | struct GNUNET_PEERSTORE_StoreContext * | 566 | struct GNUNET_PEERSTORE_StoreContext * |
565 | GNUNET_PEERSTORE_store (struct GNUNET_PEERSTORE_Handle *h, | 567 | GNUNET_PEERSTORE_store (struct GNUNET_PEERSTORE_Handle *h, |
566 | const char *sub_system, | 568 | const char *sub_system, |
567 | const struct GNUNET_PeerIdentity *peer, | 569 | const struct GNUNET_PeerIdentity *peer, |
568 | const char *key, | 570 | const char *key, |
569 | const void *value, | 571 | const void *value, |
570 | size_t size, | 572 | size_t size, |
571 | struct GNUNET_TIME_Absolute expiry, | 573 | struct GNUNET_TIME_Absolute expiry, |
572 | enum GNUNET_PEERSTORE_StoreOption options, | 574 | enum GNUNET_PEERSTORE_StoreOption options, |
573 | GNUNET_PEERSTORE_Continuation cont, | 575 | GNUNET_PEERSTORE_Continuation cont, |
574 | void *cont_cls) | 576 | void *cont_cls) |
575 | { | 577 | { |
576 | struct GNUNET_MQ_Envelope *ev; | 578 | struct GNUNET_MQ_Envelope *ev; |
577 | struct GNUNET_PEERSTORE_StoreContext *sc; | 579 | struct GNUNET_PEERSTORE_StoreContext *sc; |
@@ -580,13 +582,13 @@ GNUNET_PEERSTORE_store (struct GNUNET_PEERSTORE_Handle *h, | |||
580 | "Storing value (size: %lu) for subsytem `%s', peer `%s', key `%s'\n", | 582 | "Storing value (size: %lu) for subsytem `%s', peer `%s', key `%s'\n", |
581 | size, sub_system, GNUNET_i2s (peer), key); | 583 | size, sub_system, GNUNET_i2s (peer), key); |
582 | ev = PEERSTORE_create_record_mq_envelope(sub_system, | 584 | ev = PEERSTORE_create_record_mq_envelope(sub_system, |
583 | peer, | 585 | peer, |
584 | key, | 586 | key, |
585 | value, | 587 | value, |
586 | size, | 588 | size, |
587 | &expiry, | 589 | &expiry, |
588 | options, | 590 | options, |
589 | GNUNET_MESSAGE_TYPE_PEERSTORE_STORE); | 591 | GNUNET_MESSAGE_TYPE_PEERSTORE_STORE); |
590 | sc = GNUNET_new(struct GNUNET_PEERSTORE_StoreContext); | 592 | sc = GNUNET_new(struct GNUNET_PEERSTORE_StoreContext); |
591 | sc->ev = ev; | 593 | sc->ev = ev; |
592 | sc->cont = cont; | 594 | sc->cont = cont; |
@@ -681,6 +683,7 @@ static void iterate_request_sent (void *cls) | |||
681 | * Called when the iterate request is timedout | 683 | * Called when the iterate request is timedout |
682 | * | 684 | * |
683 | * @param cls a 'struct GNUNET_PEERSTORE_IterateContext *' | 685 | * @param cls a 'struct GNUNET_PEERSTORE_IterateContext *' |
686 | * @param tc Scheduler task context (unused) | ||
684 | */ | 687 | */ |
685 | static void | 688 | static void |
686 | iterate_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) | 689 | iterate_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) |
@@ -823,7 +826,7 @@ static void watch_request_sent (void *cls) | |||
823 | /** | 826 | /** |
824 | * Cancel a watch request | 827 | * Cancel a watch request |
825 | * | 828 | * |
826 | * @wc handle to the watch request | 829 | * @param wc handle to the watch request |
827 | */ | 830 | */ |
828 | void | 831 | void |
829 | GNUNET_PEERSTORE_watch_cancel(struct GNUNET_PEERSTORE_WatchContext *wc) | 832 | GNUNET_PEERSTORE_watch_cancel(struct GNUNET_PEERSTORE_WatchContext *wc) |