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 announced_at ID of the message that announced the membership change.
96 * @param effective_since Message ID this membership change is in effect since.
97 * @param did_join #GNUNET_YES on join, #GNUNET_NO on part.
98 * @param rcb Callback to call with the result of the storage operation.
99 * @param rcb_cls Closure for the callback.
101 * @return Operation handle that can be used to cancel the operation.
103 struct GNUNET_PSYCSTORE_OperationHandle *
104 GNUNET_PSYCSTORE_membership_store (struct GNUNET_PSYCSTORE_Handle *h,
105 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
106 const struct GNUNET_CRYPTO_EccPublicKey *slave_key,
107 uint64_t announced_at,
108 uint64_t effective_since,
110 GNUNET_PSYCSTORE_ResultCallback rcb,
115 * Test if a peer was a member of the channel when the message fragment with the
116 * specified ID was sent to the channel.
118 * This is useful in case of retransmissions to check if the peer was authorized
119 * to see the requested message.
121 * @param h Handle for the PSYCstore.
122 * @param channel_key The channel we are interested in.
123 * @param slave_key Public key of slave whose membership to check.
124 * @param fragment_id Message fragment ID to check.
125 * @param rcb Callback to call with the test result.
126 * @param rcb_cls Closure for the callback.
128 * @return Operation handle that can be used to cancel the operation.
130 struct GNUNET_PSYCSTORE_OperationHandle *
131 GNUNET_PSYCSTORE_membership_test (struct GNUNET_PSYCSTORE_Handle *h,
132 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
133 const struct GNUNET_CRYPTO_EccPublicKey *slave_key,
134 uint64_t fragment_id,
135 GNUNET_PSYCSTORE_ResultCallback rcb,
140 * Store a message fragment sent to a channel.
142 * @param h Handle for the PSYCstore.
143 * @param channel_key The channel the message belongs to.
144 * @param message Message to store.
145 * @param rcb Callback to call with the result of the operation.
146 * @param rcb_cls Closure for the callback.
148 * @return Handle that can be used to cancel the operation.
150 struct GNUNET_PSYCSTORE_OperationHandle *
151 GNUNET_PSYCSTORE_fragment_store (struct GNUNET_PSYCSTORE_Handle *h,
152 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
153 const struct GNUNET_MULTICAST_MessageHeader *message,
154 GNUNET_PSYCSTORE_ResultCallback rcb,
159 * Function called with one message fragment, as the result of a
160 * GNUNET_PSYCSTORE_fragment_get() or GNUNET_PSYCSTORE_message_get() call.
162 * @param cls Closure.
163 * @param message The retrieved message fragment.
164 * @param flags Message flags indicating fragmentation status.
166 typedef void (*GNUNET_PSYCSTORE_FragmentResultCallback)(void *cls,
167 const struct GNUNET_MULTICAST_MessageHeader *message,
168 enum GNUNET_PSYC_MessageFlags flags);
172 * Retrieve a message fragment by fragment ID.
174 * @param h Handle for the PSYCstore.
175 * @param channel_key The channel we are interested in.
176 * @param fragment_id Fragment ID to check. Use 0 to get the latest message fragment.
177 * @param rcb Callback to call with the result of the operation.
178 * @param rcb_cls Closure for the callback.
180 * @return Handle that can be used to cancel the operation.
182 struct GNUNET_PSYCSTORE_OperationHandle *
183 GNUNET_PSYCSTORE_fragment_get (struct GNUNET_PSYCSTORE_Handle *h,
184 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
185 uint64_t fragment_id,
186 GNUNET_PSYCSTORE_FragmentResultCallback rcb,
191 * Retrieve a message by ID.
193 * @param h Handle for the PSYCstore.
194 * @param channel_key The channel we are interested in.
195 * @param message_id Message ID to check. Use 0 to get the latest message.
196 * @param rcb Callback to call with the result of the operation.
197 * @param rcb_cls Closure for the callback.
199 * @return Handle that can be used to cancel the operation.
201 struct GNUNET_PSYCSTORE_OperationHandle *
202 GNUNET_PSYCSTORE_message_get (struct GNUNET_PSYCSTORE_Handle *h,
203 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
205 GNUNET_PSYCSTORE_FragmentResultCallback rcb,
210 * Modify the channel state.
212 * Applies the operation to the current channel state.
214 * An error is returned if there are missing messages containing state
215 * operations before the current one.
217 * @param h Handle for the PSYCstore.
218 * @param channel_key The channel we are interested in.
219 * @param message_id ID of the message that contains this state modifier.
220 * @param oper Operation to perform.
221 * @param name Name of variable.
222 * @param value_size Size of @a value.
223 * @param value Value of variable.
224 * @param rcb Callback to call with the result of the operation.
225 * @param rcb_cls Closure for the callback.
227 * @return Handle that can be used to cancel the operation.
229 struct GNUNET_PSYCSTORE_OperationHandle *
230 GNUNET_PSYCSTORE_state_modify (struct GNUNET_PSYCSTORE_Handle *h,
231 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
233 enum GNUNET_ENV_Operator *oper,
237 GNUNET_PSYCSTORE_ResultCallback rcb,
242 * Function called with the value of a state variable.
244 * @param cls Closure.
245 * @param name Name of variable.
246 * @param size Size of @a value.
247 * @param value Value of variable.
250 typedef void (*GNUNET_PSYCSTORE_StateResultCallback)(void *cls,
257 * Retrieve the given state variable for a channel.
259 * @param h Handle for the PSYCstore.
260 * @param channel_key The channel we are interested in.
261 * @param name Name of variable to get.
262 * @param rcb Callback to call with the result.
263 * @param rcb_cls Closure for the callback.
265 * @return Handle that can be used to cancel the operation.
267 struct GNUNET_PSYCSTORE_OperationHandle *
268 GNUNET_PSYCSTORE_state_get (struct GNUNET_PSYCSTORE_Handle *h,
269 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
271 GNUNET_PSYCSTORE_StateResultCallback rcb,
276 * Retrieve all state variables for a channel.
278 * @param h Handle for the PSYCstore.
279 * @param channel_key The channel we are interested in.
280 * @param rcb Callback to call with the result.
281 * @param rcb_cls Closure for the callback.
283 * @return Handle that can be used to cancel the operation.
285 struct GNUNET_PSYCSTORE_OperationHandle *
286 GNUNET_PSYCSTORE_state_get_all (struct GNUNET_PSYCSTORE_Handle *h,
287 const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
288 GNUNET_PSYCSTORE_StateResultCallback rcb,
293 * Cancel an operation.
295 * @param oh Handle for the operation to cancel.
298 GNUNET_PSYCSTORE_operation_cancel (struct GNUNET_PSYCSTORE_OperationHandle *oh);
303 #if 0 /* keep Emacsens' auto-indent happy */
310 /* ifndef GNUNET_PSYCSTORE_SERVICE_H */
312 /* end of gnunet_psycstore_service.h */