X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_psycstore_service.h;h=b1be5246ebfb7bc3dc6d3a0d9db7a680bfb5ef6e;hb=abdec5e11ff11bb10d32c013e11344a54786f80f;hp=2cb155f69cac4325a9e26ec5a46f1afc4d7e6781;hpb=c2d9d1e64c9801122caaa6b429fc67706db5c9d7;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_psycstore_service.h b/src/include/gnunet_psycstore_service.h index 2cb155f69..b1be5246e 100644 --- a/src/include/gnunet_psycstore_service.h +++ b/src/include/gnunet_psycstore_service.h @@ -1,6 +1,6 @@ /* This file is part of GNUnet. - Copyright (C) 2013 Christian Grothoff (and other contributing authors) + Copyright (C) 2013 GNUnet e.V. GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published @@ -14,15 +14,20 @@ You should have received a copy of the GNU General Public License along with GNUnet; see the file COPYING. If not, write to the - Free Software Foundation, Inc., 59 Temple Place - Suite 330, - Boston, MA 02111-1307, USA. + Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. */ /** - * @file include/gnunet_psycstore_service.h - * @brief PSYCstore service; implements persistent storage for the PSYC service * @author Gabor X Toth * @author Christian Grothoff + * + * @file + * PSYCstore service; implements persistent storage for the PSYC service + * + * @defgroup psycstore PSYC Store service + * Persistent storage for the PSYC service. + * @{ */ #ifndef GNUNET_PSYCSTORE_SERVICE_H #define GNUNET_PSYCSTORE_SERVICE_H @@ -36,7 +41,7 @@ extern "C" #endif #include "gnunet_util_lib.h" -#include "gnunet_env_lib.h" +#include "gnunet_psyc_util_lib.h" #include "gnunet_multicast_service.h" #include "gnunet_psyc_service.h" @@ -107,15 +112,20 @@ struct GNUNET_PSYCSTORE_OperationHandle; /** * Function called with the result of an asynchronous operation. * + * @param cls + * Closure. * @param result - * #GNUNET_YES on success or if the peer was a member, - * #GNUNET_NO if the peer was not a member, - * #GNUNET_SYSERR on error, + * Result of the operation. + * @param err_msg + * Error message, or NULL if there's no error. + * @param err_msg_size + * Size of @a err_msg */ typedef void (*GNUNET_PSYCSTORE_ResultCallback) (void *cls, int64_t result, - const char *err_msg); + const char *err_msg, + uint16_t err_msg_size); /** @@ -139,9 +149,9 @@ typedef void * In case of a part, the last group generation the slave has access to. * It has relevance when a larger message have fragments with different * group generations. - * @param rcb + * @param result_cb * Callback to call with the result of the storage operation. - * @param rcb_cls + * @param cls * Closure for the callback. * * @return Operation handle that can be used to cancel the operation. @@ -154,8 +164,8 @@ GNUNET_PSYCSTORE_membership_store (struct GNUNET_PSYCSTORE_Handle *h, uint64_t announced_at, uint64_t effective_since, uint64_t group_generation, - GNUNET_PSYCSTORE_ResultCallback rcb, - void *rcb_cls); + GNUNET_PSYCSTORE_ResultCallback result_cb, + void *cls); /** @@ -178,9 +188,9 @@ GNUNET_PSYCSTORE_membership_store (struct GNUNET_PSYCSTORE_Handle *h, * Group generation of the fragment of the message to test. * It has relevance if the message consists of multiple fragments with * different group generations. - * @param rcb + * @param result_cb * Callback to call with the test result. - * @param rcb_cls + * @param cls * Closure for the callback. * * @return Operation handle that can be used to cancel the operation. @@ -191,8 +201,8 @@ GNUNET_PSYCSTORE_membership_test (struct GNUNET_PSYCSTORE_Handle *h, const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key, uint64_t message_id, uint64_t group_generation, - GNUNET_PSYCSTORE_ResultCallback rcb, - void *rcb_cls); + GNUNET_PSYCSTORE_ResultCallback result_cb, + void *cls); /** @@ -203,8 +213,8 @@ GNUNET_PSYCSTORE_membership_test (struct GNUNET_PSYCSTORE_Handle *h, * @param msg Message to store. * @param psycstore_flags Flags indicating whether the PSYC message contains * state modifiers. - * @param rcb Callback to call with the result of the operation. - * @param rcb_cls Closure for the callback. + * @param result_cb Callback to call with the result of the operation. + * @param cls Closure for the callback. * * @return Handle that can be used to cancel the operation. */ @@ -213,8 +223,8 @@ GNUNET_PSYCSTORE_fragment_store (struct GNUNET_PSYCSTORE_Handle *h, const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key, const struct GNUNET_MULTICAST_MessageHeader *msg, enum GNUNET_PSYCSTORE_MessageFlags psycstore_flags, - GNUNET_PSYCSTORE_ResultCallback rcb, - void *rcb_cls); + GNUNET_PSYCSTORE_ResultCallback result_cb, + void *cls); /** @@ -293,7 +303,7 @@ GNUNET_PSYCSTORE_fragment_get (struct GNUNET_PSYCSTORE_Handle *h, * Maximum number of fragments to retrieve. * @param fragment_cb * Callback to call with the retrieved fragments. - * @param rcb + * @param result_cb * Callback to call with the result of the operation. * @param cls * Closure for the callbacks. @@ -306,7 +316,7 @@ GNUNET_PSYCSTORE_fragment_get_latest (struct GNUNET_PSYCSTORE_Handle *h, const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key, uint64_t fragment_limit, GNUNET_PSYCSTORE_FragmentCallback fragment_cb, - GNUNET_PSYCSTORE_ResultCallback rcb, + GNUNET_PSYCSTORE_ResultCallback result_cb, void *cls); @@ -318,15 +328,17 @@ GNUNET_PSYCSTORE_fragment_get_latest (struct GNUNET_PSYCSTORE_Handle *h, * @param channel_key * The channel we are interested in. * @param slave_key - * The slave requesting the message. If not NULL, a membership test is - * performed first and the message is only returned if the slave has - * access to it. + * The slave requesting the message. + * If not NULL, a membership test is performed first + * and the message is only returned if the slave has access to it. * @param first_message_id * First message ID to retrieve. - * Use 0 to get the latest message. * @param last_message_id * Last consecutive message ID to retrieve. - * Use 0 to get the latest message. + * @param fragment_limit + * Maximum number of fragments to retrieve. + * @param method_prefix + * Retrieve only messages with a matching method prefix. * @param fragment_cb * Callback to call with the retrieved fragments. * @param result_cb @@ -342,6 +354,8 @@ GNUNET_PSYCSTORE_message_get (struct GNUNET_PSYCSTORE_Handle *h, const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key, uint64_t first_message_id, uint64_t last_message_id, + uint64_t fragment_limit, + const char *method_prefix, GNUNET_PSYCSTORE_FragmentCallback fragment_cb, GNUNET_PSYCSTORE_ResultCallback result_cb, void *cls); @@ -355,14 +369,16 @@ GNUNET_PSYCSTORE_message_get (struct GNUNET_PSYCSTORE_Handle *h, * @param channel_key * The channel we are interested in. * @param slave_key - * The slave requesting the message. If not NULL, a membership test is - * performed first and the message is only returned if the slave has - * access to it. + * The slave requesting the message. + * If not NULL, a membership test is performed first + * and the message is only returned if the slave has access to it. * @param message_limit * Maximum number of messages to retrieve. + * @param method_prefix + * Retrieve only messages with a matching method prefix. * @param fragment_cb * Callback to call with the retrieved fragments. - * @param rcb + * @param result_cb * Callback to call with the result of the operation. * @param cls * Closure for the callbacks. @@ -374,8 +390,9 @@ GNUNET_PSYCSTORE_message_get_latest (struct GNUNET_PSYCSTORE_Handle *h, const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key, const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key, uint64_t message_limit, + const char *method_prefix, GNUNET_PSYCSTORE_FragmentCallback fragment_cb, - GNUNET_PSYCSTORE_ResultCallback rcb, + GNUNET_PSYCSTORE_ResultCallback result_cb, void *cls); @@ -421,14 +438,19 @@ GNUNET_PSYCSTORE_message_get_fragment (struct GNUNET_PSYCSTORE_Handle *h, * @see GNUNET_PSYCSTORE_counters_get() * * @param cls Closure. - * @param result_code Status code for the operation: + * @param result_code + * Status code for the operation: * #GNUNET_OK: success, counter values are returned. * #GNUNET_NO: no message has been sent to the channel yet. * #GNUNET_SYSERR: an error occurred. - * @param max_fragment_id Latest message fragment ID, used by multicast. - * @param max_message_id Latest message ID, used by PSYC. - * @param max_group_generation Latest group generation, used by PSYC. - * @param max_state_message_id Latest message ID containing state modifiers that + * @param max_fragment_id + * Latest message fragment ID, used by multicast. + * @param max_message_id + * Latest message ID, used by PSYC. + * @param max_group_generation + * Latest group generation, used by PSYC. + * @param max_state_message_id + * Latest message ID containing state modifiers that * was applied to the state store. Used for the state sync process. */ typedef void @@ -448,18 +470,22 @@ typedef void * the counters from their last value. * - when a channel slave rejoins and starts the state synchronization process. * - * @param h Handle for the PSYCstore. - * @param channel_key Public key that identifies the channel. - * @param ccb Callback to call with the result. - * @param ccb_cls Closure for the @a ccb callback. + * @param h + * Handle for the PSYCstore. + * @param channel_key + * Public key that identifies the channel. + * @param counters_cb + * Callback to call with the result. + * @param cls + * Closure for the @a ccb callback. * * @return Handle that can be used to cancel the operation. */ struct GNUNET_PSYCSTORE_OperationHandle * GNUNET_PSYCSTORE_counters_get (struct GNUNET_PSYCSTORE_Handle *h, struct GNUNET_CRYPTO_EddsaPublicKey *channel_key, - GNUNET_PSYCSTORE_CountersCallback ccb, - void *ccb_cls); + GNUNET_PSYCSTORE_CountersCallback counters_cb, + void *cls); /** @@ -468,14 +494,18 @@ GNUNET_PSYCSTORE_counters_get (struct GNUNET_PSYCSTORE_Handle *h, * An error is returned if there are missing messages containing state * operations before the current one. * - * @param h Handle for the PSYCstore. - * @param channel_key The channel we are interested in. - * @param message_id ID of the message that contains the @a modifiers. - * @param state_delta Value of the @e state_delta PSYC header variable of the message. - * @param modifier_count Number of elements in the @a modifiers array. - * @param modifiers List of modifiers to apply. - * @param rcb Callback to call with the result of the operation. - * @param rcb_cls Closure for the @a rcb callback. + * @param h + * Handle for the PSYCstore. + * @param channel_key + * The channel we are interested in. + * @param message_id + * ID of the message that contains the @a modifiers. + * @param state_delta + * Value of the @e state_delta PSYC header variable of the message. + * @param result_cb + * Callback to call with the result of the operation. + * @param cls + * Closure for the @a result_cb callback. * * @return Handle that can be used to cancel the operation. */ @@ -484,33 +514,41 @@ GNUNET_PSYCSTORE_state_modify (struct GNUNET_PSYCSTORE_Handle *h, const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key, uint64_t message_id, uint64_t state_delta, - size_t modifier_count, - const struct GNUNET_ENV_Modifier *modifiers, - GNUNET_PSYCSTORE_ResultCallback rcb, - void *rcb_cls); + GNUNET_PSYCSTORE_ResultCallback result_cb, + void *cls); /** * Store synchronized state. * - * @param h Handle for the PSYCstore. - * @param channel_key The channel we are interested in. - * @param message_id ID of the message that contains the state_hash PSYC header variable. - * @param modifier_count Number of elements in the @a modifiers array. - * @param modifiers Full state to store. - * @param rcb Callback to call with the result of the operation. - * @param rcb_cls Closure for the callback. + * @param h + * Handle for the PSYCstore. + * @param channel_key + * The channel we are interested in. + * @param max_state_message_id + * ID of the last stateful message before @a state_hash_message_id. + * @param state_hash_message_id + * ID of the message that contains the state_hash PSYC header variable. + * @param modifier_count + * Number of elements in the @a modifiers array. + * @param modifiers + * Full state to store. + * @param result_cb + * Callback to call with the result of the operation. + * @param cls + * Closure for the callback. * * @return Handle that can be used to cancel the operation. */ struct GNUNET_PSYCSTORE_OperationHandle * GNUNET_PSYCSTORE_state_sync (struct GNUNET_PSYCSTORE_Handle *h, const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key, - uint64_t message_id, + uint64_t max_state_message_id, + uint64_t state_hash_message_id, size_t modifier_count, - const struct GNUNET_ENV_Modifier *modifiers, - GNUNET_PSYCSTORE_ResultCallback rcb, - void *rcb_cls); + const struct GNUNET_PSYC_Modifier *modifiers, + GNUNET_PSYCSTORE_ResultCallback result_cb, + void *cls); @@ -519,10 +557,14 @@ GNUNET_PSYCSTORE_state_sync (struct GNUNET_PSYCSTORE_Handle *h, * * Delete all state variables stored for the given channel. * - * @param h Handle for the PSYCstore. - * @param channel_key The channel we are interested in. - * @param rcb Callback to call with the result of the operation. - * @param rcb_cls Closure for the callback. + * @param h + * Handle for the PSYCstore. + * @param channel_key + * The channel we are interested in. + * @param result_cb + * Callback to call with the result of the operation. + * @param cls + * Closure for the callback. * * @return Handle that can be used to cancel the operation. */ @@ -530,19 +572,25 @@ struct GNUNET_PSYCSTORE_OperationHandle * GNUNET_PSYCSTORE_state_reset (struct GNUNET_PSYCSTORE_Handle *h, const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key, - GNUNET_PSYCSTORE_ResultCallback rcb, - void *rcb_cls); + GNUNET_PSYCSTORE_ResultCallback result_cb, + void *cls); /** * Update signed values of state variables in the state store. * - * @param h Handle for the PSYCstore. - * @param channel_key The channel we are interested in. - * @param message_id Message ID that contained the state @a hash. - * @param hash Hash of the serialized full state. - * @param rcb Callback to call with the result of the operation. - * @param rcb_cls Closure for the callback. + * @param h + * Handle for the PSYCstore. + * @param channel_key + * The channel we are interested in. + * @param message_id + * Message ID that contained the state @a hash. + * @param hash + * Hash of the serialized full state. + * @param result_cb + * Callback to call with the result of the operation. + * @param cls + * Closure for the callback. * */ struct GNUNET_PSYCSTORE_OperationHandle * @@ -550,36 +598,46 @@ GNUNET_PSYCSTORE_state_hash_update (struct GNUNET_PSYCSTORE_Handle *h, const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key, uint64_t message_id, const struct GNUNET_HashCode *hash, - GNUNET_PSYCSTORE_ResultCallback rcb, - void *rcb_cls); + GNUNET_PSYCSTORE_ResultCallback result_cb, + void *cls); /** * Function called with the value of a state variable. * - * @param cls Closure. - * @param name Name of the state variable. A NULL value indicates that there are no more + * @param cls + * Closure. + * @param name + * Name of the state variable. A NULL value indicates that there are no more * state variables to be returned. - * @param value Value of the state variable. - * @param value_size Number of bytes in @a value. + * @param value + * Value of the state variable. + * @param value_size + * Number of bytes in @a value. * * @return #GNUNET_NO to stop calling this callback with further variables, * #GNUNET_YES to continue. */; typedef int (*GNUNET_PSYCSTORE_StateCallback) (void *cls, const char *name, - const void *value, size_t value_size); + const void *value, uint32_t value_size); /** * Retrieve the best matching state variable. * - * @param h Handle for the PSYCstore. - * @param channel_key The channel we are interested in. - * @param name Name of variable to match, the returned variable might be less specific. - * @param scb Callback to return the matching state variable. - * @param rcb Callback to call with the result of the operation. - * @param cls Closure for the callbacks. + * @param h + * Handle for the PSYCstore. + * @param channel_key + * The channel we are interested in. + * @param name + * Name of variable to match, the returned variable might be less specific. + * @param state_cb + * Callback to return the matching state variable. + * @param result_cb + * Callback to call with the result of the operation. + * @param cls + * Closure for the callbacks. * * @return Handle that can be used to cancel the operation. */ @@ -587,20 +645,26 @@ struct GNUNET_PSYCSTORE_OperationHandle * GNUNET_PSYCSTORE_state_get (struct GNUNET_PSYCSTORE_Handle *h, const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key, const char *name, - GNUNET_PSYCSTORE_StateCallback scb, - GNUNET_PSYCSTORE_ResultCallback rcb, + GNUNET_PSYCSTORE_StateCallback state_cb, + GNUNET_PSYCSTORE_ResultCallback result_cb, void *cls); /** * Retrieve all state variables for a channel with the given prefix. * - * @param h Handle for the PSYCstore. - * @param channel_key The channel we are interested in. - * @param name_prefix Prefix of state variable names to match. - * @param scb Callback to return matching state variables. - * @param rcb Callback to call with the result of the operation. - * @param cls Closure for the callbacks. + * @param h + * Handle for the PSYCstore. + * @param channel_key + * The channel we are interested in. + * @param name_prefix + * Prefix of state variable names to match. + * @param state_cb + * Callback to return matching state variables. + * @param result_cb + * Callback to call with the result of the operation. + * @param cls + * Closure for the callbacks. * * @return Handle that can be used to cancel the operation. */ @@ -608,8 +672,8 @@ struct GNUNET_PSYCSTORE_OperationHandle * GNUNET_PSYCSTORE_state_get_prefix (struct GNUNET_PSYCSTORE_Handle *h, const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key, const char *name_prefix, - GNUNET_PSYCSTORE_StateCallback scb, - GNUNET_PSYCSTORE_ResultCallback rcb, + GNUNET_PSYCSTORE_StateCallback state_cb, + GNUNET_PSYCSTORE_ResultCallback result_cb, void *cls); @@ -618,7 +682,7 @@ GNUNET_PSYCSTORE_state_get_prefix (struct GNUNET_PSYCSTORE_Handle *h, * * @param op Handle for the operation to cancel. */ -void +int GNUNET_PSYCSTORE_operation_cancel (struct GNUNET_PSYCSTORE_OperationHandle *op); @@ -633,4 +697,5 @@ GNUNET_PSYCSTORE_operation_cancel (struct GNUNET_PSYCSTORE_OperationHandle *op); /* ifndef GNUNET_PSYCSTORE_SERVICE_H */ #endif -/* end of gnunet_psycstore_service.h */ + +/** @} */ /* end of group */