Boston, MA 02111-1307, USA.
*/
-/**
+/**
* @file include/gnunet_psycstore_service.h
* @brief PSYCstore service; implements persistent storage for the PSYC service
* @author Gabor X Toth
#include "gnunet_multicast_service.h"
#include "gnunet_psyc_service.h"
-/**
+/**
* Version number of GNUnet PSYCstore API.
*/
#define GNUNET_PSYCSTORE_VERSION 0x00000000
};
-/**
+/**
* Handle for a PSYCstore
*/
struct GNUNET_PSYCSTORE_Handle;
-/**
+/**
* Connect to the PSYCstore service.
*
* @param cfg Configuration to use.
GNUNET_PSYCSTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
-/**
+/**
* Disconnect from the PSYCstore service.
*
* @param h Handle for the connection.
GNUNET_PSYCSTORE_disconnect (struct GNUNET_PSYCSTORE_Handle *h);
-/**
+/**
* Handle for an operation on the PSYCSTORE (useful to cancel the operation).
*/
struct GNUNET_PSYCSTORE_OperationHandle;
-/**
+/**
* Function called with the result of an asynchronous operation.
- *
+ *
* @param result #GNUNET_SYSERR on error,
* #GNUNET_YES on success or if the peer was a member,
* #GNUNET_NO if the peer was not a member
const char *err_msg);
-/**
+/**
* Store join/leave events for a PSYC channel in order to be able to answer
* membership test queries later.
*
void *rcb_cls);
-/**
+/**
* Test if a member was admitted to the channel at the given message ID.
*
* This is useful when relaying and replaying messages to check if a particular
void *rcb_cls);
-/**
+/**
* Store a message fragment sent to a channel.
*
* @param h Handle for the PSYCstore.
* state modifiers.
* @param rcb Callback to call with the result of the operation.
* @param rcb_cls Closure for the callback.
- *
+ *
* @return Handle that can be used to cancel the operation.
*/
struct GNUNET_PSYCSTORE_OperationHandle *
void *rcb_cls);
-/**
+/**
* Function called with one message fragment, as the result of a
* GNUNET_PSYCSTORE_fragment_get() or GNUNET_PSYCSTORE_message_get() call.
*
enum GNUNET_PSYCSTORE_MessageFlags psycstore_flags);
-/**
+/**
* Retrieve a message fragment by fragment ID.
*
* @param h Handle for the PSYCstore.
* @param fcb Callback to call with the retrieved fragment.
* @param rcb 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.
*/
struct GNUNET_PSYCSTORE_OperationHandle *
void *cls);
-/**
+/**
* Retrieve all fragments of a message.
*
* @param h Handle for the PSYCstore.
* @param fcb Callback to call with the retrieved fragments.
* @param rcb 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.
*/
struct GNUNET_PSYCSTORE_OperationHandle *
void *cls);
-/**
+/**
* Retrieve a fragment of message specified by its message ID and fragment
* offset.
*
* @param fcb Callback to call with the retrieved fragments.
* @param rcb 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.
*/
struct GNUNET_PSYCSTORE_OperationHandle *
void *cls);
-/**
+/**
* Callback used to return the latest value of counters for the channel master.
*
* @see GNUNET_PSYCSTORE_counters_get()
uint64_t max_state_message_id);
-/**
+/**
* Retrieve latest values of counters for a channel.
*
* The current value of counters are needed
* @param channel_key Public key that identifies the channel.
* @param ccb Callback to call with the result.
* @param ccb_cls Closure for the callback.
- *
+ *
* @return Handle that can be used to cancel the operation.
*/
struct GNUNET_PSYCSTORE_OperationHandle *
void *ccb_cls);
-/**
+/**
* Apply modifiers of a message to the current channel state.
*
* An error is returned if there are missing messages containing state
* @param modifiers List of modifiers to apply.
* @param rcb Callback to call with the result of the operation.
* @param rcb_cls Closure for the callback.
- *
+ *
* @return Handle that can be used to cancel the operation.
*/
struct GNUNET_PSYCSTORE_OperationHandle *
void *rcb_cls);
-/**
+/**
* Store synchronized state.
*
* @param h Handle for the PSYCstore.
* @param modifiers Full state to store.
* @param rcb Callback to call with the result of the operation.
* @param rcb_cls Closure for the callback.
- *
+ *
* @return Handle that can be used to cancel the operation.
*/
struct GNUNET_PSYCSTORE_OperationHandle *
-/**
+/**
* Reset the state of a channel.
*
* Delete all state variables stored for the given channel.
* @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.
- *
+ *
* @return Handle that can be used to cancel the operation.
*/
struct GNUNET_PSYCSTORE_OperationHandle *
void *rcb_cls);
-/**
+/**
* Update signed values of state variables in the state store.
*
* @param h Handle for the PSYCstore.
void *rcb_cls);
-/**
+/**
* Function called with the value of a state variable.
*
* @param cls Closure.
const void *value, size_t value_size);
-/**
+/**
* Retrieve the best matching state variable.
*
* @param h Handle for the PSYCstore.
* @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.
- *
+ *
* @return Handle that can be used to cancel the operation.
*/
struct GNUNET_PSYCSTORE_OperationHandle *
void *cls);
-/**
+/**
* Retrieve all state variables for a channel with the given prefix.
*
* @param h Handle for the PSYCstore.
* @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.
- *
+ *
* @return Handle that can be used to cancel the operation.
*/
struct GNUNET_PSYCSTORE_OperationHandle *
void *cls);
-/**
+/**
* Cancel an operation.
*
* @param op Handle for the operation to cancel.
projects / oweals / gnunet.git / blobdiff