2 This file is part of GNUnet.
3 (C) 2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_psycstore_service.h
23 * @brief PSYCstore service; implements persistent storage for the PSYC service
24 * @author Gabor X Toth
25 * @author Christian Grothoff
27 #ifndef GNUNET_PSYCSTORE_SERVICE_H
28 #define GNUNET_PSYCSTORE_SERVICE_H
33 #if 0 /* keep Emacsens' auto-indent happy */
38 #include "gnunet_util_lib.h"
39 #include "gnunet_env_lib.h"
40 #include "gnunet_multicast_service.h"
41 #include "gnunet_psyc_service.h"
44 * Version number of GNUnet PSYCstore API.
46 #define GNUNET_PSYCSTORE_VERSION 0x00000000
49 * Flags for stored messages.
51 enum GNUNET_PSYCSTORE_MessageFlags
54 * The message contains state modifiers.
56 GNUNET_PSYCSTORE_MESSAGE_STATE = 1 << 0,
59 * The state modifiers have been applied to the state store.
61 GNUNET_PSYCSTORE_MESSAGE_STATE_APPLIED = 1 << 1,
64 * The message contains a state hash.
66 GNUNET_PSYCSTORE_MESSAGE_STATE_HASH = 1 << 2
71 * Handle for a PSYCstore
73 struct GNUNET_PSYCSTORE_Handle;
77 * Connect to the PSYCstore service.
79 * @param cfg Configuration to use.
81 * @return Handle for the connecton.
83 struct GNUNET_PSYCSTORE_Handle *
84 GNUNET_PSYCSTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
88 * Disconnect from the PSYCstore service.
90 * @param h Handle for the connection.
93 GNUNET_PSYCSTORE_disconnect (struct GNUNET_PSYCSTORE_Handle *h);
97 * Handle for an operation on the PSYCSTORE (useful to cancel the operation).
99 struct GNUNET_PSYCSTORE_OperationHandle;
103 * Function called with the result of an asynchronous operation.
105 * @param result #GNUNET_SYSERR on error,
106 * #GNUNET_YES on success or if the peer was a member,
107 * #GNUNET_NO if the peer was not a member
110 (*GNUNET_PSYCSTORE_ResultCallback) (void *cls,
112 const char *err_msg);
116 * Store join/leave events for a PSYC channel in order to be able to answer
117 * membership test queries later.
119 * @param h Handle for the PSYCstore.
120 * @param channel_key The channel where the event happened.
121 * @param slave_key Public key of joining/leaving slave.
122 * @param did_join #GNUNET_YES on join, #GNUNET_NO on part.
123 * @param announced_at ID of the message that announced the membership change.
124 * @param effective_since Message ID this membership change is in effect since.
125 * For joins it is <= announced_at, for parts it is always 0.
126 * @param group_generation In case of a part, the last group generation the
127 * slave has access to. It has relevance when a larger message have
128 * fragments with different group generations.
129 * @param rcb Callback to call with the result of the storage operation.
130 * @param rcb_cls Closure for the callback.
132 * @return Operation handle that can be used to cancel the operation.
134 struct GNUNET_PSYCSTORE_OperationHandle *
135 GNUNET_PSYCSTORE_membership_store (struct GNUNET_PSYCSTORE_Handle *h,
136 const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
137 const struct GNUNET_CRYPTO_EddsaPublicKey *slave_key,
139 uint64_t announced_at,
140 uint64_t effective_since,
141 uint64_t group_generation,
142 GNUNET_PSYCSTORE_ResultCallback rcb,
147 * Test if a member was admitted to the channel at the given message ID.
149 * This is useful when relaying and replaying messages to check if a particular
150 * slave has access to the message fragment with a given group generation. It
151 * is also used when handling join requests to determine whether the slave is
152 * currently admitted to the channel.
154 * @param h Handle for the PSYCstore.
155 * @param channel_key The channel we are interested in.
156 * @param slave_key Public key of slave whose membership to check.
157 * @param message_id Message ID for which to do the membership test.
158 * @param group_generation Group generation of the fragment of the message to
159 * test. It has relevance if the message consists of multiple fragments
160 * with different group generations.
161 * @param rcb Callback to call with the test result.
162 * @param rcb_cls Closure for the callback.
164 * @return Operation handle that can be used to cancel the operation.
166 struct GNUNET_PSYCSTORE_OperationHandle *
167 GNUNET_PSYCSTORE_membership_test (struct GNUNET_PSYCSTORE_Handle *h,
168 const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
169 const struct GNUNET_CRYPTO_EddsaPublicKey *slave_key,
171 uint64_t group_generation,
172 GNUNET_PSYCSTORE_ResultCallback rcb,
177 * Store a message fragment sent to a channel.
179 * @param h Handle for the PSYCstore.
180 * @param channel_key The channel the message belongs to.
181 * @param message Message to store.
182 * @param psycstore_flags Flags indicating whether the PSYC message contains
184 * @param rcb Callback to call with the result of the operation.
185 * @param rcb_cls Closure for the callback.
187 * @return Handle that can be used to cancel the operation.
189 struct GNUNET_PSYCSTORE_OperationHandle *
190 GNUNET_PSYCSTORE_fragment_store (struct GNUNET_PSYCSTORE_Handle *h,
191 const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
192 const struct GNUNET_MULTICAST_MessageHeader *message,
193 uint32_t psycstore_flags,
194 GNUNET_PSYCSTORE_ResultCallback rcb,
199 * Function called with one message fragment, as the result of a
200 * GNUNET_PSYCSTORE_fragment_get() or GNUNET_PSYCSTORE_message_get() call.
202 * @param cls Closure.
203 * @param message The retrieved message fragment. A NULL value indicates that
204 * there are no more results to be returned.
205 * @param psycstore_flags Flags stored with the message.
207 * @return #GNUNET_NO to stop calling this callback with further fragments,
208 * #GNUNET_YES to continue.
211 (*GNUNET_PSYCSTORE_FragmentCallback) (void *cls,
212 struct GNUNET_MULTICAST_MessageHeader *message,
213 enum GNUNET_PSYCSTORE_MessageFlags psycstore_flags);
217 * Retrieve a message fragment by fragment ID.
219 * @param h Handle for the PSYCstore.
220 * @param channel_key The channel we are interested in.
221 * @param fragment_id Fragment ID to check. Use 0 to get the latest message fragment.
222 * @param fcb Callback to call with the retrieved fragment.
223 * @param rcb Callback to call with the result of the operation.
224 * @param cls Closure for the callbacks.
226 * @return Handle that can be used to cancel the operation.
228 struct GNUNET_PSYCSTORE_OperationHandle *
229 GNUNET_PSYCSTORE_fragment_get (struct GNUNET_PSYCSTORE_Handle *h,
230 const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
231 uint64_t fragment_id,
232 GNUNET_PSYCSTORE_FragmentCallback fcb,
233 GNUNET_PSYCSTORE_ResultCallback rcb,
238 * Retrieve all fragments of a message.
240 * @param h Handle for the PSYCstore.
241 * @param channel_key The channel we are interested in.
242 * @param message_id Message ID to check. Use 0 to get the latest message.
243 * @param fcb Callback to call with the retrieved fragments.
244 * @param rcb Callback to call with the result of the operation.
245 * @param cls Closure for the callbacks.
247 * @return Handle that can be used to cancel the operation.
249 struct GNUNET_PSYCSTORE_OperationHandle *
250 GNUNET_PSYCSTORE_message_get (struct GNUNET_PSYCSTORE_Handle *h,
251 const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
253 GNUNET_PSYCSTORE_FragmentCallback fcb,
254 GNUNET_PSYCSTORE_ResultCallback rcb,
259 * Retrieve a fragment of message specified by its message ID and fragment
262 * @param h Handle for the PSYCstore.
263 * @param channel_key The channel we are interested in.
264 * @param message_id Message ID to check. Use 0 to get the latest message.
265 * @param fragment_offset Offset of the fragment to retrieve.
266 * @param fcb Callback to call with the retrieved fragments.
267 * @param rcb Callback to call with the result of the operation.
268 * @param cls Closure for the callbacks.
270 * @return Handle that can be used to cancel the operation.
272 struct GNUNET_PSYCSTORE_OperationHandle *
273 GNUNET_PSYCSTORE_message_get_fragment (struct GNUNET_PSYCSTORE_Handle *h,
274 const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
276 uint64_t fragment_offset,
277 GNUNET_PSYCSTORE_FragmentCallback fcb,
278 GNUNET_PSYCSTORE_ResultCallback rcb,
283 * Callback used to return the latest value of counters for the channel master.
285 * @see GNUNET_PSYCSTORE_counters_get()
287 * @param cls Closure.
288 * @param result_code Status code for the operation:
289 * #GNUNET_OK: success, counter values are returned.
290 * #GNUNET_NO: no message has been sent to the channel yet.
291 * #GNUNET_SYSERR: an error occurred.
292 * @param max_fragment_id Latest message fragment ID, used by multicast.
293 * @param max_message_id Latest message ID, used by PSYC.
294 * @param max_group_generation Latest group generation, used by PSYC.
295 * @param max_state_message_id Latest message ID containing state modifiers that
296 * was applied to the state store. Used for the state sync process.
299 (*GNUNET_PSYCSTORE_CountersCallback) (void *cls,
301 uint64_t max_fragment_id,
302 uint64_t max_message_id,
303 uint64_t max_group_generation,
304 uint64_t max_state_message_id);
308 * Retrieve latest values of counters for a channel.
310 * The current value of counters are needed
311 * - when a channel master is restarted, so that it can continue incrementing
312 * the counters from their last value.
313 * - when a channel slave rejoins and starts the state synchronization process.
315 * @param h Handle for the PSYCstore.
316 * @param channel_key Public key that identifies the channel.
317 * @param ccb Callback to call with the result.
318 * @param ccb_cls Closure for the @a ccb callback.
320 * @return Handle that can be used to cancel the operation.
322 struct GNUNET_PSYCSTORE_OperationHandle *
323 GNUNET_PSYCSTORE_counters_get (struct GNUNET_PSYCSTORE_Handle *h,
324 struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
325 GNUNET_PSYCSTORE_CountersCallback ccb,
330 * Apply modifiers of a message to the current channel state.
332 * An error is returned if there are missing messages containing state
333 * operations before the current one.
335 * @param h Handle for the PSYCstore.
336 * @param channel_key The channel we are interested in.
337 * @param message_id ID of the message that contains the @a modifiers.
338 * @param state_delta Value of the @e state_delta PSYC header variable of the message.
339 * @param modifier_count Number of elements in the @a modifiers array.
340 * @param modifiers List of modifiers to apply.
341 * @param rcb Callback to call with the result of the operation.
342 * @param rcb_cls Closure for the @a rcb callback.
344 * @return Handle that can be used to cancel the operation.
346 struct GNUNET_PSYCSTORE_OperationHandle *
347 GNUNET_PSYCSTORE_state_modify (struct GNUNET_PSYCSTORE_Handle *h,
348 const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
350 uint64_t state_delta,
351 size_t modifier_count,
352 const struct GNUNET_ENV_Modifier *modifiers,
353 GNUNET_PSYCSTORE_ResultCallback rcb,
358 * Store synchronized state.
360 * @param h Handle for the PSYCstore.
361 * @param channel_key The channel we are interested in.
362 * @param message_id ID of the message that contains the state_hash PSYC header variable.
363 * @param modifier_count Number of elements in the @a modifiers array.
364 * @param modifiers Full state to store.
365 * @param rcb Callback to call with the result of the operation.
366 * @param rcb_cls Closure for the callback.
368 * @return Handle that can be used to cancel the operation.
370 struct GNUNET_PSYCSTORE_OperationHandle *
371 GNUNET_PSYCSTORE_state_sync (struct GNUNET_PSYCSTORE_Handle *h,
372 const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
374 size_t modifier_count,
375 const struct GNUNET_ENV_Modifier *modifiers,
376 GNUNET_PSYCSTORE_ResultCallback rcb,
382 * Reset the state of a channel.
384 * Delete all state variables stored for the given channel.
386 * @param h Handle for the PSYCstore.
387 * @param channel_key The channel we are interested in.
388 * @param rcb Callback to call with the result of the operation.
389 * @param rcb_cls Closure for the callback.
391 * @return Handle that can be used to cancel the operation.
393 struct GNUNET_PSYCSTORE_OperationHandle *
394 GNUNET_PSYCSTORE_state_reset (struct GNUNET_PSYCSTORE_Handle *h,
395 const struct GNUNET_CRYPTO_EddsaPublicKey
397 GNUNET_PSYCSTORE_ResultCallback rcb,
402 * Update signed values of state variables in the state store.
404 * @param h Handle for the PSYCstore.
405 * @param channel_key The channel we are interested in.
406 * @param message_id Message ID that contained the state @a hash.
407 * @param hash Hash of the serialized full state.
408 * @param rcb Callback to call with the result of the operation.
409 * @param rcb_cls Closure for the callback.
412 struct GNUNET_PSYCSTORE_OperationHandle *
413 GNUNET_PSYCSTORE_state_hash_update (struct GNUNET_PSYCSTORE_Handle *h,
414 const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
416 const struct GNUNET_HashCode *hash,
417 GNUNET_PSYCSTORE_ResultCallback rcb,
422 * Function called with the value of a state variable.
424 * @param cls Closure.
425 * @param name Name of the state variable. A NULL value indicates that there are no more
426 * state variables to be returned.
427 * @param value Value of the state variable.
428 * @param value_size Number of bytes in @a value.
430 * @return #GNUNET_NO to stop calling this callback with further variables,
431 * #GNUNET_YES to continue.
434 (*GNUNET_PSYCSTORE_StateCallback) (void *cls, const char *name,
435 const void *value, size_t value_size);
439 * Retrieve the best matching state variable.
441 * @param h Handle for the PSYCstore.
442 * @param channel_key The channel we are interested in.
443 * @param name Name of variable to match, the returned variable might be less specific.
444 * @param scb Callback to return the matching state variable.
445 * @param rcb Callback to call with the result of the operation.
446 * @param cls Closure for the callbacks.
448 * @return Handle that can be used to cancel the operation.
450 struct GNUNET_PSYCSTORE_OperationHandle *
451 GNUNET_PSYCSTORE_state_get (struct GNUNET_PSYCSTORE_Handle *h,
452 const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
454 GNUNET_PSYCSTORE_StateCallback scb,
455 GNUNET_PSYCSTORE_ResultCallback rcb,
460 * Retrieve all state variables for a channel with the given prefix.
462 * @param h Handle for the PSYCstore.
463 * @param channel_key The channel we are interested in.
464 * @param name_prefix Prefix of state variable names to match.
465 * @param scb Callback to return matching state variables.
466 * @param rcb Callback to call with the result of the operation.
467 * @param cls Closure for the callbacks.
469 * @return Handle that can be used to cancel the operation.
471 struct GNUNET_PSYCSTORE_OperationHandle *
472 GNUNET_PSYCSTORE_state_get_prefix (struct GNUNET_PSYCSTORE_Handle *h,
473 const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
474 const char *name_prefix,
475 GNUNET_PSYCSTORE_StateCallback scb,
476 GNUNET_PSYCSTORE_ResultCallback rcb,
481 * Cancel an operation.
483 * @param op Handle for the operation to cancel.
486 GNUNET_PSYCSTORE_operation_cancel (struct GNUNET_PSYCSTORE_OperationHandle *op);
491 #if 0 /* keep Emacsens' auto-indent happy */
498 /* ifndef GNUNET_PSYCSTORE_SERVICE_H */
500 /* end of gnunet_psycstore_service.h */