/*
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
*/
/**
- * @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
#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"
* 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.
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);
/**
* 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.
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);
/**
* @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.
*/
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);
/**
* 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.
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);
uint64_t message_limit,
const char *method_prefix,
GNUNET_PSYCSTORE_FragmentCallback fragment_cb,
- GNUNET_PSYCSTORE_ResultCallback rcb,
+ GNUNET_PSYCSTORE_ResultCallback result_cb,
void *cls);
* Handle for the PSYCstore.
* @param channel_key
* Public key that identifies the channel.
- * @param ccb
+ * @param counters_cb
* Callback to call with the result.
- * @param ccb_cls
+ * @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);
/**
* 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 rcb
+ * @param result_cb
* Callback to call with the result of the operation.
- * @param rcb_cls
- * Closure for the @a rcb callback.
+ * @param cls
+ * Closure for the @a result_cb callback.
*
* @return Handle that can be used to cancel the operation.
*/
const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
uint64_t message_id,
uint64_t state_delta,
- GNUNET_PSYCSTORE_ResultCallback rcb,
- void *rcb_cls);
+ GNUNET_PSYCSTORE_ResultCallback result_cb,
+ void *cls);
/**
* Number of elements in the @a modifiers array.
* @param modifiers
* Full state to store.
- * @param rcb
+ * @param result_cb
* Callback to call with the result of the operation.
- * @param rcb_cls
+ * @param cls
* Closure for the callback.
*
* @return Handle that can be used to cancel the operation.
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);
* Handle for the PSYCstore.
* @param channel_key
* The channel we are interested in.
- * @param rcb
+ * @param result_cb
* Callback to call with the result of the operation.
- * @param rcb_cls
+ * @param cls
* Closure for the callback.
*
* @return Handle that can be used to cancel the operation.
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);
/**
* Message ID that contained the state @a hash.
* @param hash
* Hash of the serialized full state.
- * @param rcb
+ * @param result_cb
* Callback to call with the result of the operation.
- * @param rcb_cls
+ * @param cls
* Closure for the callback.
*
*/
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);
/**
* The channel we are interested in.
* @param name
* Name of variable to match, the returned variable might be less specific.
- * @param scb
+ * @param state_cb
* Callback to return the matching state variable.
- * @param rcb
+ * @param result_cb
* Callback to call with the result of the operation.
* @param cls
* Closure for the callbacks.
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);
* The channel we are interested in.
* @param name_prefix
* Prefix of state variable names to match.
- * @param scb
+ * @param state_cb
* Callback to return matching state variables.
- * @param rcb
+ * @param result_cb
* Callback to call with the result of the operation.
* @param cls
* Closure for the callbacks.
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);
*
* @param op Handle for the operation to cancel.
*/
-void
+int
GNUNET_PSYCSTORE_operation_cancel (struct GNUNET_PSYCSTORE_OperationHandle *op);
/* ifndef GNUNET_PSYCSTORE_SERVICE_H */
#endif
-/* end of gnunet_psycstore_service.h */
+
+/** @} */ /* end of group */
projects / oweals / gnunet.git / blobdiff