2 This file is part of GNUnet.
3 (C) 2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_psycstore_service.h
23 * @brief PSYCstore service; implements persistent storage for the PSYC service
24 * @author Gabor X Toth
25 * @author Christian Grothoff
27 #ifndef GNUNET_PSYCSTORE_SERVICE_H
28 #define GNUNET_PSYCSTORE_SERVICE_H
33 #if 0 /* keep Emacsens' auto-indent happy */
38 #include "gnunet_util_lib.h"
39 #include "gnunet_env_lib.h"
42 * Version number of GNUnet PSYCstore API.
44 #define GNUNET_PSYCSTORE_VERSION 0x00000000
47 * Handle for a PSYCstore
49 struct GNUNET_PSYCSTORE_Handle;
53 * Connect to the PSYCstore service.
55 * @param cfg Configuration to use.
57 * @return Handle for the connecton.
59 struct GNUNET_PSYCSTORE_Handle *
60 GNUNET_PSYCSTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
64 * Disconnect from the PSYCstore service.
66 * @param h Handle for the connection.
69 GNUNET_PSYCSTORE_disconnect (struct GNUNET_PSYCSTORE_Handle *h);
73 * Handle for an operation on the PSYCSTORE (useful to cancel the operation).
75 struct GNUNET_PSYCSTORE_OperationHandle;
79 * Function called with the result of an asynchronous operation.
81 * @param result #GNUNET_SYSERR on error,
82 * #GNUNET_YES on success or if the peer was a member,
83 * #GNUNET_NO if the peer was not a member
85 typedef void (*GNUNET_PSYCSTORE_ResultCallback)(void *cls,
89 * Store join/leave events for a PSYC channel in order to be able to answer
90 * membership test queries later.
92 * @param h Handle for the PSYCstore.
93 * @param channel_key The channel where the event happened.
94 * @param slave_key Public key of joining/leaving slave.
95 * @param message_id ID of the message in which this event was announced.
96 * @param did_join #GNUNET_YES on join, #GNUNET_NO on leave.
97 * @param rcb Callback to call with the result of the storage operation.
98 * @param rcb_cls Closure for the callback.
100 * @return Operation handle that can be used to cancel the operation.
102 struct GNUNET_PSYCSTORE_OperationHandle *
103 GNUNET_PSYCSTORE_membership_store (struct GNUNET_PSYCSTORE_Handle *h,
104 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
105 const struct GNUNET_CRYPTO_EccPublicKey *slave_key,
108 GNUNET_PSYCSTORE_ResultCallback rcb,
113 * Test if a peer was a member of the channel when the message fragment with the
114 * specified ID was sent to the channel.
116 * This is useful in case of retransmissions to check if the peer was authorized
117 * to see the requested message.
119 * @param h Handle for the PSYCstore.
120 * @param channel_key The channel we are interested in.
121 * @param slave_key Public key of slave whose membership to check.
122 * @param fragment_id Message fragment ID to check.
123 * @param rcb Callback to call with the test result.
124 * @param rcb_cls Closure for the callback.
126 * @return Operation handle that can be used to cancel the operation.
128 struct GNUNET_PSYCSTORE_OperationHandle *
129 GNUNET_PSYCSTORE_membership_test (struct GNUNET_PSYCSTORE_Handle *h,
130 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
131 const struct GNUNET_CRYPTO_EccPublicKey *slave_key,
132 uint64_t fragment_id,
133 GNUNET_PSYCSTORE_ResultCallback rcb,
138 * Store a message fragment sent to a channel.
140 * @param h Handle for the PSYCstore.
141 * @param channel_key The channel the message belongs to.
142 * @param message Message to store.
143 * @param rcb Callback to call with the result of the operation.
144 * @param rcb_cls Closure for the callback.
146 * @return Handle that can be used to cancel the operation.
148 struct GNUNET_PSYCSTORE_OperationHandle *
149 GNUNET_PSYCSTORE_fragment_store (struct GNUNET_PSYCSTORE_Handle *h,
150 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
151 const struct GNUNET_MULTICAST_MessageHeader *message,
152 GNUNET_PSYCSTORE_ResultCallback rcb,
157 * Function called with one message fragment, as the result of a
158 * GNUNET_PSYCSTORE_fragment_get() or GNUNET_PSYCSTORE_message_get() call.
160 * @param cls Closure.
161 * @param message The retrieved message fragment.
162 * @param flags Message flags indicating fragmentation status.
164 typedef void (*GNUNET_PSYCSTORE_FragmentResultCallback)(void *cls,
165 const struct GNUNET_MULTICAST_MessageHeader *message,
166 enum GNUNET_PSYC_MessageFlags flags);
170 * Retrieve a message fragment by fragment ID.
172 * @param h Handle for the PSYCstore.
173 * @param channel_key The channel we are interested in.
174 * @param fragment_id Fragment ID to check. Use 0 to get the latest message fragment.
175 * @param rcb Callback to call with the result of the operation.
176 * @param rcb_cls Closure for the callback.
178 * @return Handle that can be used to cancel the operation.
180 struct GNUNET_PSYCSTORE_OperationHandle *
181 GNUNET_PSYCSTORE_fragment_get (struct GNUNET_PSYCSTORE_Handle *h,
182 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
183 uint64_t fragment_id,
184 GNUNET_PSYCSTORE_FragmentResultCallback rcb,
189 * Retrieve a message by ID.
191 * @param h Handle for the PSYCstore.
192 * @param channel_key The channel we are interested in.
193 * @param message_id Message ID to check. Use 0 to get the latest message.
194 * @param rcb Callback to call with the result of the operation.
195 * @param rcb_cls Closure for the callback.
197 * @return Handle that can be used to cancel the operation.
199 struct GNUNET_PSYCSTORE_OperationHandle *
200 GNUNET_PSYCSTORE_message_get (struct GNUNET_PSYCSTORE_Handle *h,
201 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
203 GNUNET_PSYCSTORE_FragmentResultCallback rcb,
208 * Modify the channel state.
210 * Applies the operation to the current channel state.
212 * An error is returned if there are missing messages containing state
213 * operations before the current one.
215 * @param h Handle for the PSYCstore.
216 * @param channel_key The channel we are interested in.
217 * @param message_id ID of the message that contains this state modifier.
218 * @param oper Operation to perform.
219 * @param name Name of variable.
220 * @param value_size Size of @a value.
221 * @param value Value of variable.
222 * @param rcb Callback to call with the result of the operation.
223 * @param rcb_cls Closure for the callback.
225 * @return Handle that can be used to cancel the operation.
227 struct GNUNET_PSYCSTORE_OperationHandle *
228 GNUNET_PSYCSTORE_state_modify (struct GNUNET_PSYCSTORE_Handle *h,
229 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
231 enum GNUNET_ENV_Operator *oper,
235 GNUNET_PSYCSTORE_ResultCallback rcb,
240 * Function called with the value of a state variable.
242 * @param cls Closure.
243 * @param name Name of variable.
244 * @param size Size of @a value.
245 * @param value Value of variable.
248 typedef void (*GNUNET_PSYCSTORE_StateResultCallback)(void *cls,
255 * Retrieve the given state variable for a channel.
257 * @param h Handle for the PSYCstore.
258 * @param channel_key The channel we are interested in.
259 * @param name Name of variable to get.
260 * @param rcb Callback to call with the result.
261 * @param rcb_cls Closure for the callback.
263 * @return Handle that can be used to cancel the operation.
265 struct GNUNET_PSYCSTORE_OperationHandle *
266 GNUNET_PSYCSTORE_state_get (struct GNUNET_PSYCSTORE_Handle *h,
267 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
269 GNUNET_PSYCSTORE_StateResultCallback rcb,
274 * Retrieve all state variables for a channel.
276 * @param h Handle for the PSYCstore.
277 * @param channel_key The channel we are interested in.
278 * @param rcb Callback to call with the result.
279 * @param rcb_cls Closure for the callback.
281 * @return Handle that can be used to cancel the operation.
283 struct GNUNET_PSYCSTORE_OperationHandle *
284 GNUNET_PSYCSTORE_state_get_all (struct GNUNET_PSYCSTORE_Handle *h,
285 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
286 GNUNET_PSYCSTORE_StateResultCallback rcb,
291 * Cancel an operation.
293 * @param oh Handle for the operation to cancel.
296 GNUNET_PSYCSTORE_operation_cancel (struct GNUNET_PSYCSTORE_OperationHandle *oh);
301 #if 0 /* keep Emacsens' auto-indent happy */
308 /* ifndef GNUNET_PSYCSTORE_SERVICE_H */
310 /* end of gnunet_psycstore_service.h */