2 This file is part of GNUnet.
3 (C) 2012, 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_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
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 GNS
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 (GNS)
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'.
77 #ifndef GNUNET_PSYC_SERVICE_H
78 #define GNUNET_PSYC_SERVICE_H
83 #if 0 /* keep Emacsens' auto-indent happy */
88 #include "gnunet_util_lib.h"
89 #include "gnunet_env_lib.h"
90 #include "gnunet_multicast_service.h"
94 * Version number of GNUnet-PSYC API.
96 #define GNUNET_PSYC_VERSION 0x00000000
100 * Policy flags for a channel.
102 enum GNUNET_PSYC_ChannelFlags
105 * Admission must be confirmed by the master.
107 GNUNET_PSYC_CHANNEL_ADMISSION_CONTROL = 1 << 0,
110 * Past messages are only available to slaves who were admitted at the time
111 * they were sent to the channel.
113 GNUNET_PSYC_CHANNEL_RESTRICTED_HISTORY = 1 << 1
118 * PSYC channel policies.
120 enum GNUNET_PSYC_Policy
123 * Anyone can join the channel, without announcing his presence;
124 * all messages are always public and can be distributed freely.
125 * Joins may be announced, but this is not required.
127 GNUNET_PSYC_CHANNEL_ANONYMOUS = 0,
130 * The master must approve membership to the channel, messages must only be
131 * distributed to current channel slaves. This includes the channel
132 * state as well as transient messages.
134 GNUNET_PSYC_CHANNEL_PRIVATE
135 = GNUNET_PSYC_CHANNEL_ADMISSION_CONTROL
136 | GNUNET_PSYC_CHANNEL_RESTRICTED_HISTORY
140 * Anyone can freely join the channel (no approval required);
141 * however, messages must only be distributed to current channel
142 * slaves, so the master must still acknowledge that the slave
143 * joined before transient messages are delivered. As approval is
144 * guaranteed, the presistent channel state can be synchronized freely
145 * immediately, prior to master confirmation.
147 GNUNET_PSYC_CHANNEL_OPEN
148 = GNUNET_PSYC_CHANNEL_RESTRICTED_HISTORY,
151 * The master must approve joins to the channel, but past messages can be
152 * freely distributed to slaves.
154 GNUNET_PSYC_CHANNEL_CLOSED
155 = GNUNET_PSYC_CHANNEL_ADMISSION_CONTROL,
160 enum GNUNET_PSYC_MessageFlags
163 * Historic message, retrieved from PSYCstore.
165 GNUNET_PSYC_MESSAGE_HISTORIC = 1 << 0,
168 * Request from slave to master.
170 GNUNET_PSYC_MESSAGE_REQUEST = 1 << 1,
173 * Message can be delivered out of order.
175 GNUNET_PSYC_MESSAGE_ORDER_ANY = 1 << 2
180 * Values for the @a state_delta field of GNUNET_PSYC_MessageHeader.
182 enum GNUNET_PSYC_StateDeltaValues
184 GNUNET_PSYC_STATE_RESET = 0,
186 GNUNET_PSYC_STATE_NOT_MODIFIED = UINT64_MAX
190 GNUNET_NETWORK_STRUCT_BEGIN
193 * Header of a PSYC message.
195 * Only present when receiving a message.
197 struct GNUNET_PSYC_MessageHeader
200 * Generic message header with size and type information.
202 struct GNUNET_MessageHeader header;
205 * Flags for this message fragment.
207 * @see enum GNUNET_PSYC_MessageFlags
209 uint32_t flags GNUNET_PACKED;
212 * Number of the message this message part belongs to.
213 * Monotonically increasing from 1.
215 uint64_t message_id GNUNET_PACKED;
218 * Sending slave's public key.
219 * Not set if the message is from the master.
221 struct GNUNET_CRYPTO_EddsaPublicKey slave_key;
223 /* Followed by concatenated PSYC message parts:
224 * messages with GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_* types
230 * The method of a message.
232 struct GNUNET_PSYC_MessageMethod
235 * Type: GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD
237 struct GNUNET_MessageHeader header;
240 * OR'ed GNUNET_PSYC_MasterTransmitFlags
242 uint32_t flags GNUNET_PACKED;
245 * Number of message IDs since the last message that contained state
246 * operations. @see enum GNUNET_PSYC_StateDeltaValues
248 uint64_t state_delta GNUNET_PACKED;
250 /* Followed by NUL-terminated method name. */
255 * A modifier of a message.
257 struct GNUNET_PSYC_MessageModifier
260 * Type: GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER
262 struct GNUNET_MessageHeader header;
267 uint32_t value_size GNUNET_PACKED;
270 * Size of name, including NUL terminator.
272 uint16_t name_size GNUNET_PACKED;
275 * enum GNUNET_ENV_Operator
279 /* Followed by NUL-terminated name, then the value. */
282 GNUNET_NETWORK_STRUCT_END
285 #define GNUNET_PSYC_MODIFIER_MAX_PAYLOAD \
286 GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD \
287 - sizeof (struct GNUNET_PSYC_MessageModifier)
289 #define GNUNET_PSYC_MOD_CONT_MAX_PAYLOAD \
290 GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD \
291 - sizeof (struct GNUNET_MessageHeader)
293 #define GNUNET_PSYC_DATA_MAX_PAYLOAD \
294 GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD \
295 - sizeof (struct GNUNET_MessageHeader)
299 * Handle that identifies a join request.
301 * Used to match calls to #GNUNET_PSYC_JoinCallback to the
302 * corresponding calls to GNUNET_PSYC_join_decision().
304 struct GNUNET_PSYC_JoinHandle;
308 * Method called from PSYC upon receiving part of a message.
310 * @param cls Closure.
311 * @param message_id Sequence number of the message.
312 * @param flags OR'ed GNUNET_PSYC_MessageFlags
313 * @param msg Message part, one of the following types:
314 * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_HEADER
315 * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD
316 * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER
317 * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MOD_CONT
318 * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA
321 (*GNUNET_PSYC_MessageCallback) (void *cls,
324 const struct GNUNET_MessageHeader *msg);
328 * Method called from PSYC upon receiving a join request.
330 * @param cls Closure.
331 * @param slave_key Public key of the slave requesting join.
332 * @param join_msg Join message sent along with the request.
333 * @param jh Join handle to use with GNUNET_PSYC_join_decision()
336 (*GNUNET_PSYC_JoinRequestCallback) (void *cls,
338 GNUNET_CRYPTO_EddsaPublicKey *slave_key,
340 GNUNET_PSYC_MessageHeader *join_msg,
341 struct GNUNET_PSYC_JoinHandle *jh);
345 * Function to call with the decision made for a join request.
347 * Must be called once and only once in response to an invocation of the
348 * #GNUNET_PSYC_JoinCallback.
350 * @param jh Join request handle.
351 * @param is_admitted #GNUNET_YES if the join is approved,
352 * #GNUNET_NO if it is disapproved,
353 * #GNUNET_SYSERR if we cannot answer the request.
354 * @param relay_count Number of relays given.
355 * @param relays Array of suggested peers that might be useful relays to use
356 * when joining the multicast group (essentially a list of peers that
357 * are already part of the multicast group and might thus be willing
358 * to help with routing). If empty, only this local peer (which must
359 * be the multicast origin) is a good candidate for building the
360 * multicast tree. Note that it is unnecessary to specify our own
361 * peer identity in this array.
362 * @param join_resp Application-dependent join response message to send along
365 * @return #GNUNET_OK on success,
366 * #GNUNET_SYSERR if @a join_resp is too large.
369 GNUNET_PSYC_join_decision (struct GNUNET_PSYC_JoinHandle *jh,
371 uint32_t relay_count,
372 const struct GNUNET_PeerIdentity *relays,
373 const struct GNUNET_PSYC_MessageHeader *join_resp);
377 * Handle for the master of a PSYC channel.
379 struct GNUNET_PSYC_Master;
383 * Function called after the channel master started.
385 * @param cls Closure.
386 * @param max_message_id Last message ID sent to the channel.
389 (*GNUNET_PSYC_MasterStartCallback) (void *cls, uint64_t max_message_id);
393 * Start a PSYC master channel.
395 * Will start a multicast group identified by the given ECC key. Messages
396 * received from group members will be given to the respective handler methods.
397 * If a new member wants to join a group, the "join" method handler will be
398 * invoked; the join handler must then generate a "join" message to approve the
399 * joining of the new member. The channel can also change group membership
400 * without explicit requests. Note that PSYC doesn't itself "understand" join
401 * or part messages, the respective methods must call other PSYC functions to
402 * inform PSYC about the meaning of the respective events.
404 * @param cfg Configuration to use (to connect to PSYC service).
405 * @param channel_key ECC key that will be used to sign messages for this
406 * PSYC session. The public key is used to identify the PSYC channel.
407 * Note that end-users will usually not use the private key directly, but
408 * rather look it up in GNS for places managed by other users, or select
409 * a file with the private key(s) when setting up their own channels
410 * FIXME: we'll likely want to use NOT the p521 curve here, but a cheaper
412 * @param policy Channel policy specifying join and history restrictions.
413 * Used to automate join decisions.
414 * @param master_start_cb Function to invoke after the channel master started.
415 * @param join_request_cb Function to invoke when a slave wants to join.
416 * @param message_cb Function to invoke on message parts sent to the channel
417 * and received from slaves
418 * @param cls Closure for @a method and @a join_cb.
420 * @return Handle for the channel master, NULL on error.
422 struct GNUNET_PSYC_Master *
423 GNUNET_PSYC_master_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
424 const struct GNUNET_CRYPTO_EddsaPrivateKey *channel_key,
425 enum GNUNET_PSYC_Policy policy,
426 GNUNET_PSYC_MasterStartCallback master_start_cb,
427 GNUNET_PSYC_JoinRequestCallback join_request_cb,
428 GNUNET_PSYC_MessageCallback message_cb,
433 * Function called to provide data for a transmission via PSYC.
435 * Note that returning #GNUNET_YES or #GNUNET_SYSERR (but not #GNUNET_NO)
436 * invalidates the respective transmission handle.
438 * @param cls Closure.
439 * @param[in,out] data_size Initially set to the number of bytes available in
440 * @a data, should be set to the number of bytes written to data.
441 * @param[out] data Where to write the body of the message to give to the
442 * method. The function must copy at most @a data_size bytes to @a data.
443 * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
444 * #GNUNET_NO on success, if more data is to be transmitted later.
445 * Should be used if @a data_size was not big enough to take all the
446 * data. If 0 is returned in @a data_size the transmission is paused,
447 * and can be resumed with GNUNET_PSYC_master_transmit_resume().
448 * #GNUNET_YES if this completes the transmission (all data supplied)
451 (*GNUNET_PSYC_TransmitNotifyData) (void *cls,
456 * Function called to provide a modifier for a transmission via PSYC.
458 * Note that returning #GNUNET_YES or #GNUNET_SYSERR (but not #GNUNET_NO)
459 * invalidates the respective transmission handle.
461 * @param cls Closure.
462 * @param[in,out] data_size Initially set to the number of bytes available in
463 * @a data, should be set to the number of bytes written to data.
464 * @param[out] data Where to write the modifier's name and value.
465 * The function must copy at most @a data_size bytes to @a data.
466 * When this callback is first called for a modifier, @a data should
467 * contain: "name\0value". If the whole value does not fit, subsequent
468 * calls to this function should write continuations of the value to
470 * @param[out] oper Where to write the operator of the modifier.
471 * Only needed during the first call to this callback at the beginning
472 * of the modifier. In case of subsequent calls asking for value
473 * continuations @a oper is set to #NULL.
474 * @param[out] full_value_size Where to write the full size of the value.
475 * Only needed during the first call to this callback at the beginning
476 * of the modifier. In case of subsequent calls asking for value
477 * continuations @a value_size is set to #NULL.
478 * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
479 * #GNUNET_NO on success, if more data is to be transmitted later.
480 * Should be used if @a data_size was not big enough to take all the
481 * data for the modifier's value (the name must be always returned
482 * during the first call to this callback).
483 * If 0 is returned in @a data_size the transmission is paused,
484 * and can be resumed with GNUNET_PSYC_master_transmit_resume().
485 * #GNUNET_YES if this completes the modifier (the whole value is supplied).
488 (*GNUNET_PSYC_TransmitNotifyModifier) (void *cls,
492 uint32_t *full_value_size);
495 * Flags for transmitting messages to a channel by the master.
497 enum GNUNET_PSYC_MasterTransmitFlags
499 GNUNET_PSYC_MASTER_TRANSMIT_NONE = 0,
502 * Whether this message should reset the channel state,
503 * i.e. remove all previously stored state variables.
506 GNUNET_PSYC_MASTER_TRANSMIT_STATE_RESET = 1 << 0,
509 * Whether this message contains any state modifiers.
511 GNUNET_PSYC_MASTER_TRANSMIT_STATE_MODIFY = 1 << 1,
514 * Add PSYC header variable with the hash of the current channel state.
516 GNUNET_PSYC_MASTER_TRANSMIT_STATE_HASH = 1 << 2,
519 * Whether we need to increment the group generation counter after
520 * transmitting this message.
522 GNUNET_PSYC_MASTER_TRANSMIT_INC_GROUP_GEN = 1 << 3
527 * Handle for a pending PSYC transmission operation.
529 struct GNUNET_PSYC_MasterTransmitHandle;
533 * Send a message to call a method to all members in the PSYC channel.
535 * @param master Handle to the PSYC channel.
536 * @param method_name Which method should be invoked.
537 * @param notify_mod Function to call to obtain modifiers.
538 * @param notify_data Function to call to obtain fragments of the data.
539 * @param notify_cls Closure for @a notify_mod and @a notify_data.
540 * @param flags Flags for the message being transmitted.
541 * @return Transmission handle, NULL on error (i.e. more than one request queued).
543 struct GNUNET_PSYC_MasterTransmitHandle *
544 GNUNET_PSYC_master_transmit (struct GNUNET_PSYC_Master *master,
545 const char *method_name,
546 GNUNET_PSYC_TransmitNotifyModifier notify_mod,
547 GNUNET_PSYC_TransmitNotifyData notify_data,
549 enum GNUNET_PSYC_MasterTransmitFlags flags);
553 * Resume transmission to the channel.
555 * @param th Handle of the request that is being resumed.
558 GNUNET_PSYC_master_transmit_resume (struct GNUNET_PSYC_MasterTransmitHandle *th);
562 * Abort transmission request to channel.
564 * @param th Handle of the request that is being aborted.
567 GNUNET_PSYC_master_transmit_cancel (struct GNUNET_PSYC_MasterTransmitHandle *th);
571 * Stop a PSYC master channel.
573 * @param master PSYC channel master to stop.
576 GNUNET_PSYC_master_stop (struct GNUNET_PSYC_Master *master);
580 * Handle for a PSYC channel slave.
582 struct GNUNET_PSYC_Slave;
586 * Function called after the slave connected to the PSYC service.
588 * @param cls Closure.
589 * @param max_message_id Last message ID sent to the channel.
592 (*GNUNET_PSYC_SlaveConnectCallback) (void *cls, uint64_t max_message_id);
596 * Method called to inform about the decision in response to a join request.
598 * If @a is_admitted is not #GNUNET_YES, then sending messages to the channel is
599 * not possible, but earlier history can be still queried.
601 * @param cls Closure.
602 * @param is_admitted #GNUNET_YES or #GNUNET_NO or #GNUNET_SYSERR
603 * @param join_msg Application-dependent join message from the origin.
606 (*GNUNET_PSYC_JoinDecisionCallback) (void *cls,
609 GNUNET_PSYC_MessageHeader *join_msg);
613 * Join a PSYC channel.
615 * The entity joining is always the local peer. The user must immediately use
616 * the GNUNET_PSYC_slave_transmit() functions to transmit a @e join_msg to the
617 * channel; if the join request succeeds, the channel state (and @e recent
618 * method calls) will be replayed to the joining member. There is no explicit
619 * notification on failure (as the channel may simply take days to approve,
620 * and disapproval is simply being ignored).
622 * @param cfg Configuration to use.
623 * @param channel_key ECC public key that identifies the channel we wish to join.
624 * @param slave_key ECC private-public key pair that identifies the slave, and
625 * used by multicast to sign the join request and subsequent unicast
626 * requests sent to the master.
627 * @param origin Peer identity of the origin.
628 * @param relay_count Number of peers in the @a relays array.
629 * @param relays Peer identities of members of the multicast group, which serve
630 * as relays and used to join the group at.
631 * @param message_cb Function to invoke on message parts received from the
632 * channel, typically at least contains method handlers for @e join and
634 * @param slave_connect_cb Function invoked once we have connected to the
636 * @param join_decision_cb Function invoked once we have received a join
638 * @param cls Closure for @a message_cb and @a slave_joined_cb.
639 * @param method_name Method name for the join request.
640 * @param env Environment containing transient variables for the request, or NULL.
641 * @param data Payload for the join message.
642 * @param data_size Number of bytes in @a data.
644 * @return Handle for the slave, NULL on error.
646 struct GNUNET_PSYC_Slave *
647 GNUNET_PSYC_slave_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
648 const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
649 const struct GNUNET_CRYPTO_EddsaPrivateKey *slave_key,
650 const struct GNUNET_PeerIdentity *origin,
651 uint32_t relay_count,
652 const struct GNUNET_PeerIdentity *relays,
653 GNUNET_PSYC_MessageCallback message_cb,
654 GNUNET_PSYC_SlaveConnectCallback slave_connect_cb,
655 GNUNET_PSYC_JoinDecisionCallback join_decision_cb,
657 const char *method_name,
658 const struct GNUNET_ENV_Environment *env,
664 * Part a PSYC channel.
666 * Will terminate the connection to the PSYC service. Polite clients should
667 * first explicitly send a part request (via GNUNET_PSYC_slave_transmit()).
669 * @param slave Slave handle.
672 GNUNET_PSYC_slave_part (struct GNUNET_PSYC_Slave *slave);
676 * Flags for transmitting messages to the channel master by a slave.
678 enum GNUNET_PSYC_SlaveTransmitFlags
680 GNUNET_PSYC_SLAVE_TRANSMIT_NONE = 0
685 * Handle for a pending PSYC transmission operation.
687 struct GNUNET_PSYC_SlaveTransmitHandle;
691 * Request a message to be sent to the channel master.
693 * @param slave Slave handle.
694 * @param method_name Which (PSYC) method should be invoked (on host).
695 * @param notify_mod Function to call to obtain modifiers.
696 * @param notify_data Function to call to obtain fragments of the data.
697 * @param notify_cls Closure for @a notify.
698 * @param flags Flags for the message being transmitted.
699 * @return Transmission handle, NULL on error (i.e. more than one request queued).
701 struct GNUNET_PSYC_SlaveTransmitHandle *
702 GNUNET_PSYC_slave_transmit (struct GNUNET_PSYC_Slave *slave,
703 const char *method_name,
704 GNUNET_PSYC_TransmitNotifyModifier notify_mod,
705 GNUNET_PSYC_TransmitNotifyData notify_data,
707 enum GNUNET_PSYC_SlaveTransmitFlags flags);
711 * Resume transmission to the master.
713 * @param th Handle of the request that is being resumed.
716 GNUNET_PSYC_slave_transmit_resume (struct GNUNET_PSYC_SlaveTransmitHandle *th);
720 * Abort transmission request to master.
722 * @param th Handle of the request that is being aborted.
725 GNUNET_PSYC_slave_transmit_cancel (struct GNUNET_PSYC_SlaveTransmitHandle *th);
729 * Handle to access PSYC channel operations for both the master and slaves.
731 struct GNUNET_PSYC_Channel;
735 * Convert a channel @a master to a @e channel handle to access the @e channel
738 * @param master Channel master handle.
739 * @return Channel handle, valid for as long as @a master is valid.
741 struct GNUNET_PSYC_Channel *
742 GNUNET_PSYC_master_get_channel (struct GNUNET_PSYC_Master *master);
746 * Convert @a slave to a @e channel handle to access the @e channel APIs.
748 * @param slave Slave handle.
749 * @return Channel handle, valid for as long as @a slave is valid.
751 struct GNUNET_PSYC_Channel *
752 GNUNET_PSYC_slave_get_channel (struct GNUNET_PSYC_Slave *slave);
756 * Add a slave to the channel's membership list.
758 * Note that this will NOT generate any PSYC traffic, it will merely update the
759 * local database to modify how we react to <em>membership test</em> queries.
760 * The channel master still needs to explicitly transmit a @e join message to
761 * notify other channel members and they then also must still call this function
762 * in their respective methods handling the @e join message. This way, how @e
763 * join and @e part operations are exactly implemented is still up to the
764 * application; for example, there might be a @e part_all method to kick out
767 * Note that channel slaves are explicitly trusted to execute such methods
768 * correctly; not doing so correctly will result in either denying other slaves
769 * access or offering access to channel data to non-members.
771 * @param channel Channel handle.
772 * @param slave_key Identity of channel slave to add.
773 * @param announced_at ID of the message that announced the membership change.
774 * @param effective_since Addition of slave is in effect since this message ID.
777 GNUNET_PSYC_channel_slave_add (struct GNUNET_PSYC_Channel *channel,
778 const struct GNUNET_CRYPTO_EddsaPublicKey *slave_key,
779 uint64_t announced_at,
780 uint64_t effective_since);
784 * Remove a slave from the channel's membership list.
786 * Note that this will NOT generate any PSYC traffic, it will merely update the
787 * local database to modify how we react to <em>membership test</em> queries.
788 * The channel master still needs to explicitly transmit a @e part message to
789 * notify other channel members and they then also must still call this function
790 * in their respective methods handling the @e part message. This way, how
791 * @e join and @e part operations are exactly implemented is still up to the
792 * application; for example, there might be a @e part_all message to kick out
795 * Note that channel members are explicitly trusted to perform these
796 * operations correctly; not doing so correctly will result in either
797 * denying members access or offering access to channel data to
800 * @param channel Channel handle.
801 * @param slave_key Identity of channel slave to remove.
802 * @param announced_at ID of the message that announced the membership change.
805 GNUNET_PSYC_channel_slave_remove (struct GNUNET_PSYC_Channel *channel,
806 const struct GNUNET_CRYPTO_EddsaPublicKey
808 uint64_t announced_at);
812 * Function called to inform a member about stored state values for a channel.
814 * @param cls Closure.
815 * @param name Name of the state variable. A NULL value indicates that there
816 * are no more state variables to be returned.
817 * @param value Value of the state variable.
818 * @param value_size Number of bytes in @a value.
821 (*GNUNET_PSYC_StateCallback) (void *cls,
828 * Function called when a requested operation has finished.
830 * @param cls Closure.
833 (*GNUNET_PSYC_FinishCallback) (void *cls);
837 * Handle to a story telling operation.
839 struct GNUNET_PSYC_Story;
843 * Request to be told the message history of the channel.
845 * Historic messages (but NOT the state at the time) will be replayed (given to
846 * the normal method handlers) if available and if access is permitted.
848 * To get the latest message, use 0 for both the start and end message ID.
850 * @param channel Which channel should be replayed?
851 * @param start_message_id Earliest interesting point in history.
852 * @param end_message_id Last (exclusive) interesting point in history.
853 * @param message_cb Function to invoke on message parts received from the story.
854 * @param finish_cb Function to call when the requested story has been fully
855 * told (counting message IDs might not suffice, as some messages
856 * might be secret and thus the listener would not know the story is
857 * finished without being told explicitly); once this function
858 * has been called, the client must not call
859 * GNUNET_PSYC_channel_story_tell_cancel() anymore.
860 * @param cls Closure for the callbacks.
861 * @return Handle to cancel story telling operation.
863 struct GNUNET_PSYC_Story *
864 GNUNET_PSYC_channel_story_tell (struct GNUNET_PSYC_Channel *channel,
865 uint64_t start_message_id,
866 uint64_t end_message_id,
867 GNUNET_PSYC_MessageCallback message_cb,
868 GNUNET_PSYC_FinishCallback finish_cb,
873 * Abort story telling.
875 * This function must not be called from within method handlers (as given to
876 * GNUNET_PSYC_slave_join()) of the slave.
878 * @param story Story telling operation to stop.
881 GNUNET_PSYC_channel_story_tell_cancel (struct GNUNET_PSYC_Story *story);
885 * Handle for a state query operation.
887 struct GNUNET_PSYC_StateQuery;
891 * Retrieve the best matching channel state variable.
893 * If the requested variable name is not present in the state, the nearest
894 * less-specific name is matched; for example, requesting "_a_b" will match "_a"
895 * if "_a_b" does not exist.
897 * @param channel Channel handle.
898 * @param full_name Full name of the requested variable, the actual variable
899 * returned might have a shorter name..
900 * @param cb Function called once when a matching state variable is found.
901 * Not called if there's no matching state variable.
902 * @param cb_cls Closure for the callbacks.
903 * @return Handle that can be used to cancel the query operation.
905 struct GNUNET_PSYC_StateQuery *
906 GNUNET_PSYC_channel_state_get (struct GNUNET_PSYC_Channel *channel,
907 const char *full_name,
908 GNUNET_PSYC_StateCallback cb,
913 * Return all channel state variables whose name matches a given prefix.
915 * A name matches if it starts with the given @a name_prefix, thus requesting
916 * the empty prefix ("") will match all values; requesting "_a_b" will also
917 * return values stored under "_a_b_c".
919 * The @a state_cb is invoked on all matching state variables asynchronously, as
920 * the state is stored in and retrieved from the PSYCstore,
922 * @param channel Channel handle.
923 * @param name_prefix Prefix of the state variable name to match.
924 * @param cb Function to call with the matching state variables.
925 * @param cb_cls Closure for the callbacks.
926 * @return Handle that can be used to cancel the query operation.
928 struct GNUNET_PSYC_StateQuery *
929 GNUNET_PSYC_channel_state_get_prefix (struct GNUNET_PSYC_Channel *channel,
930 const char *name_prefix,
931 GNUNET_PSYC_StateCallback cb,
936 * Cancel a state query operation.
938 * @param query Handle for the operation to cancel.
941 GNUNET_PSYC_channel_state_get_cancel (struct GNUNET_PSYC_StateQuery *query);
944 #if 0 /* keep Emacsens' auto-indent happy */
951 /* ifndef GNUNET_PSYC_SERVICE_H */
953 /* end of gnunet_psyc_service.h */