aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_peerstore_plugin.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/gnunet_peerstore_plugin.h')
-rw-r--r--src/include/gnunet_peerstore_plugin.h24
1 files changed, 23 insertions, 1 deletions
diff --git a/src/include/gnunet_peerstore_plugin.h b/src/include/gnunet_peerstore_plugin.h
index 90190e5b5..6ecb9135a 100644
--- a/src/include/gnunet_peerstore_plugin.h
+++ b/src/include/gnunet_peerstore_plugin.h
@@ -19,6 +19,9 @@
19 */ 19 */
20 20
21/** 21/**
22 * @addtogroup Backbone
23 * @{
24 *
22 * @author Omar Tarabai 25 * @author Omar Tarabai
23 * 26 *
24 * @file 27 * @file
@@ -31,6 +34,7 @@
31#ifndef GNUNET_PEERSTORE_PLUGIN_H 34#ifndef GNUNET_PEERSTORE_PLUGIN_H
32#define GNUNET_PEERSTORE_PLUGIN_H 35#define GNUNET_PEERSTORE_PLUGIN_H
33 36
37
34#include "gnunet_util_lib.h" 38#include "gnunet_util_lib.h"
35#include "gnunet_peerstore_service.h" 39#include "gnunet_peerstore_service.h"
36 40
@@ -42,6 +46,19 @@ extern "C"
42#endif 46#endif
43#endif 47#endif
44 48
49/**
50 * Function called by PEERSTORE for each matching record.
51 *
52 * @param cls closure
53 * @param seq sequence in interation
54 * @param record peerstore record information
55 * @param emsg error message, or NULL if no errors
56 */
57typedef void (*GNUNET_PEERSTORE_PluginProcessor) (
58 void *cls,
59 uint64_t seq,
60 const struct GNUNET_PEERSTORE_Record *record,
61 const char *emsg);
45 62
46/** 63/**
47 * @brief struct returned by the initialization function of the plugin 64 * @brief struct returned by the initialization function of the plugin
@@ -89,6 +106,7 @@ struct GNUNET_PEERSTORE_PluginFunctions
89 * @param sub_system name of sub system 106 * @param sub_system name of sub system
90 * @param peer Peer identity (can be NULL) 107 * @param peer Peer identity (can be NULL)
91 * @param key entry key string (can be NULL) 108 * @param key entry key string (can be NULL)
109 * @param limit max number of results to give
92 * @param iter function to call asynchronously with the results, terminated 110 * @param iter function to call asynchronously with the results, terminated
93 * by a NULL result 111 * by a NULL result
94 * @param iter_cls closure for @a iter 112 * @param iter_cls closure for @a iter
@@ -100,7 +118,9 @@ struct GNUNET_PEERSTORE_PluginFunctions
100 const char *sub_system, 118 const char *sub_system,
101 const struct GNUNET_PeerIdentity *peer, 119 const struct GNUNET_PeerIdentity *peer,
102 const char *key, 120 const char *key,
103 GNUNET_PEERSTORE_Processor iter, 121 uint64_t serial,
122 uint64_t limit,
123 GNUNET_PEERSTORE_PluginProcessor iter,
104 void *iter_cls); 124 void *iter_cls);
105 125
106 /** 126 /**
@@ -131,3 +151,5 @@ struct GNUNET_PEERSTORE_PluginFunctions
131#endif 151#endif
132 152
133/** @} */ /* end of group */ 153/** @} */ /* end of group */
154
155/** @} */ /* end of group addition */