diff options
Diffstat (limited to 'src/psycstore/psycstore_api.c')
-rw-r--r-- | src/psycstore/psycstore_api.c | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/src/psycstore/psycstore_api.c b/src/psycstore/psycstore_api.c index 2b8c9305e..0e72d9ca2 100644 --- a/src/psycstore/psycstore_api.c +++ b/src/psycstore/psycstore_api.c | |||
@@ -37,7 +37,7 @@ | |||
37 | 37 | ||
38 | typedef void (*DataCallback) (); | 38 | typedef void (*DataCallback) (); |
39 | 39 | ||
40 | /** | 40 | /** |
41 | * Handle for an operation with the PSYCstore service. | 41 | * Handle for an operation with the PSYCstore service. |
42 | */ | 42 | */ |
43 | struct GNUNET_PSYCSTORE_OperationHandle | 43 | struct GNUNET_PSYCSTORE_OperationHandle |
@@ -162,9 +162,9 @@ get_next_op_id (struct GNUNET_PSYCSTORE_Handle *h) | |||
162 | } | 162 | } |
163 | 163 | ||
164 | 164 | ||
165 | /** | 165 | /** |
166 | * Find operation by ID. | 166 | * Find operation by ID. |
167 | * | 167 | * |
168 | * @return OperationHandle if found, or NULL otherwise. | 168 | * @return OperationHandle if found, or NULL otherwise. |
169 | */ | 169 | */ |
170 | static struct GNUNET_PSYCSTORE_OperationHandle * | 170 | static struct GNUNET_PSYCSTORE_OperationHandle * |
@@ -634,7 +634,7 @@ GNUNET_PSYCSTORE_operation_cancel (struct GNUNET_PSYCSTORE_OperationHandle *op) | |||
634 | } | 634 | } |
635 | 635 | ||
636 | 636 | ||
637 | /** | 637 | /** |
638 | * Store join/leave events for a PSYC channel in order to be able to answer | 638 | * Store join/leave events for a PSYC channel in order to be able to answer |
639 | * membership test queries later. | 639 | * membership test queries later. |
640 | * | 640 | * |
@@ -699,7 +699,7 @@ GNUNET_PSYCSTORE_membership_store (struct GNUNET_PSYCSTORE_Handle *h, | |||
699 | } | 699 | } |
700 | 700 | ||
701 | 701 | ||
702 | /** | 702 | /** |
703 | * Test if a member was admitted to the channel at the given message ID. | 703 | * Test if a member was admitted to the channel at the given message ID. |
704 | * | 704 | * |
705 | * This is useful when relaying and replaying messages to check if a particular | 705 | * This is useful when relaying and replaying messages to check if a particular |
@@ -754,7 +754,7 @@ GNUNET_PSYCSTORE_membership_test (struct GNUNET_PSYCSTORE_Handle *h, | |||
754 | } | 754 | } |
755 | 755 | ||
756 | 756 | ||
757 | /** | 757 | /** |
758 | * Store a message fragment sent to a channel. | 758 | * Store a message fragment sent to a channel. |
759 | * | 759 | * |
760 | * @param h Handle for the PSYCstore. | 760 | * @param h Handle for the PSYCstore. |
@@ -764,7 +764,7 @@ GNUNET_PSYCSTORE_membership_test (struct GNUNET_PSYCSTORE_Handle *h, | |||
764 | * state modifiers. | 764 | * state modifiers. |
765 | * @param rcb Callback to call with the result of the operation. | 765 | * @param rcb Callback to call with the result of the operation. |
766 | * @param rcb_cls Closure for the callback. | 766 | * @param rcb_cls Closure for the callback. |
767 | * | 767 | * |
768 | * @return Handle that can be used to cancel the operation. | 768 | * @return Handle that can be used to cancel the operation. |
769 | */ | 769 | */ |
770 | struct GNUNET_PSYCSTORE_OperationHandle * | 770 | struct GNUNET_PSYCSTORE_OperationHandle * |
@@ -801,7 +801,7 @@ GNUNET_PSYCSTORE_fragment_store (struct GNUNET_PSYCSTORE_Handle *h, | |||
801 | } | 801 | } |
802 | 802 | ||
803 | 803 | ||
804 | /** | 804 | /** |
805 | * Retrieve a message fragment by fragment ID. | 805 | * Retrieve a message fragment by fragment ID. |
806 | * | 806 | * |
807 | * @param h Handle for the PSYCstore. | 807 | * @param h Handle for the PSYCstore. |
@@ -810,7 +810,7 @@ GNUNET_PSYCSTORE_fragment_store (struct GNUNET_PSYCSTORE_Handle *h, | |||
810 | * @param fcb Callback to call with the retrieved fragments. | 810 | * @param fcb Callback to call with the retrieved fragments. |
811 | * @param rcb Callback to call with the result of the operation. | 811 | * @param rcb Callback to call with the result of the operation. |
812 | * @param cls Closure for the callbacks. | 812 | * @param cls Closure for the callbacks. |
813 | * | 813 | * |
814 | * @return Handle that can be used to cancel the operation. | 814 | * @return Handle that can be used to cancel the operation. |
815 | */ | 815 | */ |
816 | struct GNUNET_PSYCSTORE_OperationHandle * | 816 | struct GNUNET_PSYCSTORE_OperationHandle * |
@@ -846,7 +846,7 @@ GNUNET_PSYCSTORE_fragment_get (struct GNUNET_PSYCSTORE_Handle *h, | |||
846 | } | 846 | } |
847 | 847 | ||
848 | 848 | ||
849 | /** | 849 | /** |
850 | * Retrieve all fragments of a message. | 850 | * Retrieve all fragments of a message. |
851 | * | 851 | * |
852 | * @param h Handle for the PSYCstore. | 852 | * @param h Handle for the PSYCstore. |
@@ -855,7 +855,7 @@ GNUNET_PSYCSTORE_fragment_get (struct GNUNET_PSYCSTORE_Handle *h, | |||
855 | * @param fcb Callback to call with the retrieved fragments. | 855 | * @param fcb Callback to call with the retrieved fragments. |
856 | * @param rcb Callback to call with the result of the operation. | 856 | * @param rcb Callback to call with the result of the operation. |
857 | * @param cls Closure for the callbacks. | 857 | * @param cls Closure for the callbacks. |
858 | * | 858 | * |
859 | * @return Handle that can be used to cancel the operation. | 859 | * @return Handle that can be used to cancel the operation. |
860 | */ | 860 | */ |
861 | struct GNUNET_PSYCSTORE_OperationHandle * | 861 | struct GNUNET_PSYCSTORE_OperationHandle * |
@@ -891,7 +891,7 @@ GNUNET_PSYCSTORE_message_get (struct GNUNET_PSYCSTORE_Handle *h, | |||
891 | } | 891 | } |
892 | 892 | ||
893 | 893 | ||
894 | /** | 894 | /** |
895 | * Retrieve a fragment of message specified by its message ID and fragment | 895 | * Retrieve a fragment of message specified by its message ID and fragment |
896 | * offset. | 896 | * offset. |
897 | * | 897 | * |
@@ -902,7 +902,7 @@ GNUNET_PSYCSTORE_message_get (struct GNUNET_PSYCSTORE_Handle *h, | |||
902 | * @param fcb Callback to call with the retrieved fragments. | 902 | * @param fcb Callback to call with the retrieved fragments. |
903 | * @param rcb Callback to call with the result of the operation. | 903 | * @param rcb Callback to call with the result of the operation. |
904 | * @param cls Closure for the callbacks. | 904 | * @param cls Closure for the callbacks. |
905 | * | 905 | * |
906 | * @return Handle that can be used to cancel the operation. | 906 | * @return Handle that can be used to cancel the operation. |
907 | */ | 907 | */ |
908 | struct GNUNET_PSYCSTORE_OperationHandle * | 908 | struct GNUNET_PSYCSTORE_OperationHandle * |
@@ -940,7 +940,7 @@ GNUNET_PSYCSTORE_message_get_fragment (struct GNUNET_PSYCSTORE_Handle *h, | |||
940 | } | 940 | } |
941 | 941 | ||
942 | 942 | ||
943 | /** | 943 | /** |
944 | * Retrieve latest values of counters for a channel master. | 944 | * Retrieve latest values of counters for a channel master. |
945 | * | 945 | * |
946 | * The current value of counters are needed when a channel master is restarted, | 946 | * The current value of counters are needed when a channel master is restarted, |
@@ -950,7 +950,7 @@ GNUNET_PSYCSTORE_message_get_fragment (struct GNUNET_PSYCSTORE_Handle *h, | |||
950 | * @param channel_key Public key that identifies the channel. | 950 | * @param channel_key Public key that identifies the channel. |
951 | * @param mccb Callback to call with the result. | 951 | * @param mccb Callback to call with the result. |
952 | * @param mccb_cls Closure for the callback. | 952 | * @param mccb_cls Closure for the callback. |
953 | * | 953 | * |
954 | * @return Handle that can be used to cancel the operation. | 954 | * @return Handle that can be used to cancel the operation. |
955 | */ | 955 | */ |
956 | struct GNUNET_PSYCSTORE_OperationHandle * | 956 | struct GNUNET_PSYCSTORE_OperationHandle * |
@@ -982,7 +982,7 @@ GNUNET_PSYCSTORE_counters_get (struct GNUNET_PSYCSTORE_Handle *h, | |||
982 | } | 982 | } |
983 | 983 | ||
984 | 984 | ||
985 | /** | 985 | /** |
986 | * Apply modifiers of a message to the current channel state. | 986 | * Apply modifiers of a message to the current channel state. |
987 | * | 987 | * |
988 | * An error is returned if there are missing messages containing state | 988 | * An error is returned if there are missing messages containing state |
@@ -996,7 +996,7 @@ GNUNET_PSYCSTORE_counters_get (struct GNUNET_PSYCSTORE_Handle *h, | |||
996 | * @param modifiers List of modifiers to apply. | 996 | * @param modifiers List of modifiers to apply. |
997 | * @param rcb Callback to call with the result of the operation. | 997 | * @param rcb Callback to call with the result of the operation. |
998 | * @param rcb_cls Closure for the callback. | 998 | * @param rcb_cls Closure for the callback. |
999 | * | 999 | * |
1000 | * @return Handle that can be used to cancel the operation. | 1000 | * @return Handle that can be used to cancel the operation. |
1001 | */ | 1001 | */ |
1002 | struct GNUNET_PSYCSTORE_OperationHandle * | 1002 | struct GNUNET_PSYCSTORE_OperationHandle * |
@@ -1055,7 +1055,7 @@ GNUNET_PSYCSTORE_state_modify (struct GNUNET_PSYCSTORE_Handle *h, | |||
1055 | } | 1055 | } |
1056 | 1056 | ||
1057 | 1057 | ||
1058 | /** | 1058 | /** |
1059 | * Store synchronized state. | 1059 | * Store synchronized state. |
1060 | * | 1060 | * |
1061 | * @param h Handle for the PSYCstore. | 1061 | * @param h Handle for the PSYCstore. |
@@ -1065,7 +1065,7 @@ GNUNET_PSYCSTORE_state_modify (struct GNUNET_PSYCSTORE_Handle *h, | |||
1065 | * @param modifiers Full state to store. | 1065 | * @param modifiers Full state to store. |
1066 | * @param rcb Callback to call with the result of the operation. | 1066 | * @param rcb Callback to call with the result of the operation. |
1067 | * @param rcb_cls Closure for the callback. | 1067 | * @param rcb_cls Closure for the callback. |
1068 | * | 1068 | * |
1069 | * @return Handle that can be used to cancel the operation. | 1069 | * @return Handle that can be used to cancel the operation. |
1070 | */ | 1070 | */ |
1071 | struct GNUNET_PSYCSTORE_OperationHandle * | 1071 | struct GNUNET_PSYCSTORE_OperationHandle * |
@@ -1118,7 +1118,7 @@ GNUNET_PSYCSTORE_state_sync (struct GNUNET_PSYCSTORE_Handle *h, | |||
1118 | } | 1118 | } |
1119 | 1119 | ||
1120 | 1120 | ||
1121 | /** | 1121 | /** |
1122 | * Reset the state of a channel. | 1122 | * Reset the state of a channel. |
1123 | * | 1123 | * |
1124 | * Delete all state variables stored for the given channel. | 1124 | * Delete all state variables stored for the given channel. |
@@ -1127,7 +1127,7 @@ GNUNET_PSYCSTORE_state_sync (struct GNUNET_PSYCSTORE_Handle *h, | |||
1127 | * @param channel_key The channel we are interested in. | 1127 | * @param channel_key The channel we are interested in. |
1128 | * @param rcb Callback to call with the result of the operation. | 1128 | * @param rcb Callback to call with the result of the operation. |
1129 | * @param rcb_cls Closure for the callback. | 1129 | * @param rcb_cls Closure for the callback. |
1130 | * | 1130 | * |
1131 | * @return Handle that can be used to cancel the operation. | 1131 | * @return Handle that can be used to cancel the operation. |
1132 | */ | 1132 | */ |
1133 | struct GNUNET_PSYCSTORE_OperationHandle * | 1133 | struct GNUNET_PSYCSTORE_OperationHandle * |
@@ -1161,7 +1161,7 @@ GNUNET_PSYCSTORE_state_reset (struct GNUNET_PSYCSTORE_Handle *h, | |||
1161 | 1161 | ||
1162 | 1162 | ||
1163 | 1163 | ||
1164 | /** | 1164 | /** |
1165 | * Update signed values of state variables in the state store. | 1165 | * Update signed values of state variables in the state store. |
1166 | * | 1166 | * |
1167 | * @param h Handle for the PSYCstore. | 1167 | * @param h Handle for the PSYCstore. |
@@ -1204,7 +1204,7 @@ GNUNET_PSYCSTORE_state_hash_update (struct GNUNET_PSYCSTORE_Handle *h, | |||
1204 | } | 1204 | } |
1205 | 1205 | ||
1206 | 1206 | ||
1207 | /** | 1207 | /** |
1208 | * Retrieve the best matching state variable. | 1208 | * Retrieve the best matching state variable. |
1209 | * | 1209 | * |
1210 | * @param h Handle for the PSYCstore. | 1210 | * @param h Handle for the PSYCstore. |
@@ -1213,7 +1213,7 @@ GNUNET_PSYCSTORE_state_hash_update (struct GNUNET_PSYCSTORE_Handle *h, | |||
1213 | * @param scb Callback to return the matching state variable. | 1213 | * @param scb Callback to return the matching state variable. |
1214 | * @param rcb Callback to call with the result of the operation. | 1214 | * @param rcb Callback to call with the result of the operation. |
1215 | * @param cls Closure for the callbacks. | 1215 | * @param cls Closure for the callbacks. |
1216 | * | 1216 | * |
1217 | * @return Handle that can be used to cancel the operation. | 1217 | * @return Handle that can be used to cancel the operation. |
1218 | */ | 1218 | */ |
1219 | struct GNUNET_PSYCSTORE_OperationHandle * | 1219 | struct GNUNET_PSYCSTORE_OperationHandle * |
@@ -1251,7 +1251,7 @@ GNUNET_PSYCSTORE_state_get (struct GNUNET_PSYCSTORE_Handle *h, | |||
1251 | 1251 | ||
1252 | 1252 | ||
1253 | 1253 | ||
1254 | /** | 1254 | /** |
1255 | * Retrieve all state variables for a channel with the given prefix. | 1255 | * Retrieve all state variables for a channel with the given prefix. |
1256 | * | 1256 | * |
1257 | * @param h Handle for the PSYCstore. | 1257 | * @param h Handle for the PSYCstore. |
@@ -1260,7 +1260,7 @@ GNUNET_PSYCSTORE_state_get (struct GNUNET_PSYCSTORE_Handle *h, | |||
1260 | * @param scb Callback to return matching state variables. | 1260 | * @param scb Callback to return matching state variables. |
1261 | * @param rcb Callback to call with the result of the operation. | 1261 | * @param rcb Callback to call with the result of the operation. |
1262 | * @param cls Closure for the callbacks. | 1262 | * @param cls Closure for the callbacks. |
1263 | * | 1263 | * |
1264 | * @return Handle that can be used to cancel the operation. | 1264 | * @return Handle that can be used to cancel the operation. |
1265 | */ | 1265 | */ |
1266 | struct GNUNET_PSYCSTORE_OperationHandle * | 1266 | struct GNUNET_PSYCSTORE_OperationHandle * |