2 This file is part of GNUnet.
3 Copyright (C) 2012, 2013 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @author Gabor X Toth
23 * @author Christian Grothoff
28 * @defgroup psyc PSYC service
29 * Send/receive messages in PSYC channels and access the PSYC Store.
31 * Note that clients of this API are NOT expected to understand the PSYC message
32 * format, only the semantics! Parsing (and serializing) the PSYC stream format
33 * is done within the implementation of the libgnunetpsyc library, and this API
34 * deliberately exposes as little as possible of the actual data stream format
38 * - this API does not know about PSYC's "root" and "places";
39 * there is no 'root' in GNUnet-PSYC as we're decentralized;
40 * 'places' and 'persons' are combined within the same
41 * abstraction, that of a "channel". Channels are identified
42 * and accessed in this API using a public/private key.
43 * Higher-level applications should use NAMES within GNS
44 * to obtain public keys, and the distinction between
45 * 'places' and 'persons' can then be made with the help
46 * of the naming system (and/or conventions).
47 * Channels are (as in PSYC) organized into a hierarchy; each
48 * channel master (the one with the private key) is then
49 * the operator of the multicast group (its Origin in
50 * the terminology of the multicast API).
51 * - The API supports passing large amounts of data using
52 * 'streaming' for the argument passed to a method. State
53 * and variables must fit into memory and cannot be streamed
54 * (thus, no passing of 4 GB of data in a variable;
55 * once we implement this, we might want to create a
56 * @c \#define for the maximum size of a variable).
57 * - PSYC defines standard variables, methods, etc. This
58 * library deliberately abstracts over all of these; a
59 * higher-level API should combine the naming system (GNS)
60 * and standard methods (message, join, part, warn,
61 * fail, error) and variables (action, color, time,
62 * tag, etc.). However, this API does take over the
63 * routing variables, specifically 'context' (channel),
64 * and 'source'. We only kind-of support 'target', as
65 * the target is either everyone in the group or the
66 * origin, and never just a single member of the group;
67 * for such individual messages, an application needs to
68 * construct an 'inbox' channel where the master (only)
69 * receives messages (but never forwards; private responses
70 * would be transmitted by joining the senders 'inbox'
71 * channel -- or a inbox#bob subchannel). The
72 * goal for all of this is to keep the abstractions in this
73 * API minimal: interaction with multicast, try \& slice,
74 * state/variable/channel management. Higher-level
75 * operations belong elsewhere (so maybe this API should
76 * be called 'PSYC-low', whereas a higher-level API
77 * implementing defaults for standard methods and
78 * variables might be called 'PSYC-std' or 'PSYC-high'.
83 #ifndef GNUNET_PSYC_SERVICE_H
84 #define GNUNET_PSYC_SERVICE_H
89 #if 0 /* keep Emacsens' auto-indent happy */
94 #include "gnunet_util_lib.h"
95 #include "gnunet_multicast_service.h"
99 # define UINT64_MAX 0xffffffffffffffffULL
104 * Version number of GNUnet-PSYC API.
106 #define GNUNET_PSYC_VERSION 0x00000000
110 * Policy flags for a channel.
112 enum GNUNET_PSYC_ChannelFlags
115 * Admission must be confirmed by the master.
117 GNUNET_PSYC_CHANNEL_ADMISSION_CONTROL = 1 << 0,
120 * Past messages are only available to slaves who were admitted at the time
121 * they were sent to the channel.
123 GNUNET_PSYC_CHANNEL_RESTRICTED_HISTORY = 1 << 1
128 * PSYC channel policies.
130 enum GNUNET_PSYC_Policy
133 * Anyone can join the channel, without announcing his presence;
134 * all messages are always public and can be distributed freely.
135 * Joins may be announced, but this is not required.
137 GNUNET_PSYC_CHANNEL_ANONYMOUS = 0,
140 * The master must approve membership to the channel, messages must only be
141 * distributed to current channel slaves. This includes the channel
142 * state as well as transient messages.
144 GNUNET_PSYC_CHANNEL_PRIVATE
145 = GNUNET_PSYC_CHANNEL_ADMISSION_CONTROL
146 | GNUNET_PSYC_CHANNEL_RESTRICTED_HISTORY
150 * Anyone can freely join the channel (no approval required);
151 * however, messages must only be distributed to current channel
152 * slaves, so the master must still acknowledge that the slave
153 * joined before transient messages are delivered. As approval is
154 * guaranteed, the presistent channel state can be synchronized freely
155 * immediately, prior to master confirmation.
157 GNUNET_PSYC_CHANNEL_OPEN
158 = GNUNET_PSYC_CHANNEL_RESTRICTED_HISTORY,
161 * The master must approve joins to the channel, but past messages can be
162 * freely distributed to slaves.
164 GNUNET_PSYC_CHANNEL_CLOSED
165 = GNUNET_PSYC_CHANNEL_ADMISSION_CONTROL,
170 enum GNUNET_PSYC_MessageFlags
173 * Default / no flags.
175 GNUNET_PSYC_MESSAGE_DEFAULT = 0,
178 * Historic message, retrieved from PSYCstore.
180 GNUNET_PSYC_MESSAGE_HISTORIC = 1 << 0,
183 * Request from slave to master.
185 GNUNET_PSYC_MESSAGE_REQUEST = 1 << 1,
188 * Message can be delivered out of order.
190 GNUNET_PSYC_MESSAGE_ORDER_ANY = 1 << 2
195 * Values for the @a state_delta field of GNUNET_PSYC_MessageHeader.
197 enum GNUNET_PSYC_StateDeltaValues
199 GNUNET_PSYC_STATE_RESET = 0,
201 GNUNET_PSYC_STATE_NOT_MODIFIED = UINT64_MAX
205 GNUNET_NETWORK_STRUCT_BEGIN
210 * Used for single-fragment messages e.g. in a join request or response.
212 struct GNUNET_PSYC_Message
215 * Message header with size and type information.
217 struct GNUNET_MessageHeader header;
219 /* Followed by concatenated PSYC message parts:
220 * messages with GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_* types
226 * Header of a PSYC message.
228 * The PSYC service adds this when delivering the message to local clients,
229 * not present on the multicast layer.
231 struct GNUNET_PSYC_MessageHeader
234 * Generic message header with size and type information.
236 struct GNUNET_MessageHeader header;
239 * Flags for this message fragment.
241 * @see enum GNUNET_PSYC_MessageFlags
243 uint32_t flags GNUNET_PACKED;
246 * Number of the message this message part belongs to.
247 * Monotonically increasing from 1.
249 uint64_t message_id GNUNET_PACKED;
252 * Byte offset of this @e fragment of the @e message.
254 uint64_t fragment_offset GNUNET_PACKED;
257 * Sending slave's public key.
258 * Not set if the message is from the master.
260 struct GNUNET_CRYPTO_EcdsaPublicKey slave_pub_key;
262 /* Followed by concatenated PSYC message parts:
263 * messages with GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_* types
269 * The method of a message.
271 struct GNUNET_PSYC_MessageMethod
274 * Type: GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD
276 struct GNUNET_MessageHeader header;
279 * OR'ed GNUNET_PSYC_MasterTransmitFlags
281 uint32_t flags GNUNET_PACKED;
284 * Number of message IDs since the last message that contained state
285 * operations. @see enum GNUNET_PSYC_StateDeltaValues
287 uint64_t state_delta GNUNET_PACKED;
289 /* Followed by NUL-terminated method name. */
294 * A modifier of a message.
296 struct GNUNET_PSYC_MessageModifier
299 * Type: GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER
301 struct GNUNET_MessageHeader header;
306 uint32_t value_size GNUNET_PACKED;
309 * Size of name, including NUL terminator.
311 uint16_t name_size GNUNET_PACKED;
314 * enum GNUNET_ENV_Operator
318 /* Followed by NUL-terminated name, then the value. */
322 struct GNUNET_PSYC_CountersResultMessage
325 * Type: GNUNET_MESSAGE_TYPE_PSYC_RESULT_COUNTERS
327 struct GNUNET_MessageHeader header;
330 * Status code for the operation.
332 uint32_t result_code GNUNET_PACKED;
335 * Last message ID sent to the channel.
337 uint64_t max_message_id GNUNET_PACKED;
342 * Join request sent to a PSYC master.
344 struct GNUNET_PSYC_JoinRequestMessage
347 * Type: GNUNET_MESSAGE_TYPE_PSYC_MASTER_JOIN_REQUEST
349 struct GNUNET_MessageHeader header;
351 * Public key of the joining slave.
353 struct GNUNET_CRYPTO_EcdsaPublicKey slave_pub_key;
355 /* Followed by struct GNUNET_MessageHeader join_request */
360 * Join decision sent in reply to a join request.
362 struct GNUNET_PSYC_JoinDecisionMessage
365 * Type: GNUNET_MESSAGE_TYPE_PSYC_JOIN_DECISION
367 struct GNUNET_MessageHeader header;
370 * #GNUNET_YES if the slave was admitted.
375 * Public key of the joining slave.
376 * Only set when the master is sending the decision,
377 * not set when a slave is receiving it.
379 struct GNUNET_CRYPTO_EcdsaPublicKey slave_pub_key;
381 /* Followed by struct GNUNET_MessageHeader join_response */
385 enum GNUNET_PSYC_HistoryReplayFlags
388 * Replay locally available messages.
390 GNUNET_PSYC_HISTORY_REPLAY_LOCAL = 0,
393 * Replay messages from remote peers if not found locally.
395 GNUNET_PSYC_HISTORY_REPLAY_REMOTE = 1,
399 struct GNUNET_PSYC_HistoryRequestMessage
402 * Type: GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_HISTORY_REPLAY
404 struct GNUNET_MessageHeader header;
407 * @see enum GNUNET_PSYC_HistoryReplayFlags
409 uint32_t flags GNUNET_PACKED;
412 * ID for this operation.
414 uint64_t op_id GNUNET_PACKED;
416 uint64_t start_message_id GNUNET_PACKED;
418 uint64_t end_message_id GNUNET_PACKED;
420 uint64_t message_limit GNUNET_PACKED;
422 /* Followed by NUL-terminated method name prefix. */
426 struct GNUNET_PSYC_StateRequestMessage
430 * - GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_STATE_GET
431 * - GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_STATE_GET_PREFIX
433 struct GNUNET_MessageHeader header;
435 uint32_t reserved GNUNET_PACKED;
438 * ID for this operation.
440 uint64_t op_id GNUNET_PACKED;
442 /* Followed by NUL-terminated name. */
446 /**** service -> library ****/
450 * Answer from service to client about last operation.
452 struct GNUNET_PSYC_OperationResultMessage
456 * - GNUNET_MESSAGE_TYPE_PSYC_RESULT_CODE
457 * - GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_STATE_RESULT
459 struct GNUNET_MessageHeader header;
461 uint32_t reserved GNUNET_PACKED;
466 uint64_t op_id GNUNET_PACKED;
469 * Status code for the operation.
471 uint64_t result_code GNUNET_PACKED;
474 * - on error: NUL-terminated error message
475 * - on success: one of the following message types
477 * For a STATE_RESULT, one of:
478 * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER
479 * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MOD_CONT
480 * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_END
484 GNUNET_NETWORK_STRUCT_END
487 #define GNUNET_PSYC_MODIFIER_MAX_PAYLOAD \
488 GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD \
489 - sizeof (struct GNUNET_PSYC_MessageModifier)
491 #define GNUNET_PSYC_MOD_CONT_MAX_PAYLOAD \
492 GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD \
493 - sizeof (struct GNUNET_MessageHeader)
495 #define GNUNET_PSYC_DATA_MAX_PAYLOAD \
496 GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD \
497 - sizeof (struct GNUNET_MessageHeader)
501 * PSYC message part processing states.
503 enum GNUNET_PSYC_MessageState
505 GNUNET_PSYC_MESSAGE_STATE_START = 0,
506 GNUNET_PSYC_MESSAGE_STATE_HEADER = 1,
507 GNUNET_PSYC_MESSAGE_STATE_METHOD = 2,
508 GNUNET_PSYC_MESSAGE_STATE_MODIFIER = 3,
509 GNUNET_PSYC_MESSAGE_STATE_MOD_CONT = 4,
510 GNUNET_PSYC_MESSAGE_STATE_DATA = 5,
511 GNUNET_PSYC_MESSAGE_STATE_END = 6,
512 GNUNET_PSYC_MESSAGE_STATE_CANCEL = 7,
513 GNUNET_PSYC_MESSAGE_STATE_ERROR = 8,
518 * Handle that identifies a join request.
520 * Used to match calls to #GNUNET_PSYC_JoinCallback to the
521 * corresponding calls to GNUNET_PSYC_join_decision().
523 struct GNUNET_PSYC_JoinHandle;
527 * Method called from PSYC upon receiving a message.
529 * @param cls Closure.
530 * @param message_id Sequence number of the message.
531 * @param flags OR'ed GNUNET_PSYC_MessageFlags
532 * @param msg Message part, one of the following types:
535 (*GNUNET_PSYC_MessageCallback) (void *cls,
538 const struct GNUNET_PSYC_MessageHeader *msg);
542 * Method called from PSYC upon receiving part of a message.
546 * @param slave_pub_key
547 * Public key of the slave sending the message.
548 * Only set for channel master.
550 * Sequence number of the message.
552 * OR'ed GNUNET_PSYC_MessageFlags
553 * @param fragment_offset
554 * Multicast message fragment offset.
555 * @param msg Message part, one of the following types:
556 * - #GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_HEADER
557 * - #GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD
558 * - #GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER
559 * - #GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MOD_CONT
560 * - #GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA
561 * or NULL if an error occurred while receiving a message.
564 (*GNUNET_PSYC_MessagePartCallback) (void *cls,
565 const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_pub_key,
568 uint64_t fragment_offset,
569 const struct GNUNET_MessageHeader *msg);
573 * Method called from PSYC upon receiving a join request.
577 * @param slave_pub_key
578 * Public key of the slave requesting join.
580 * Join message sent along with the request.
582 * Join handle to use with GNUNET_PSYC_join_decision()
585 (*GNUNET_PSYC_JoinRequestCallback) (void *cls,
586 const struct GNUNET_PSYC_JoinRequestMessage *req,
587 const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_pub_key,
588 const struct GNUNET_PSYC_Message *join_msg,
589 struct GNUNET_PSYC_JoinHandle *jh);
593 * Function to call with the decision made for a join request.
595 * Must be called once and only once in response to an invocation of the
596 * #GNUNET_PSYC_JoinCallback.
598 * @param jh Join request handle.
600 * #GNUNET_YES if the join is approved,
601 * #GNUNET_NO if it is disapproved,
602 * #GNUNET_SYSERR if we cannot answer the request.
603 * @param relay_count Number of relays given.
604 * @param relays Array of suggested peers that might be useful relays to use
605 * when joining the multicast group (essentially a list of peers that
606 * are already part of the multicast group and might thus be willing
607 * to help with routing). If empty, only this local peer (which must
608 * be the multicast origin) is a good candidate for building the
609 * multicast tree. Note that it is unnecessary to specify our own
610 * peer identity in this array.
611 * @param join_resp Application-dependent join response message to send along
614 * @return #GNUNET_OK on success,
615 * #GNUNET_SYSERR if @a join_resp is too large.
618 GNUNET_PSYC_join_decision (struct GNUNET_PSYC_JoinHandle *jh,
620 uint32_t relay_count,
621 const struct GNUNET_PeerIdentity *relays,
622 const struct GNUNET_PSYC_Message *join_resp);
626 * Handle for the master of a PSYC channel.
628 struct GNUNET_PSYC_Master;
632 * Function called after connected to the PSYC service
633 * and the channel master started.
635 * Also called when reconnected to the service
636 * after the connection closed unexpectedly.
641 * #GNUNET_YES if there were already messages sent to the channel,
642 * #GNUNET_NO if the message history is empty,
643 * #GNUNET_SYSERR on error.
644 * @param max_message_id
645 * Last message ID sent to the channel.
648 (*GNUNET_PSYC_MasterStartCallback) (void *cls, int result,
649 uint64_t max_message_id);
653 * Start a PSYC master channel.
655 * Will start a multicast group identified by the given ECC key. Messages
656 * received from group members will be given to the respective handler methods.
657 * If a new member wants to join a group, the "join" method handler will be
658 * invoked; the join handler must then generate a "join" message to approve the
659 * joining of the new member. The channel can also change group membership
660 * without explicit requests. Note that PSYC doesn't itself "understand" join
661 * or part messages, the respective methods must call other PSYC functions to
662 * inform PSYC about the meaning of the respective events.
664 * @param cfg Configuration to use (to connect to PSYC service).
665 * @param channel_key ECC key that will be used to sign messages for this
666 * PSYC session. The public key is used to identify the PSYC channel.
667 * Note that end-users will usually not use the private key directly, but
668 * rather look it up in GNS for places managed by other users, or select
669 * a file with the private key(s) when setting up their own channels
670 * FIXME: we'll likely want to use NOT the p521 curve here, but a cheaper
672 * @param policy Channel policy specifying join and history restrictions.
673 * Used to automate join decisions.
674 * @param master_start_cb Function to invoke after the channel master started.
675 * @param join_request_cb Function to invoke when a slave wants to join.
676 * @param message_cb Function to invoke on message parts sent to the channel
677 * and received from slaves
678 * @param cls Closure for @a method and @a join_cb.
680 * @return Handle for the channel master, NULL on error.
682 struct GNUNET_PSYC_Master *
683 GNUNET_PSYC_master_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
684 const struct GNUNET_CRYPTO_EddsaPrivateKey *channel_key,
685 enum GNUNET_PSYC_Policy policy,
686 GNUNET_PSYC_MasterStartCallback master_start_cb,
687 GNUNET_PSYC_JoinRequestCallback join_request_cb,
688 GNUNET_PSYC_MessageCallback message_cb,
689 GNUNET_PSYC_MessagePartCallback message_part_cb,
694 * Function called to provide data for a transmission via PSYC.
696 * Note that returning #GNUNET_YES or #GNUNET_SYSERR (but not #GNUNET_NO)
697 * invalidates the respective transmission handle.
699 * @param cls Closure.
700 * @param[in,out] data_size Initially set to the number of bytes available in
701 * @a data, should be set to the number of bytes written to data.
702 * @param[out] data Where to write the body of the message to give to the
703 * method. The function must copy at most @a data_size bytes to @a data.
704 * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
705 * #GNUNET_NO on success, if more data is to be transmitted later.
706 * Should be used if @a data_size was not big enough to take all the
707 * data. If 0 is returned in @a data_size the transmission is paused,
708 * and can be resumed with GNUNET_PSYC_master_transmit_resume().
709 * #GNUNET_YES if this completes the transmission (all data supplied)
712 (*GNUNET_PSYC_TransmitNotifyData) (void *cls,
717 * Function called to provide a modifier for a transmission via PSYC.
719 * Note that returning #GNUNET_YES or #GNUNET_SYSERR (but not #GNUNET_NO)
720 * invalidates the respective transmission handle.
722 * @param cls Closure.
723 * @param[in,out] data_size Initially set to the number of bytes available in
724 * @a data, should be set to the number of bytes written to data.
725 * @param[out] data Where to write the modifier's name and value.
726 * The function must copy at most @a data_size bytes to @a data.
727 * When this callback is first called for a modifier, @a data should
728 * contain: "name\0value". If the whole value does not fit, subsequent
729 * calls to this function should write continuations of the value to
731 * @param[out] oper Where to write the operator of the modifier.
732 * Only needed during the first call to this callback at the beginning
733 * of the modifier. In case of subsequent calls asking for value
734 * continuations @a oper is set to #NULL.
735 * @param[out] full_value_size Where to write the full size of the value.
736 * Only needed during the first call to this callback at the beginning
737 * of the modifier. In case of subsequent calls asking for value
738 * continuations @a value_size is set to #NULL.
739 * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
740 * #GNUNET_NO on success, if more data is to be transmitted later.
741 * Should be used if @a data_size was not big enough to take all the
742 * data for the modifier's value (the name must be always returned
743 * during the first call to this callback).
744 * If 0 is returned in @a data_size the transmission is paused,
745 * and can be resumed with GNUNET_PSYC_master_transmit_resume().
746 * #GNUNET_YES if this completes the modifier (the whole value is supplied).
749 (*GNUNET_PSYC_TransmitNotifyModifier) (void *cls,
753 uint32_t *full_value_size);
756 * Flags for transmitting messages to a channel by the master.
758 enum GNUNET_PSYC_MasterTransmitFlags
760 GNUNET_PSYC_MASTER_TRANSMIT_NONE = 0,
763 * Whether this message should reset the channel state,
764 * i.e. remove all previously stored state variables.
767 GNUNET_PSYC_MASTER_TRANSMIT_STATE_RESET = 1 << 0,
770 * Whether this message contains any state modifiers.
772 GNUNET_PSYC_MASTER_TRANSMIT_STATE_MODIFY = 1 << 1,
775 * Add PSYC header variable with the hash of the current channel state.
777 GNUNET_PSYC_MASTER_TRANSMIT_STATE_HASH = 1 << 2,
780 * Whether we need to increment the group generation counter after
781 * transmitting this message.
783 GNUNET_PSYC_MASTER_TRANSMIT_INC_GROUP_GEN = 1 << 3
788 * Handle for a pending PSYC transmission operation.
790 struct GNUNET_PSYC_MasterTransmitHandle;
794 * Send a message to call a method to all members in the PSYC channel.
796 * @param master Handle to the PSYC channel.
797 * @param method_name Which method should be invoked.
798 * @param notify_mod Function to call to obtain modifiers.
799 * @param notify_data Function to call to obtain fragments of the data.
800 * @param notify_cls Closure for @a notify_mod and @a notify_data.
801 * @param flags Flags for the message being transmitted.
802 * @return Transmission handle, NULL on error (i.e. more than one request queued).
804 struct GNUNET_PSYC_MasterTransmitHandle *
805 GNUNET_PSYC_master_transmit (struct GNUNET_PSYC_Master *master,
806 const char *method_name,
807 GNUNET_PSYC_TransmitNotifyModifier notify_mod,
808 GNUNET_PSYC_TransmitNotifyData notify_data,
810 enum GNUNET_PSYC_MasterTransmitFlags flags);
814 * Resume transmission to the channel.
816 * @param th Handle of the request that is being resumed.
819 GNUNET_PSYC_master_transmit_resume (struct GNUNET_PSYC_MasterTransmitHandle *th);
823 * Abort transmission request to channel.
825 * @param th Handle of the request that is being aborted.
828 GNUNET_PSYC_master_transmit_cancel (struct GNUNET_PSYC_MasterTransmitHandle *th);
832 * Stop a PSYC master channel.
835 * PSYC channel master to stop.
837 * Keep place active after last application disconnected.
839 * Function called after the master stopped
840 * and disconnected from the psyc service.
842 * Closure for @a part_cb.
845 GNUNET_PSYC_master_stop (struct GNUNET_PSYC_Master *master,
847 GNUNET_ContinuationCallback stop_cb,
852 * Handle for a PSYC channel slave.
854 struct GNUNET_PSYC_Slave;
858 * Function called after the slave connected to the PSYC service.
860 * Also called when reconnected to the service
861 * after the connection closed unexpectedly.
866 * #GNUNET_YES if there were already messages sent to the channel,
867 * #GNUNET_NO if the message history is empty,
868 * #GNUNET_SYSERR on error.
869 * @param max_message_id
870 * Last message ID sent to the channel.
873 (*GNUNET_PSYC_SlaveConnectCallback) (void *cls, int result,
874 uint64_t max_message_id);
878 * Method called to inform about the decision in response to a join request.
880 * If @a is_admitted is not #GNUNET_YES, then sending messages to the channel is
881 * not possible, but earlier history can be still queried.
883 * @param cls Closure.
884 * @param is_admitted #GNUNET_YES or #GNUNET_NO or #GNUNET_SYSERR
885 * @param join_msg Application-dependent join message from the origin.
888 (*GNUNET_PSYC_JoinDecisionCallback) (void *cls,
889 const struct GNUNET_PSYC_JoinDecisionMessage *dcsn,
891 const struct GNUNET_PSYC_Message *join_msg);
894 * Flags for GNUNET_PSYC_slave_join()
896 enum GNUNET_PSYC_SlaveJoinFlags
898 GNUNET_PSYC_SLAVE_JOIN_NONE = 0,
901 * Local join for history access, no network connection is established.
903 GNUNET_PSYC_SLAVE_JOIN_LOCAL = 1,
908 * Join a PSYC channel.
910 * The entity joining is always the local peer. The user must immediately use
911 * the GNUNET_PSYC_slave_transmit() functions to transmit a @e join_msg to the
912 * channel; if the join request succeeds, the channel state (and @e recent
913 * method calls) will be replayed to the joining member. There is no explicit
914 * notification on failure (as the channel may simply take days to approve,
915 * and disapproval is simply being ignored).
918 * Configuration to use.
919 * @param channel_pub_key
920 * ECC public key that identifies the channel we wish to join.
921 * @param slave_pub_key
922 * ECC private-public key pair that identifies the slave, and
923 * used by multicast to sign the join request and subsequent unicast
924 * requests sent to the master.
928 * Peer identity of the origin.
930 * Number of peers in the @a relays array.
932 * Peer identities of members of the multicast group, which serve
933 * as relays and used to join the group at.
935 * Function to invoke on message fragments received from the channel.
936 * @param message_part_cb
937 * Function to invoke on message parts received from the channel.
938 * @param slave_connect_cb
939 * Function invoked once we have connected to the PSYC service.
940 * @param join_decision_cb
941 * Function invoked once we have received a join decision.
943 * Closure for @a message_cb and @a slave_joined_cb.
947 * @return Handle for the slave, NULL on error.
949 struct GNUNET_PSYC_Slave *
950 GNUNET_PSYC_slave_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
951 const struct GNUNET_CRYPTO_EddsaPublicKey *channel_pub_key,
952 const struct GNUNET_CRYPTO_EcdsaPrivateKey *slave_pub_key,
953 enum GNUNET_PSYC_SlaveJoinFlags flags,
954 const struct GNUNET_PeerIdentity *origin,
955 uint32_t relay_count,
956 const struct GNUNET_PeerIdentity *relays,
957 GNUNET_PSYC_MessageCallback message_cb,
958 GNUNET_PSYC_MessagePartCallback message_part_cb,
959 GNUNET_PSYC_SlaveConnectCallback slave_connect_cb,
960 GNUNET_PSYC_JoinDecisionCallback join_decision_cb,
962 const struct GNUNET_PSYC_Message *join_msg);
966 * Part a PSYC channel.
968 * Will terminate the connection to the PSYC service. Polite clients should
969 * first explicitly send a part request (via GNUNET_PSYC_slave_transmit()).
974 * Keep place active after last application disconnected.
976 * Function called after the slave parted the channel
977 * and disconnected from the psyc service.
979 * Closure for @a part_cb.
982 GNUNET_PSYC_slave_part (struct GNUNET_PSYC_Slave *slave,
984 GNUNET_ContinuationCallback part_cb,
989 * Flags for transmitting messages to the channel master by a slave.
991 enum GNUNET_PSYC_SlaveTransmitFlags
993 GNUNET_PSYC_SLAVE_TRANSMIT_NONE = 0
998 * Handle for a pending PSYC transmission operation.
1000 struct GNUNET_PSYC_SlaveTransmitHandle;
1004 * Request a message to be sent to the channel master.
1006 * @param slave Slave handle.
1007 * @param method_name Which (PSYC) method should be invoked (on host).
1008 * @param notify_mod Function to call to obtain modifiers.
1009 * @param notify_data Function to call to obtain fragments of the data.
1010 * @param notify_cls Closure for @a notify.
1011 * @param flags Flags for the message being transmitted.
1012 * @return Transmission handle, NULL on error (i.e. more than one request queued).
1014 struct GNUNET_PSYC_SlaveTransmitHandle *
1015 GNUNET_PSYC_slave_transmit (struct GNUNET_PSYC_Slave *slave,
1016 const char *method_name,
1017 GNUNET_PSYC_TransmitNotifyModifier notify_mod,
1018 GNUNET_PSYC_TransmitNotifyData notify_data,
1020 enum GNUNET_PSYC_SlaveTransmitFlags flags);
1024 * Resume transmission to the master.
1026 * @param th Handle of the request that is being resumed.
1029 GNUNET_PSYC_slave_transmit_resume (struct GNUNET_PSYC_SlaveTransmitHandle *th);
1033 * Abort transmission request to master.
1035 * @param th Handle of the request that is being aborted.
1038 GNUNET_PSYC_slave_transmit_cancel (struct GNUNET_PSYC_SlaveTransmitHandle *th);
1042 * Handle to access PSYC channel operations for both the master and slaves.
1044 struct GNUNET_PSYC_Channel;
1048 * Convert a channel @a master to a @e channel handle to access the @e channel
1051 * @param master Channel master handle.
1052 * @return Channel handle, valid for as long as @a master is valid.
1054 struct GNUNET_PSYC_Channel *
1055 GNUNET_PSYC_master_get_channel (struct GNUNET_PSYC_Master *master);
1059 * Convert @a slave to a @e channel handle to access the @e channel APIs.
1061 * @param slave Slave handle.
1062 * @return Channel handle, valid for as long as @a slave is valid.
1064 struct GNUNET_PSYC_Channel *
1065 GNUNET_PSYC_slave_get_channel (struct GNUNET_PSYC_Slave *slave);
1069 * Add a slave to the channel's membership list.
1071 * Note that this will NOT generate any PSYC traffic, it will merely update the
1072 * local database to modify how we react to <em>membership test</em> queries.
1073 * The channel master still needs to explicitly transmit a @e join message to
1074 * notify other channel members and they then also must still call this function
1075 * in their respective methods handling the @e join message. This way, how @e
1076 * join and @e part operations are exactly implemented is still up to the
1077 * application; for example, there might be a @e part_all method to kick out
1080 * Note that channel slaves are explicitly trusted to execute such methods
1081 * correctly; not doing so correctly will result in either denying other slaves
1082 * access or offering access to channel data to non-members.
1086 * @param slave_pub_key
1087 * Identity of channel slave to add.
1088 * @param announced_at
1089 * ID of the message that announced the membership change.
1090 * @param effective_since
1091 * Addition of slave is in effect since this message ID.
1093 * Function to call with the result of the operation.
1094 * The @e result_code argument is #GNUNET_OK on success, or
1095 * #GNUNET_SYSERR on error. In case of an error, the @e data argument
1096 * can contain an optional error message.
1098 * Closure for @a result_cb.
1101 GNUNET_PSYC_channel_slave_add (struct GNUNET_PSYC_Channel *channel,
1102 const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_pub_key,
1103 uint64_t announced_at,
1104 uint64_t effective_since,
1105 GNUNET_ResultCallback result_cb,
1110 * Remove a slave from the channel's membership list.
1112 * Note that this will NOT generate any PSYC traffic, it will merely update the
1113 * local database to modify how we react to <em>membership test</em> queries.
1114 * The channel master still needs to explicitly transmit a @e part message to
1115 * notify other channel members and they then also must still call this function
1116 * in their respective methods handling the @e part message. This way, how
1117 * @e join and @e part operations are exactly implemented is still up to the
1118 * application; for example, there might be a @e part_all message to kick out
1121 * Note that channel members are explicitly trusted to perform these
1122 * operations correctly; not doing so correctly will result in either
1123 * denying members access or offering access to channel data to
1128 * @param slave_pub_key
1129 * Identity of channel slave to remove.
1130 * @param announced_at
1131 * ID of the message that announced the membership change.
1133 * Function to call with the result of the operation.
1134 * The @e result_code argument is #GNUNET_OK on success, or
1135 * #GNUNET_SYSERR on error. In case of an error, the @e data argument
1136 * can contain an optional error message.
1138 * Closure for @a result_cb.
1141 GNUNET_PSYC_channel_slave_remove (struct GNUNET_PSYC_Channel *channel,
1142 const struct GNUNET_CRYPTO_EcdsaPublicKey
1144 uint64_t announced_at,
1145 GNUNET_ResultCallback result_cb,
1150 * History request handle.
1152 struct GNUNET_PSYC_HistoryRequest;
1156 * Request to replay a part of the message history of the channel.
1158 * Historic messages (but NOT the state at the time) will be replayed (given to
1159 * the normal method handlers) if available and if access is permitted.
1162 * Which channel should be replayed?
1163 * @param start_message_id
1164 * Earliest interesting point in history.
1165 * @param end_message_id
1166 * Last (inclusive) interesting point in history.
1167 * @param method_prefix
1168 * Retrieve only messages with a matching method prefix.
1170 * OR'ed enum GNUNET_PSYC_HistoryReplayFlags
1172 * Function to call when the requested history has been fully replayed.
1173 * Once this function has been called, the client must not call
1174 * GNUNET_PSYC_channel_history_replay_cancel() anymore.
1176 * Closure for the callbacks.
1178 * @return Handle to cancel history replay operation.
1180 struct GNUNET_PSYC_HistoryRequest *
1181 GNUNET_PSYC_channel_history_replay (struct GNUNET_PSYC_Channel *channel,
1182 uint64_t start_message_id,
1183 uint64_t end_message_id,
1184 const char *method_prefix,
1186 GNUNET_PSYC_MessageCallback message_cb,
1187 GNUNET_PSYC_MessagePartCallback message_part_cb,
1188 GNUNET_ResultCallback result_cb,
1193 * Request to replay the latest messages from the message history of the channel.
1195 * Historic messages (but NOT the state at the time) will be replayed (given to
1196 * the normal method handlers) if available and if access is permitted.
1199 * Which channel should be replayed?
1200 * @param message_limit
1201 * Maximum number of messages to replay.
1203 * OR'ed enum GNUNET_PSYC_HistoryReplayFlags
1205 * Function to call when the requested history has been fully replayed
1206 * (counting message IDs might not suffice, as some messages might be
1207 * secret and thus the listener would not know the story is finished
1208 * without being told explicitly)o once this function has been called, the
1209 * client must not call GNUNET_PSYC_channel_history_replay_cancel() anymore.
1211 * Closure for the callbacks.
1213 * @return Handle to cancel history replay operation.
1215 struct GNUNET_PSYC_HistoryRequest *
1216 GNUNET_PSYC_channel_history_replay_latest (struct GNUNET_PSYC_Channel *channel,
1217 uint64_t message_limit,
1218 const char *method_prefix,
1220 GNUNET_PSYC_MessageCallback message_cb,
1221 GNUNET_PSYC_MessagePartCallback message_part_cb,
1222 GNUNET_ResultCallback result_cb,
1227 GNUNET_PSYC_channel_history_replay_cancel (struct GNUNET_PSYC_Channel *channel,
1228 struct GNUNET_PSYC_HistoryRequest *hr);
1232 * Function called to inform a member about stored state values for a channel.
1234 * If @a full_value_size > value_size then this function is called multiple
1235 * times until the whole value arrived.
1240 * Name of the state variable.
1241 * NULL if there are no more state variables to be returned.
1243 * Value of the state variable.
1245 * Number of bytes in @a value.
1246 * @param full_value_size
1247 * Number of bytes in the full value, including continuations.
1248 * Only set for the first part of a variable,
1249 * in case of a continuation it is 0.
1252 (*GNUNET_PSYC_StateVarCallback) (void *cls,
1253 const struct GNUNET_MessageHeader *mod,
1256 uint32_t value_size,
1257 uint32_t full_value_size);
1261 * State request handle.
1263 struct GNUNET_PSYC_StateRequest;
1267 * Retrieve the best matching channel state variable.
1269 * If the requested variable name is not present in the state, the nearest
1270 * less-specific name is matched; for example, requesting "_a_b" will match "_a"
1271 * if "_a_b" does not exist.
1276 * Full name of the requested variable.
1277 * The actual variable returned might have a shorter name.
1279 * Function called once when a matching state variable is found.
1280 * Not called if there's no matching state variable.
1282 * Function called after the operation finished.
1283 * (i.e. all state variables have been returned via @a state_cb)
1285 * Closure for the callbacks.
1287 struct GNUNET_PSYC_StateRequest *
1288 GNUNET_PSYC_channel_state_get (struct GNUNET_PSYC_Channel *channel,
1289 const char *full_name,
1290 GNUNET_PSYC_StateVarCallback var_cb,
1291 GNUNET_ResultCallback result_cb,
1296 * Return all channel state variables whose name matches a given prefix.
1298 * A name matches if it starts with the given @a name_prefix, thus requesting
1299 * the empty prefix ("") will match all values; requesting "_a_b" will also
1300 * return values stored under "_a_b_c".
1302 * The @a state_cb is invoked on all matching state variables asynchronously, as
1303 * the state is stored in and retrieved from the PSYCstore,
1307 * @param name_prefix
1308 * Prefix of the state variable name to match.
1310 * Function called once when a matching state variable is found.
1311 * Not called if there's no matching state variable.
1313 * Function called after the operation finished.
1314 * (i.e. all state variables have been returned via @a state_cb)
1316 * Closure for the callbacks.
1318 struct GNUNET_PSYC_StateRequest *
1319 GNUNET_PSYC_channel_state_get_prefix (struct GNUNET_PSYC_Channel *channel,
1320 const char *name_prefix,
1321 GNUNET_PSYC_StateVarCallback var_cb,
1322 GNUNET_ResultCallback result_cb,
1326 * Cancel a state request operation.
1329 * Handle for the operation to cancel.
1332 GNUNET_PSYC_channel_state_get_cancel (struct GNUNET_PSYC_StateRequest *sr);
1336 #if 0 /* keep Emacsens' auto-indent happy */
1343 /* ifndef GNUNET_PSYC_SERVICE_H */
1346 /** @} */ /* end of group */