diff options
Diffstat (limited to 'src/include/gnunet_psycstore_plugin.h')
-rw-r--r-- | src/include/gnunet_psycstore_plugin.h | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/src/include/gnunet_psycstore_plugin.h b/src/include/gnunet_psycstore_plugin.h index 5d5014fb3..8f8668043 100644 --- a/src/include/gnunet_psycstore_plugin.h +++ b/src/include/gnunet_psycstore_plugin.h | |||
@@ -49,7 +49,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
49 | */ | 49 | */ |
50 | void *cls; | 50 | void *cls; |
51 | 51 | ||
52 | /** | 52 | /** |
53 | * Store join/leave events for a PSYC channel in order to be able to answer | 53 | * Store join/leave events for a PSYC channel in order to be able to answer |
54 | * membership test queries later. | 54 | * membership test queries later. |
55 | * | 55 | * |
@@ -66,7 +66,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
66 | uint64_t effective_since, | 66 | uint64_t effective_since, |
67 | uint64_t group_generation); | 67 | uint64_t group_generation); |
68 | 68 | ||
69 | /** | 69 | /** |
70 | * Test if a member was admitted to the channel at the given message ID. | 70 | * Test if a member was admitted to the channel at the given message ID. |
71 | * | 71 | * |
72 | * @see GNUNET_PSYCSTORE_membership_test() | 72 | * @see GNUNET_PSYCSTORE_membership_test() |
@@ -80,7 +80,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
80 | const struct GNUNET_CRYPTO_EccPublicSignKey *slave_key, | 80 | const struct GNUNET_CRYPTO_EccPublicSignKey *slave_key, |
81 | uint64_t message_id); | 81 | uint64_t message_id); |
82 | 82 | ||
83 | /** | 83 | /** |
84 | * Store a message fragment sent to a channel. | 84 | * Store a message fragment sent to a channel. |
85 | * | 85 | * |
86 | * @see GNUNET_PSYCSTORE_fragment_store() | 86 | * @see GNUNET_PSYCSTORE_fragment_store() |
@@ -93,7 +93,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
93 | const struct GNUNET_MULTICAST_MessageHeader *message, | 93 | const struct GNUNET_MULTICAST_MessageHeader *message, |
94 | uint32_t psycstore_flags); | 94 | uint32_t psycstore_flags); |
95 | 95 | ||
96 | /** | 96 | /** |
97 | * Set additional flags for a given message. | 97 | * Set additional flags for a given message. |
98 | * | 98 | * |
99 | * They are OR'd with any existing flags set. | 99 | * They are OR'd with any existing flags set. |
@@ -111,7 +111,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
111 | uint64_t message_id, | 111 | uint64_t message_id, |
112 | uint64_t psycstore_flags); | 112 | uint64_t psycstore_flags); |
113 | 113 | ||
114 | /** | 114 | /** |
115 | * Retrieve a message fragment by fragment ID. | 115 | * Retrieve a message fragment by fragment ID. |
116 | * | 116 | * |
117 | * @see GNUNET_PSYCSTORE_fragment_get() | 117 | * @see GNUNET_PSYCSTORE_fragment_get() |
@@ -125,7 +125,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
125 | GNUNET_PSYCSTORE_FragmentCallback cb, | 125 | GNUNET_PSYCSTORE_FragmentCallback cb, |
126 | void *cb_cls); | 126 | void *cb_cls); |
127 | 127 | ||
128 | /** | 128 | /** |
129 | * Retrieve all fragments of a message. | 129 | * Retrieve all fragments of a message. |
130 | * | 130 | * |
131 | * @see GNUNET_PSYCSTORE_message_get() | 131 | * @see GNUNET_PSYCSTORE_message_get() |
@@ -140,7 +140,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
140 | GNUNET_PSYCSTORE_FragmentCallback cb, | 140 | GNUNET_PSYCSTORE_FragmentCallback cb, |
141 | void *cb_cls); | 141 | void *cb_cls); |
142 | 142 | ||
143 | /** | 143 | /** |
144 | * Retrieve a fragment of message specified by its message ID and fragment | 144 | * Retrieve a fragment of message specified by its message ID and fragment |
145 | * offset. | 145 | * offset. |
146 | * | 146 | * |
@@ -156,7 +156,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
156 | GNUNET_PSYCSTORE_FragmentCallback cb, | 156 | GNUNET_PSYCSTORE_FragmentCallback cb, |
157 | void *cb_cls); | 157 | void *cb_cls); |
158 | 158 | ||
159 | /** | 159 | /** |
160 | * Retrieve the max. values of message counters for a channel. | 160 | * Retrieve the max. values of message counters for a channel. |
161 | * | 161 | * |
162 | * @see GNUNET_PSYCSTORE_counters_get() | 162 | * @see GNUNET_PSYCSTORE_counters_get() |
@@ -170,7 +170,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
170 | uint64_t *max_message_id, | 170 | uint64_t *max_message_id, |
171 | uint64_t *max_group_generation); | 171 | uint64_t *max_group_generation); |
172 | 172 | ||
173 | /** | 173 | /** |
174 | * Retrieve the max. values of state counters for a channel. | 174 | * Retrieve the max. values of state counters for a channel. |
175 | * | 175 | * |
176 | * @see GNUNET_PSYCSTORE_counters_get() | 176 | * @see GNUNET_PSYCSTORE_counters_get() |
@@ -183,7 +183,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
183 | uint64_t *max_state_message_id); | 183 | uint64_t *max_state_message_id); |
184 | 184 | ||
185 | 185 | ||
186 | /** | 186 | /** |
187 | * Begin modifying current state. | 187 | * Begin modifying current state. |
188 | * | 188 | * |
189 | * @see GNUNET_PSYCSTORE_state_modify() | 189 | * @see GNUNET_PSYCSTORE_state_modify() |
@@ -195,7 +195,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
195 | const struct GNUNET_CRYPTO_EccPublicSignKey *channel_key, | 195 | const struct GNUNET_CRYPTO_EccPublicSignKey *channel_key, |
196 | uint64_t message_id, uint64_t state_delta); | 196 | uint64_t message_id, uint64_t state_delta); |
197 | 197 | ||
198 | /** | 198 | /** |
199 | * Set the current value of a state variable. | 199 | * Set the current value of a state variable. |
200 | * | 200 | * |
201 | * The state modification process is started with state_modify_begin(), | 201 | * The state modification process is started with state_modify_begin(), |
@@ -212,7 +212,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
212 | const char *name, const void *value, size_t value_size); | 212 | const char *name, const void *value, size_t value_size); |
213 | 213 | ||
214 | 214 | ||
215 | /** | 215 | /** |
216 | * End modifying current state. | 216 | * End modifying current state. |
217 | * | 217 | * |
218 | * @see GNUNET_PSYCSTORE_state_modify() | 218 | * @see GNUNET_PSYCSTORE_state_modify() |
@@ -225,7 +225,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
225 | uint64_t message_id); | 225 | uint64_t message_id); |
226 | 226 | ||
227 | 227 | ||
228 | /** | 228 | /** |
229 | * Begin synchronizing state. | 229 | * Begin synchronizing state. |
230 | * | 230 | * |
231 | * @see GNUNET_PSYCSTORE_state_sync() | 231 | * @see GNUNET_PSYCSTORE_state_sync() |
@@ -236,7 +236,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
236 | (*state_sync_begin) (void *cls, | 236 | (*state_sync_begin) (void *cls, |
237 | const struct GNUNET_CRYPTO_EccPublicSignKey *channel_key); | 237 | const struct GNUNET_CRYPTO_EccPublicSignKey *channel_key); |
238 | 238 | ||
239 | /** | 239 | /** |
240 | * Set the value of a state variable while synchronizing state. | 240 | * Set the value of a state variable while synchronizing state. |
241 | * | 241 | * |
242 | * The state synchronization process is started with state_sync_begin(), | 242 | * The state synchronization process is started with state_sync_begin(), |
@@ -253,7 +253,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
253 | const char *name, const void *value, size_t value_size); | 253 | const char *name, const void *value, size_t value_size); |
254 | 254 | ||
255 | 255 | ||
256 | /** | 256 | /** |
257 | * End synchronizing state. | 257 | * End synchronizing state. |
258 | * | 258 | * |
259 | * @see GNUNET_PSYCSTORE_state_sync() | 259 | * @see GNUNET_PSYCSTORE_state_sync() |
@@ -266,7 +266,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
266 | uint64_t message_id); | 266 | uint64_t message_id); |
267 | 267 | ||
268 | 268 | ||
269 | /** | 269 | /** |
270 | * Reset the state of a channel. | 270 | * Reset the state of a channel. |
271 | * | 271 | * |
272 | * Delete all state variables stored for the given channel. | 272 | * Delete all state variables stored for the given channel. |
@@ -289,7 +289,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
289 | const struct GNUNET_CRYPTO_EccPublicSignKey *channel_key); | 289 | const struct GNUNET_CRYPTO_EccPublicSignKey *channel_key); |
290 | 290 | ||
291 | 291 | ||
292 | /** | 292 | /** |
293 | * Retrieve a state variable by name (exact match). | 293 | * Retrieve a state variable by name (exact match). |
294 | * | 294 | * |
295 | * @return #GNUNET_OK on success, else #GNUNET_SYSERR | 295 | * @return #GNUNET_OK on success, else #GNUNET_SYSERR |
@@ -301,7 +301,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
301 | GNUNET_PSYCSTORE_StateCallback cb, | 301 | GNUNET_PSYCSTORE_StateCallback cb, |
302 | void *cb_cls); | 302 | void *cb_cls); |
303 | 303 | ||
304 | /** | 304 | /** |
305 | * Retrieve all state variables for a channel with the given prefix. | 305 | * Retrieve all state variables for a channel with the given prefix. |
306 | * | 306 | * |
307 | * @see GNUNET_PSYCSTORE_state_get_prefix() | 307 | * @see GNUNET_PSYCSTORE_state_get_prefix() |
@@ -316,7 +316,7 @@ struct GNUNET_PSYCSTORE_PluginFunctions | |||
316 | void *cb_cls); | 316 | void *cb_cls); |
317 | 317 | ||
318 | 318 | ||
319 | /** | 319 | /** |
320 | * Retrieve all signed state variables for a channel. | 320 | * Retrieve all signed state variables for a channel. |
321 | * | 321 | * |
322 | * @return #GNUNET_OK on success, else #GNUNET_SYSERR | 322 | * @return #GNUNET_OK on success, else #GNUNET_SYSERR |