[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] r36095 - in gnunet/src: include psycstore
From: |
gnunet |
Subject: |
[GNUnet-SVN] r36095 - in gnunet/src: include psycstore |
Date: |
Sat, 18 Jul 2015 02:03:00 +0200 |
Author: tg
Date: 2015-07-18 02:03:00 +0200 (Sat, 18 Jul 2015)
New Revision: 36095
Modified:
gnunet/src/include/gnunet_psycstore_service.h
gnunet/src/psycstore/psycstore_api.c
Log:
psycstore: doc formatting
Modified: gnunet/src/include/gnunet_psycstore_service.h
===================================================================
--- gnunet/src/include/gnunet_psycstore_service.h 2015-07-16 10:06:55 UTC
(rev 36094)
+++ gnunet/src/include/gnunet_psycstore_service.h 2015-07-18 00:03:00 UTC
(rev 36095)
@@ -430,14 +430,19 @@
* @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
@@ -457,10 +462,14 @@
* 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 ccb
+ * Callback to call with the result.
+ * @param ccb_cls
+ * Closure for the @a ccb callback.
*
* @return Handle that can be used to cancel the operation.
*/
@@ -477,14 +486,22 @@
* 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 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.
*
* @return Handle that can be used to cancel the operation.
*/
@@ -502,13 +519,20 @@
/**
* 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 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.
*
* @return Handle that can be used to cancel the operation.
*/
@@ -528,10 +552,14 @@
*
* 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 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.
*/
@@ -546,12 +574,18 @@
/**
* 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 rcb
+ * Callback to call with the result of the operation.
+ * @param rcb_cls
+ * Closure for the callback.
*
*/
struct GNUNET_PSYCSTORE_OperationHandle *
@@ -566,11 +600,15 @@
/**
* 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.
@@ -583,12 +621,18 @@
/**
* 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 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.
*/
@@ -604,12 +648,18 @@
/**
* 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 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.
*/
Modified: gnunet/src/psycstore/psycstore_api.c
===================================================================
--- gnunet/src/psycstore/psycstore_api.c 2015-07-16 10:06:55 UTC (rev
36094)
+++ gnunet/src/psycstore/psycstore_api.c 2015-07-18 00:03:00 UTC (rev
36095)
@@ -1180,10 +1180,14 @@
* The current value of counters are needed when a channel master is restarted,
* so that it can continue incrementing the counters from their last value.
*
- * @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 ccb
+ * Callback to call with the result.
+ * @param ccb_cls
+ * Closure for the @a ccb callback.
*
* @return Handle that can be used to cancel the operation.
*/
@@ -1222,14 +1226,22 @@
* 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 _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 _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.
*
* @return Handle that can be used to cancel the operation.
*/
@@ -1292,13 +1304,20 @@
/**
* 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 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.
*
* @return Handle that can be used to cancel the operation.
*/
@@ -1357,10 +1376,14 @@
*
* 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 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.
*/
@@ -1398,13 +1421,18 @@
/**
* 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 rcb
+ * Callback to call with the result of the operation.
+ * @param rcb_cls
+ * Closure for the callback.
*/
struct GNUNET_PSYCSTORE_OperationHandle *
GNUNET_PSYCSTORE_state_hash_update (struct GNUNET_PSYCSTORE_Handle *h,
@@ -1441,12 +1469,18 @@
/**
* 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 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.
*/
@@ -1488,12 +1522,18 @@
/**
* 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 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.
*/
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [GNUnet-SVN] r36095 - in gnunet/src: include psycstore,
gnunet <=