diff options
author | Christian Grothoff <christian@grothoff.org> | 2013-09-05 11:37:29 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2013-09-05 11:37:29 +0000 |
commit | 8f8ed9394c1889f6b302511ac400fa4d55fb1e78 (patch) | |
tree | fd72524f30181dc079eaba3be9346026698794e0 /src/include/gnunet_datastore_plugin.h | |
parent | 3066c800a6d6b6e16d6c174519025608b6f7f250 (diff) | |
download | gnunet-8f8ed9394c1889f6b302511ac400fa4d55fb1e78.tar.gz gnunet-8f8ed9394c1889f6b302511ac400fa4d55fb1e78.zip |
-doxygen
Diffstat (limited to 'src/include/gnunet_datastore_plugin.h')
-rw-r--r-- | src/include/gnunet_datastore_plugin.h | 29 |
1 files changed, 14 insertions, 15 deletions
diff --git a/src/include/gnunet_datastore_plugin.h b/src/include/gnunet_datastore_plugin.h index 7f1e417f3..0099666d6 100644 --- a/src/include/gnunet_datastore_plugin.h +++ b/src/include/gnunet_datastore_plugin.h | |||
@@ -88,9 +88,8 @@ struct GNUNET_DATASTORE_PluginEnvironment | |||
88 | * @param anonymity anonymity-level for the content | 88 | * @param anonymity anonymity-level for the content |
89 | * @param expiration expiration time for the content | 89 | * @param expiration expiration time for the content |
90 | * @param uid unique identifier for the datum | 90 | * @param uid unique identifier for the datum |
91 | * | 91 | * @return #GNUNET_OK to keep the item |
92 | * @return GNUNET_OK to keep the item | 92 | * #GNUNET_NO to delete the item |
93 | * GNUNET_NO to delete the item | ||
94 | */ | 93 | */ |
95 | typedef int (*PluginDatumProcessor) (void *cls, const struct GNUNET_HashCode * key, | 94 | typedef int (*PluginDatumProcessor) (void *cls, const struct GNUNET_HashCode * key, |
96 | uint32_t size, const void *data, | 95 | uint32_t size, const void *data, |
@@ -116,7 +115,7 @@ typedef unsigned long long (*PluginEstimateSize) (void *cls); | |||
116 | * | 115 | * |
117 | * @param cls closure | 116 | * @param cls closure |
118 | * @param key key for the item | 117 | * @param key key for the item |
119 | * @param size number of bytes in data | 118 | * @param size number of bytes in @a data |
120 | * @param data content stored | 119 | * @param data content stored |
121 | * @param type type of the content | 120 | * @param type type of the content |
122 | * @param priority priority of the content | 121 | * @param priority priority of the content |
@@ -124,8 +123,8 @@ typedef unsigned long long (*PluginEstimateSize) (void *cls); | |||
124 | * @param replication replication-level for the content | 123 | * @param replication replication-level for the content |
125 | * @param expiration expiration time for the content | 124 | * @param expiration expiration time for the content |
126 | * @param msg set to an error message (on failure) | 125 | * @param msg set to an error message (on failure) |
127 | * @return GNUNET_OK on success, | 126 | * @return #GNUNET_OK on success, |
128 | * GNUNET_SYSERR on failure | 127 | * #GNUNET_SYSERR on failure |
129 | */ | 128 | */ |
130 | typedef int (*PluginPut) (void *cls, const struct GNUNET_HashCode * key, uint32_t size, | 129 | typedef int (*PluginPut) (void *cls, const struct GNUNET_HashCode * key, uint32_t size, |
131 | const void *data, enum GNUNET_BLOCK_Type type, | 130 | const void *data, enum GNUNET_BLOCK_Type type, |
@@ -142,8 +141,8 @@ typedef int (*PluginPut) (void *cls, const struct GNUNET_HashCode * key, uint32_ | |||
142 | * @param count how many values are stored under this key in the datastore | 141 | * @param count how many values are stored under this key in the datastore |
143 | */ | 142 | */ |
144 | typedef void (*PluginKeyProcessor) (void *cls, | 143 | typedef void (*PluginKeyProcessor) (void *cls, |
145 | const struct GNUNET_HashCode *key, | 144 | const struct GNUNET_HashCode *key, |
146 | unsigned int count); | 145 | unsigned int count); |
147 | 146 | ||
148 | 147 | ||
149 | /** | 148 | /** |
@@ -151,7 +150,7 @@ typedef void (*PluginKeyProcessor) (void *cls, | |||
151 | * | 150 | * |
152 | * @param cls closure | 151 | * @param cls closure |
153 | * @param proc function to call on each key | 152 | * @param proc function to call on each key |
154 | * @param proc_cls closure for proc | 153 | * @param proc_cls closure for @a proc |
155 | */ | 154 | */ |
156 | typedef void (*PluginGetKeys) (void *cls, | 155 | typedef void (*PluginGetKeys) (void *cls, |
157 | PluginKeyProcessor proc, void *proc_cls); | 156 | PluginKeyProcessor proc, void *proc_cls); |
@@ -175,7 +174,7 @@ typedef void (*PluginGetKeys) (void *cls, | |||
175 | * NULL for no minimum (return smallest key) | 174 | * NULL for no minimum (return smallest key) |
176 | * @param proc function to call on the matching value; | 175 | * @param proc function to call on the matching value; |
177 | * proc should be called with NULL if there is no result | 176 | * proc should be called with NULL if there is no result |
178 | * @param proc_cls closure for proc | 177 | * @param proc_cls closure for @a proc |
179 | */ | 178 | */ |
180 | typedef void (*PluginGetKey) (void *cls, uint64_t offset, | 179 | typedef void (*PluginGetKey) (void *cls, uint64_t offset, |
181 | const struct GNUNET_HashCode * key, | 180 | const struct GNUNET_HashCode * key, |
@@ -186,13 +185,13 @@ typedef void (*PluginGetKey) (void *cls, uint64_t offset, | |||
186 | 185 | ||
187 | /** | 186 | /** |
188 | * Get a random item (additional constraints may apply depending on | 187 | * Get a random item (additional constraints may apply depending on |
189 | * the specific implementation). Calls 'proc' with all values ZERO or | 188 | * the specific implementation). Calls @a proc with all values ZERO or |
190 | * NULL if no item applies, otherwise 'proc' is called once and only | 189 | * NULL if no item applies, otherwise @a proc is called once and only |
191 | * once with an item. | 190 | * once with an item. |
192 | * | 191 | * |
193 | * @param cls closure | 192 | * @param cls closure |
194 | * @param proc function to call the value (once only). | 193 | * @param proc function to call the value (once only). |
195 | * @param proc_cls closure for proc | 194 | * @param proc_cls closure for @a proc |
196 | */ | 195 | */ |
197 | typedef void (*PluginGetRandom) (void *cls, PluginDatumProcessor proc, | 196 | typedef void (*PluginGetRandom) (void *cls, PluginDatumProcessor proc, |
198 | void *proc_cls); | 197 | void *proc_cls); |
@@ -218,7 +217,7 @@ typedef void (*PluginGetRandom) (void *cls, PluginDatumProcessor proc, | |||
218 | * MAX of any existing expiration time and | 217 | * MAX of any existing expiration time and |
219 | * this value | 218 | * this value |
220 | * @param msg set to an error message (on error) | 219 | * @param msg set to an error message (on error) |
221 | * @return GNUNET_OK on success | 220 | * @return #GNUNET_OK on success |
222 | */ | 221 | */ |
223 | typedef int (*PluginUpdate) (void *cls, uint64_t uid, int delta, | 222 | typedef int (*PluginUpdate) (void *cls, uint64_t uid, int delta, |
224 | struct GNUNET_TIME_Absolute expire, char **msg); | 223 | struct GNUNET_TIME_Absolute expire, char **msg); |
@@ -234,7 +233,7 @@ typedef int (*PluginUpdate) (void *cls, uint64_t uid, int delta, | |||
234 | * @param type entries of which type should be considered? | 233 | * @param type entries of which type should be considered? |
235 | * Must not be zero (ANY). | 234 | * Must not be zero (ANY). |
236 | * @param proc function to call on the matching value | 235 | * @param proc function to call on the matching value |
237 | * @param proc_cls closure for proc | 236 | * @param proc_cls closure for @a proc |
238 | */ | 237 | */ |
239 | typedef void (*PluginGetType) (void *cls, uint64_t offset, | 238 | typedef void (*PluginGetType) (void *cls, uint64_t offset, |
240 | enum GNUNET_BLOCK_Type type, | 239 | enum GNUNET_BLOCK_Type type, |