psycstore: added state_hash_update() and counters_get(); psyc: async state_get*(...
[oweals/gnunet.git] / src / include / gnunet_psyc_service.h
1 /*
2      This file is part of GNUnet.
3      (C) 2012, 2013 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20
21 /** 
22  * @file include/gnunet_psyc_service.h
23  * @brief PSYC service; high-level access to the PSYC protocol
24  *        note that clients of this API are NOT expected to
25  *        understand the PSYC message format, only the semantics!
26  *        Parsing (and serializing) the PSYC stream format is done
27  *        within the implementation of the libgnunetpsyc library,
28  *        and this API deliberately exposes as little as possible
29  *        of the actual data stream format to the application!
30  * @author Christian Grothoff
31  * @author Gabor X Toth
32  *
33  * NOTE:
34  * - this API does not know about psyc's "root" and "places";
35  *   there is no 'root' in GNUnet-Psyc as we're decentralized;
36  *   'places' and 'persons' are combined within the same
37  *   abstraction, that of a "channel".  Channels are identified
38  *   and accessed in this API using a public/private key.
39  *   Higher-level applications should use NAMES within GADS
40  *   to obtain public keys, and the distinction between
41  *   'places' and 'persons' can then be made with the help
42  *   of the naming system (and/or conventions).
43  *   Channels are (as in PSYC) organized into a hierarchy; each
44  *   channel master (the one with the private key) is then
45  *   the operator of the multicast group (its Origin in
46  *   the terminology of the multicast API).
47  * - The API supports passing large amounts of data using
48  *   'streaming' for the argument passed to a method.  State
49  *   and variables must fit into memory and cannot be streamed
50  *   (thus, no passing of 4 GB of data in a variable;
51  *   once we implement this, we might want to create a
52  *   @c \#define for the maximum size of a variable).
53  * - PSYC defines standard variables, methods, etc.  This
54  *   library deliberately abstracts over all of these; a
55  *   higher-level API should combine the naming system (GADS)
56  *   and standard methods (message, join, part, warn,
57  *   fail, error) and variables (action, color, time,
58  *   tag, etc.).  However, this API does take over the
59  *   routing variables, specifically 'context' (channel),
60  *   and 'source'.  We only kind-of support 'target', as
61  *   the target is either everyone in the group or the
62  *   origin, and never just a single member of the group;
63  *   for such individual messages, an application needs to
64  *   construct an 'inbox' channel where the master (only)
65  *   receives messages (but never forwards; private responses
66  *   would be transmitted by joining the senders 'inbox'
67  *   channel -- or a inbox#bob subchannel).  The
68  *   goal for all of this is to keep the abstractions in this
69  *   API minimal: interaction with multicast, try \& slice,
70  *   state/variable/channel management.  Higher-level
71  *   operations belong elsewhere (so maybe this API should
72  *   be called 'PSYC-low', whereas a higher-level API
73  *   implementing defaults for standard methods and
74  *   variables might be called 'PSYC-std' or 'PSYC-high'.
75  */
76
77 #ifndef GNUNET_PSYC_SERVICE_H
78 #define GNUNET_PSYC_SERVICE_H
79
80 #ifdef __cplusplus
81 extern "C"
82 {
83 #if 0                           /* keep Emacsens' auto-indent happy */
84 }
85 #endif
86 #endif
87
88 #include "gnunet_util_lib.h"
89 #include "gnunet_psyc_lib.h"
90 #include "gnunet_multicast_service.h"
91
92
93 /** 
94  * Version number of GNUnet-PSYC API.
95  */
96 #define GNUNET_PSYC_VERSION 0x00000000
97
98
99 enum GNUNET_PSYC_MessageFlags
100 {
101   /**
102    * First fragment of a message.
103    */
104   GNUNET_PSYC_MESSAGE_FIRST_FRAGMENT = 1 << 0,
105
106   /**
107    * Last fragment of a message.
108    */
109   GNUNET_PSYC_MESSAGE_LAST_FRAGMENT = 1 << 1,
110
111   /** 
112    * OR'ed flags if message is not fragmented.
113    */
114   GNUNET_PSYC_MESSAGE_NOT_FRAGMENTED
115     = GNUNET_PSYC_MESSAGE_FIRST_FRAGMENT
116     | GNUNET_PSYC_MESSAGE_LAST_FRAGMENT,
117
118   /**
119    * Historic message, retrieved from PSYCstore.
120    */
121   GNUNET_PSYC_MESSAGE_HISTORIC = 1 << 30
122 };
123
124
125 /** 
126  * Handle that identifies a join request.
127  *
128  * Used to match calls to #GNUNET_PSYC_JoinCallback to the
129  * corresponding calls to GNUNET_PSYC_join_decision().
130  */
131 struct GNUNET_PSYC_JoinHandle;
132
133
134 /** 
135  * Method called from PSYC upon receiving a message indicating a call
136  * to a @e method.
137  *
138  * @param cls Closure.
139  * @param slave_key Who transmitted the message.
140  *        - NULL for multicast messages from the master.
141  *        - The hash of the sending slave's public key for unicast requests from
142  *          one of the slaves to the master.
143  * @param message_id Unique message counter for this message.
144  *        Unique only in combination with the given sender for this channel.
145  * @param method_name Method name from PSYC.
146  * @param modifier_count Number of elements in the @a modifiers array.
147  * @param modifiers State modifiers and transient variables for the message.
148  * @param data_offset Byte offset of @a data in the overall data of the method.
149  * @param data_size Number of bytes in @a data.
150  * @param data Data stream given to the method (might not be zero-terminated
151  *             if data is binary).
152  * @param frag Fragmentation status for the data.
153  */
154 typedef int
155 (*GNUNET_PSYC_Method) (void *cls,
156                        const struct GNUNET_CRYPTO_EccPublicKey *slave_key,
157                        uint64_t message_id,
158                        const char *method_name,
159                        size_t modifier_count,
160                        const GNUNET_ENV_Modifier *modifiers,
161                        uint64_t data_offset,
162                        size_t data_size,
163                        const void *data,
164                        enum GNUNET_PSYC_MessageFlags flags);
165
166
167 /** 
168  * Method called from PSYC upon receiving a join request.
169  *
170  * @param cls Closure.
171  * @param slave  requesting to join.
172  * @param method_name Method name in the join request.
173  * @param variable_count Number of elements in the @a variables array.
174  * @param variables Transient variables for the join request.
175  * @param data_size Number of bytes in @a data.
176  * @param data Data stream given to the method (might not be zero-terminated
177  *             if data is binary).
178  */
179 typedef int
180 (*GNUNET_PSYC_JoinCallback) (void *cls,
181                              const struct GNUNET_CRYPTO_EccPublicKey *slave_key,
182                              const char *method_name,
183                              size_t variable_count,
184                              const GNUNET_ENV_Modifier *variables,
185                              size_t data_size,
186                              const void *data,
187                              struct GNUNET_PSYC_JoinHandle *jh);
188
189
190 /** 
191  * Function to call with the decision made for a join request.
192  *
193  * Must be called once and only once in response to an invocation of the
194  * #GNUNET_PSYC_JoinCallback.
195  *
196  * @param jh Join request handle.
197  * @param is_admitted #GNUNET_YES if joining is approved,
198  *        #GNUNET_NO if it is disapproved.
199  * @param relay_count Number of relays given.
200  * @param relays Array of suggested peers that might be useful relays to use
201  *        when joining the multicast group (essentially a list of peers that
202  *        are already part of the multicast group and might thus be willing
203  *        to help with routing).  If empty, only this local peer (which must
204  *        be the multicast origin) is a good candidate for building the
205  *        multicast tree.  Note that it is unnecessary to specify our own
206  *        peer identity in this array.
207  * @param method_name Method name for the message transmitted with the response.
208  * @param env Environment containing transient variables for the message, or NULL.
209  * @param data_size Size of @a data.
210  * @param data Data of the message.
211  */
212 void
213 GNUNET_PSYC_join_decision (struct GNUNET_PSYC_JoinHandle *jh,
214                            int is_admitted,
215                            unsigned int relay_count,
216                            const struct GNUNET_PeerIdentity *relays,
217                            const char *method_name,
218                            const struct GNUNET_ENV_Environment *env,
219                            size_t data_size,
220                            const void *data);
221
222
223 /** 
224  * Handle for the master of a PSYC channel.
225  */
226 struct GNUNET_PSYC_Master;
227
228
229 /** 
230  * Start a PSYC master channel.
231  *
232  * Will start a multicast group identified by the given ECC key.  Messages
233  * received from group members will be given to the respective handler methods.
234  * If a new member wants to join a group, the "join" method handler will be
235  * invoked; the join handler must then generate a "join" message to approve the
236  * joining of the new member.  The channel can also change group membership
237  * without explicit requests.  Note that PSYC doesn't itself "understand" join
238  * or part messages, the respective methods must call other PSYC functions to
239  * inform PSYC about the meaning of the respective events.
240  *
241  * @param cfg Configuration to use (to connect to PSYC service).
242  * @param channel_key ECC key that will be used to sign messages for this
243  *        PSYC session. The public key is used to identify the PSYC channel.
244  *        Note that end-users will usually not use the private key directly, but
245  *        rather look it up in GADS for places managed by other users, or select
246  *        a file with the private key(s) when setting up their own channels
247  *        FIXME: we'll likely want to use NOT the p521 curve here, but a cheaper
248  *        one in the future.
249  * @param policy Group policy specifying join and history restrictions.
250  *        Used to automate group management decisions.
251  * @param method Function to invoke on messages received from slaves.
252  * @param join_cb Function to invoke when a peer wants to join.
253  * @param cls Closure for @a method and @a join_cb.
254  * @return Handle for the channel master, NULL on error.
255  */
256 struct GNUNET_PSYC_Master *
257 GNUNET_PSYC_master_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
258                           const struct GNUNET_CRYPTO_EccPrivateKey *channel_key,
259                           enum GNUNET_MULTICAST_GroupPolicy policy,
260                           GNUNET_PSYC_Method method,
261                           GNUNET_PSYC_JoinCallback join_cb,
262                           void *cls);
263
264
265 /** 
266  * Function called to provide data for a transmission via PSYC.
267  *
268  * Note that returning #GNUNET_OK or #GNUNET_SYSERR (but not #GNUNET_NO)
269  * invalidates the respective transmission handle.
270  *
271  * @param cls Closure.
272  * @param message_id Set to the unique message ID that was generated for
273  *        this message.
274  * @param[in,out] data_size Initially set to the number of bytes available in @a data,
275  *        should be set to the number of bytes written to data (IN/OUT).
276  * @param[out] data Where to write the body of the message to give to the method;
277  *        function must copy at most @a *data_size bytes to @a data.
278  * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
279  *         #GNUNET_NO on success, if more data is to be transmitted later
280  *         (should be used if @a *data_size was not big enough to take all the data)
281  *         #GNUNET_YES if this completes the transmission (all data supplied)
282  */
283 typedef int
284 (*GNUNET_PSYC_MasterReadyNotify)(void *cls,
285                                  uint64_t message_id,
286                                  size_t *data_size,
287                                  void *data);
288
289
290
291 /**
292  * Flags for transmitting messages to a channel by the master.
293  */
294 enum GNUNET_PSYC_MasterTransmitFlags
295 {
296   /** 
297    * Whether this message should reset the channel state,
298    * i.e. remove all previously stored state variables.
299    */
300   GNUNET_PSYC_MASTER_TRANSMIT_RESET_STATE = 1 << 0,
301
302   /** 
303    * Whether we need to increment the group generation counter after
304    * transmitting this message.
305    */
306   GNUNET_PSYC_MASTER_TRANSMIT_INC_GROUP_GEN = 1 << 1,
307
308   /**
309    * Add PSYC header variable with the hash of the current channel state.
310    */
311   GNUNET_PSYC_MASTER_TRANSMIT_ADD_STATE_HASH = 1 << 2
312 };
313
314
315 /** 
316  * Handle for a pending PSYC transmission operation.
317  */
318 struct GNUNET_PSYC_MasterTransmitHandle;
319
320
321 /** 
322  * Send a message to call a method to all members in the PSYC channel.
323  *
324  * @param master Handle to the PSYC channel.
325  * @param method_name Which method should be invoked.
326  * @param env Environment containing state operations and transient variables
327  *            for the message, or NULL.
328  * @param notify Function to call to obtain the arguments.
329  * @param notify_cls Closure for @a notify.
330  * @param flags Flags for the message being transmitted.
331  * @return Transmission handle, NULL on error (i.e. more than one request queued).
332  */
333 struct GNUNET_PSYC_MasterTransmitHandle *
334 GNUNET_PSYC_master_transmit (struct GNUNET_PSYC_Master *master,
335                              const char *method_name,
336                              const struct GNUNET_ENV_Environment *env,
337                              GNUNET_PSYC_MasterReadyNotify notify,
338                              void *notify_cls,
339                              enum GNUNET_PSYC_TransmitFlags flags);
340
341
342 /** 
343  * Abort transmission request to channel.
344  *
345  * @param th Handle of the request that is being aborted.
346  */
347 void
348 GNUNET_PSYC_master_transmit_cancel (struct GNUNET_PSYC_MasterTransmitHandle *th);
349
350
351 /** 
352  * Stop a PSYC master channel.
353  *
354  * @param master PSYC channel master to stop.
355  */
356 void
357 GNUNET_PSYC_master_stop (struct GNUNET_PSYC_Master *master);
358
359
360 /** 
361  * Handle for a PSYC channel slave.
362  */
363 struct GNUNET_PSYC_Slave;
364
365
366 /** 
367  * Join a PSYC channel.
368  *
369  * The entity joining is always the local peer.  The user must immediately use
370  * the GNUNET_PSYC_slave_to_master() functions to transmit a @e join_msg to the
371  * channel; if the join request succeeds, the channel state (and @e recent
372  * method calls) will be replayed to the joining member.  There is no explicit
373  * notification on failure (as the channel may simply take days to approve,
374  * and disapproval is simply being ignored).
375  *
376  * @param cfg Configuration to use.
377  * @param channel_key ECC public key that identifies the channel we wish to join.
378  * @param slave_key ECC private-public key pair that identifies the slave, and
379  *        used by multicast to sign the join request and subsequent unicast
380  *        requests sent to the master.
381  * @param origin Peer identity of the origin.
382  * @param relay_count Number of peers in the @a relays array.
383  * @param relays Peer identities of members of the multicast group, which serve
384  *        as relays and used to join the group at.
385  * @param method Function to invoke on messages received from the channel,
386  *        typically at least contains functions for @e join and @e part.
387  * @param join_cb Function to invoke when a peer wants to join.
388  * @param cls Closure for @a method_cb and @a join_cb.
389  * @param method_name Method name for the join request.
390  * @param env Environment containing transient variables for the request, or NULL.
391  * @param data_size Number of bytes in @a data.
392  * @param data Payload for the join message.
393  * @return Handle for the slave, NULL on error.
394  */
395 struct GNUNET_PSYC_Slave *
396 GNUNET_PSYC_slave_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
397                         const struct GNUNET_CRYPTO_EccPublicKey *channel_key,
398                         const struct GNUNET_CRYPTO_EccPrivateKey *slave_key,
399                         const struct GNUNET_PeerIdentity *origin,
400                         size_t relay_count,
401                         const struct GNUNET_PeerIdentity *relays,
402                         GNUNET_PSYC_Method method,
403                         GNUNET_PSYC_JoinCallback join_cb,
404                         void *cls,
405                         const char *method_name,
406                         const struct GNUNET_ENV_Environment *env,
407                         size_t data_size,
408                         const void *data);
409
410
411 /** 
412  * Part a PSYC channel.
413  *
414  * Will terminate the connection to the PSYC service.  Polite clients should
415  * first explicitly send a @e part request (via GNUNET_PSYC_slave_to_master()).
416  *
417  * @param slave Slave handle.
418  */
419 void
420 GNUNET_PSYC_slave_part (struct GNUNET_PSYC_Slave *slave);
421
422
423 /** 
424  * Function called to provide data for a transmission to the channel
425  * master (aka the @e host of the channel).
426  *
427  * Note that returning #GNUNET_OK or #GNUNET_SYSERR (but not #GNUNET_NO)
428  * invalidates the respective transmission handle.
429  *
430  * @param cls Closure.
431  * @param[in,out] data_size Initially set to the number of bytes available in @a data,
432  *        should be set to the number of bytes written to data (IN/OUT).
433  * @param[out] data Where to write the body of the message to give to the method;
434  *        function must copy at most @a *data_size bytes to @a data.
435  * @return #GNUNET_SYSERR on error (fatal, aborts transmission).
436  *         #GNUNET_NO on success, if more data is to be transmitted later.
437  *         #GNUNET_YES if this completes the transmission (all data supplied).
438  */
439 typedef int
440 (*GNUNET_PSYC_SlaveReadyNotify) (void *cls,
441                                  size_t *data_size,
442                                  char *data);
443
444
445 /**
446  * Flags for transmitting messages to the channel master by a slave.
447  */
448 enum GNUNET_PSYC_SlaveTransmitFlags;
449
450 /** 
451  * Handle for a pending PSYC transmission operation.
452  */
453 struct GNUNET_PSYC_SlaveTransmitHandle;
454
455
456 /** 
457  * Request a message to be sent to the channel master.
458  *
459  * @param slave Slave handle.
460  * @param method_name Which (PSYC) method should be invoked (on host).
461  * @param env Environment containing transient variables for the message, or NULL.
462  * @param notify Function to call when we are allowed to transmit (to get data).
463  * @param notify_cls Closure for @a notify.
464  * @param flags Flags for the message being transmitted.
465  * @return Transmission handle, NULL on error (i.e. more than one request queued).
466  */
467 struct GNUNET_PSYC_SlaveTransmitHandle *
468 GNUNET_PSYC_slave_transmit (struct GNUNET_PSYC_Slave *slave,
469                             const char *method_name,
470                             const struct GNUNET_ENV_Environment *env,
471                             GNUNET_PSYC_SlaveReadyNotify notify,
472                             void *notify_cls,
473                             enum GNUNET_PSYC_SlaveTransmitFlags flags);
474
475
476 /** 
477  * Abort transmission request to master.
478  *
479  * @param th Handle of the request that is being aborted.
480  */
481 void
482 GNUNET_PSYC_slave_transmit_cancel (struct GNUNET_PSYC_SlaveTransmitHandle *th);
483
484
485 /** 
486  * Handle to access PSYC channel operations for both the master and slaves.
487  */
488 struct GNUNET_PSYC_Channel;
489
490
491 /** 
492  * Convert a channel @a master to a @e channel handle to access the @e channel APIs.
493  *
494  * @param master Channel master handle.
495  * @return Channel handle, valid for as long as @a master is valid.
496  */
497 struct GNUNET_PSYC_Channel *
498 GNUNET_PSYC_master_get_channel (struct GNUNET_PSYC_Master *master);
499
500
501 /** 
502  * Convert @a slave to a @e channel handle to access the @e channel APIs.
503  *
504  * @param slave Slave handle.
505  * @return Channel handle, valid for as long as @a slave is valid.
506  */
507 struct GNUNET_PSYC_Channel *
508 GNUNET_PSYC_slave_get_channel (struct GNUNET_PSYC_Slave *slave);
509
510
511 /** 
512  * Add a slave to the channel's membership list.
513  *
514  * Note that this will NOT generate any PSYC traffic, it will merely update the
515  * local database to modify how we react to <em>membership test</em> queries.
516  * The channel master still needs to explicitly transmit a @e join message to
517  * notify other channel members and they then also must still call this function
518  * in their respective methods handling the @e join message.  This way, how @e
519  * join and @e part operations are exactly implemented is still up to the
520  * application; for example, there might be a @e part_all method to kick out
521  * everyone.
522  *
523  * Note that channel slaves are explicitly trusted to execute such methods
524  * correctly; not doing so correctly will result in either denying other slaves
525  * access or offering access to channel data to non-members.
526  *
527  * @param channel Channel handle.
528  * @param slave_key Identity of channel slave to add.
529  * @param announced_at ID of the message that announced the membership change.
530  * @param effective_since Addition of slave is in effect since this message ID.
531  */
532 void
533 GNUNET_PSYC_channel_slave_add (struct GNUNET_PSYC_Channel *channel,
534                                const struct GNUNET_CRYPTO_EccPublicKey *slave_key,
535                                uint64_t announced_at,
536                                uint64_t effective_since);
537
538
539 /** 
540  * Remove a slave from the channel's membership list.
541  *
542  * Note that this will NOT generate any PSYC traffic, it will merely update the
543  * local database to modify how we react to <em>membership test</em> queries.
544  * The channel master still needs to explicitly transmit a @e part message to
545  * notify other channel members and they then also must still call this function
546  * in their respective methods handling the @e part message.  This way, how
547  * @e join and @e part operations are exactly implemented is still up to the
548  * application; for example, there might be a @e part_all message to kick out
549  * everyone.
550  *
551  * Note that channel members are explicitly trusted to perform these
552  * operations correctly; not doing so correctly will result in either
553  * denying members access or offering access to channel data to
554  * non-members.
555  *
556  * @param channel Channel handle.
557  * @param slave_key Identity of channel slave to remove.
558  * @param announced_at ID of the message that announced the membership change.
559  * @param effective_since Removal of slave is in effect since this message ID.
560  */
561 void
562 GNUNET_PSYC_channel_slave_remove (struct GNUNET_PSYC_Channel *channel,
563                                   const struct GNUNET_CRYPTO_EccPublicKey *slave_key,
564                                   uint64_t announced_at,
565                                   uint64_t effective_since);
566
567
568 /** 
569  * Function called to inform a member about stored state values for a channel.
570  *
571  * @param cls Closure.
572  * @param name Name of the state variable.  A NULL value indicates that there
573  *        are no more state variables to be returned.
574  * @param value_size Number of bytes in @a value.
575  * @param value Value of the state variable.
576  */
577 typedef void
578 (*GNUNET_PSYC_StateCallback) (void *cls,
579                               const char *name,
580                               size_t value_size,
581                               const void *value);
582
583
584 /**
585  * Function called when a requested operation has finished.
586  *
587  * @param cls Closure.
588  */
589 typedef void
590 (*GNUNET_PSYC_FinishCallback) (void *cls);
591
592
593 /** 
594  * Handle to a story telling operation.
595  */
596 struct GNUNET_PSYC_Story;
597
598
599 /** 
600  * Request to be told the message history of the channel.
601  *
602  * Historic messages (but NOT the state at the time) will be replayed (given to
603  * the normal method handlers) if available and if access is permitted.
604  *
605  * To get the latest message, use 0 for both the start and end message ID.
606  *
607  * @param channel Which channel should be replayed?
608  * @param start_message_id Earliest interesting point in history.
609  * @param end_message_id Last (exclusive) interesting point in history.
610  * @param method Function to invoke on messages received from the story.
611  * @param finish_cb Function to call when the requested story has been fully
612  *        told (counting message IDs might not suffice, as some messages
613  *        might be secret and thus the listener would not know the story is
614  *        finished without being told explicitly); once this function
615  *        has been called, the client must not call
616  *        GNUNET_PSYC_channel_story_tell_cancel() anymore.
617  * @param cls Closure for the callbacks.
618  * @return Handle to cancel story telling operation.
619  */
620 struct GNUNET_PSYC_Story *
621 GNUNET_PSYC_channel_story_tell (struct GNUNET_PSYC_Channel *channel,
622                                 uint64_t start_message_id,
623                                 uint64_t end_message_id,
624                                 GNUNET_PSYC_Method method,
625                                 GNUNET_PSYC_FinishCallback *finish_cb,
626                                 void *cls);
627
628
629 /** 
630  * Abort story telling.
631  *
632  * This function must not be called from within method handlers (as given to
633  * GNUNET_PSYC_slave_join()) of the slave.
634  *
635  * @param story Story telling operation to stop.
636  */
637 void
638 GNUNET_PSYC_channel_story_tell_cancel (struct GNUNET_PSYC_Story *story);
639
640 struct GNUNET_PSYC_StateQuery;
641
642
643 /** 
644  * Return all channel state variables whose name matches a given prefix.
645  *
646  * A name matches if it starts with the given @a name_prefix, thus requesting the
647  * empty prefix ("") will match all values; requesting "_a_b" will also return
648  * values stored under "_a_b_c".
649  *
650  * The @a state_cb is invoked on all matching state variables asynchronously, as
651  * the state is stored in and retrieved from the PSYCstore,
652  *
653  * @param channel Channel handle.
654  * @param name_prefix Prefix of the state variable name to match.
655  * @param cb Function to call with the matching state variables.
656  * @param cb_cls Closure for the callbacks.
657  * @return Handle that can be used to cancel the query operation.
658  */
659 struct GNUNET_PSYC_StateQuery *
660 GNUNET_PSYC_channel_state_get_all (struct GNUNET_PSYC_Channel *channel,
661                                    const char *name_prefix,
662                                    GNUNET_PSYC_StateCallback cb,
663                                    void *cb_cls);
664
665
666 /** 
667  * Retrieve the best matching channel state variable.
668  *
669  * If the requested variable name is not present in the state, the nearest
670  * less-specific name is matched; for example, requesting "_a_b" will match "_a"
671  * if "_a_b" does not exist.
672  *
673  * @param channel Channel handle.
674  * @param full_name Full name of the requested variable, the actual variable
675  *        returned might have a shorter name..
676  * @param cb Function called once when a matching state variable is found.
677  *        Not called if there's no matching state variable.
678  * @param cb_cls Closure for the callbacks.
679  * @return Handle that can be used to cancel the query operation.
680  */
681 struct GNUNET_PSYC_StateQuery *
682 GNUNET_PSYC_channel_state_get (struct GNUNET_PSYC_Channel *channel,
683                                const char *full_name,
684                                GNUNET_PSYC_StateCallback cb,
685                                void *cb_cls);
686
687
688 /** 
689  * Cancel a state query operation.
690  *
691  * @param query Handle for the operation to cancel.
692  */
693 void
694 GNUNET_PSYC_channel_state_get_cancel (struct GNUNET_PSYC_StateQuery *query);
695
696
697 #if 0                           /* keep Emacsens' auto-indent happy */
698 {
699 #endif
700 #ifdef __cplusplus
701 }
702 #endif
703
704 /* ifndef GNUNET_PSYC_SERVICE_H */
705 #endif
706 /* end of gnunet_psyc_service.h */