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 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'.
  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_env_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 /**
 100  * Policy flags for a channel.
 101  */
 102 enum GNUNET_PSYC_ChannelFlags
 103 {
 104   /**
 105    * Admission must be confirmed by the master.
 106    */
 107   GNUNET_PSYC_CHANNEL_ADMISSION_CONTROL = 1 << 0,
 108
 109   /**
 110    * Past messages are only available to slaves who were admitted at the time
 111    * they were sent to the channel.
 112    */
 113   GNUNET_PSYC_CHANNEL_RESTRICTED_HISTORY = 1 << 1
 114 };
 115
 116 /**
 117  * PSYC channel policies.
 118  */
 119 enum GNUNET_PSYC_Policy
 120 {
 121   /**
 122    * Anyone can join the channel, without announcing his presence;
 123    * all messages are always public and can be distributed freely.
 124    * Joins may be announced, but this is not required.
 125    */
 126   GNUNET_PSYC_CHANNEL_ANONYMOUS = 0,
 127
 128   /**
 129    * The master must approve membership to the channel, messages must only be
 130    * distributed to current channel slaves.  This includes the channel
 131    * state as well as transient messages.
 132    */
 133   GNUNET_PSYC_CHANNEL_PRIVATE
 134     = GNUNET_PSYC_CHANNEL_ADMISSION_CONTROL
 135     | GNUNET_PSYC_CHANNEL_RESTRICTED_HISTORY
 136
 137 #if IDEAS_FOR_FUTURE
 138   /**
 139    * Anyone can freely join the channel (no approval required);
 140    * however, messages must only be distributed to current channel
 141    * slaves, so the master must still acknowledge that the slave
 142    * joined before transient messages are delivered.  As approval is
 143    * guaranteed, the presistent channel state can be synchronized freely
 144    * immediately, prior to master confirmation.
 145    */
 146   GNUNET_PSYC_CHANNEL_OPEN
 147     = GNUNET_PSYC_CHANNEL_RESTRICTED_HISTORY,
 148
 149   /**
 150    * The master must approve joins to the channel, but past messages can be
 151    * freely distributed to slaves.
 152    */
 153   GNUNET_PSYC_CHANNEL_CLOSED
 154     = GNUNET_PSYC_CHANNEL_ADMISSION_CONTROL,
 155 #endif
 156 };
 157
 158
 159 enum GNUNET_PSYC_MessageFlags
 160 {
 161   /**
 162    * Historic message, retrieved from PSYCstore.
 163    */
 164   GNUNET_PSYC_MESSAGE_HISTORIC = 1 << 0,
 165
 166   /**
 167    * Request from slave to master.
 168    */
 169   GNUNET_PSYC_MESSAGE_REQUEST = 1 << 1
 170 };
 171
 172 GNUNET_NETWORK_STRUCT_BEGIN
 173
 174 /**
 175  * Header of a PSYC message.
 176  */
 177 struct GNUNET_PSYC_MessageHeader
 178 {
 179   /**
 180    * Generic message header with size and type information.
 181    */
 182   struct GNUNET_MessageHeader header;
 183
 184   /**
 185    * Flags for this message fragment.
 186    *
 187    * @see enum GNUNET_PSYC_MessageFlags
 188    */
 189   uint32_t flags GNUNET_PACKED;
 190
 191   /**
 192    * Number of the message this message part belongs to.
 193    */
 194   uint64_t message_id GNUNET_PACKED;
 195
 196   /**
 197    * Sending slave's public key.
 198    * Not set if the message is from the master.
 199    */
 200   struct GNUNET_CRYPTO_EddsaPublicKey slave_key;
 201
 202   /* Followed by concatenated PSYC message parts:
 203    * messages with GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_* types
 204    */
 205 };
 206
 207
 208 /**
 209  * The method of a message.
 210  */
 211 struct GNUNET_PSYC_MessageMethod
 212 {
 213   /**
 214    * Type: GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD
 215    */
 216   struct GNUNET_MessageHeader header;
 217
 218   /**
 219    * OR'ed GNUNET_PSYC_MasterTransmitFlags
 220    */
 221   uint32_t flags GNUNET_PACKED;
 222
 223   /* Followed by NUL-terminated method name. */
 224 };
 225
 226
 227 /**
 228  * A modifier of a message.
 229  */
 230 struct GNUNET_PSYC_MessageModifier
 231 {
 232   /**
 233    * Type: GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER
 234    */
 235   struct GNUNET_MessageHeader header;
 236
 237   /**
 238    * Size of value.
 239    */
 240   uint32_t value_size GNUNET_PACKED;
 241
 242   /**
 243    * Size of name, including NUL terminator.
 244    */
 245   uint16_t name_size GNUNET_PACKED;
 246
 247   /**
 248    * enum GNUNET_ENV_Operator
 249    */
 250   uint8_t oper;
 251
 252   /* Followed by NUL-terminated name, then the value. */
 253 };
 254
 255 GNUNET_NETWORK_STRUCT_END
 256
 257 #define GNUNET_PSYC_MODIFIER_MAX_PAYLOAD        \
 258   GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD         \
 259   - sizeof (struct GNUNET_PSYC_MessageModifier)
 260
 261 #define GNUNET_PSYC_MOD_CONT_MAX_PAYLOAD        \
 262   GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD         \
 263   - sizeof (struct GNUNET_MessageHeader)
 264
 265 #define GNUNET_PSYC_DATA_MAX_PAYLOAD            \
 266   GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD         \
 267   - sizeof (struct GNUNET_MessageHeader)
 268
 269 /**
 270  * Handle that identifies a join request.
 271  *
 272  * Used to match calls to #GNUNET_PSYC_JoinCallback to the
 273  * corresponding calls to GNUNET_PSYC_join_decision().
 274  */
 275 struct GNUNET_PSYC_JoinHandle;
 276
 277
 278 /**
 279  * Method called from PSYC upon receiving part of a message.
 280  *
 281  * @param cls Closure.
 282  * @param msg Message part, one of the following types:
 283  * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_HEADER
 284  * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD
 285  * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER
 286  * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MOD_CONT
 287  * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA
 288  */
 289 typedef void
 290 (*GNUNET_PSYC_MessageCallback) (void *cls,
 291                                 uint64_t message_id,
 292                                 uint32_t flags,
 293                                 const struct GNUNET_MessageHeader *msg);
 294
 295
 296 /**
 297  * Method called from PSYC upon receiving a join request.
 298  *
 299  * @param cls Closure.
 300  * @param slave  requesting to join.
 301  * @param method_name Method name in the join request.
 302  * @param variable_count Number of elements in the @a variables array.
 303  * @param variables Transient variables for the join request.
 304  * @param data Data stream given to the method (might not be zero-terminated
 305  *             if data is binary).
 306  * @param data_size Number of bytes in @a data.
 307  * @param jh Join handle to use with GNUNET_PSYC_join_decision()
 308  */
 309 typedef void
 310 (*GNUNET_PSYC_JoinCallback) (void *cls,
 311                              const struct GNUNET_CRYPTO_EddsaPublicKey
 312                              *slave_key,
 313                              const char *method_name,
 314                              size_t variable_count,
 315                              const struct GNUNET_ENV_Modifier *variables,
 316                              const void *data,
 317                              size_t data_size,
 318                              struct GNUNET_PSYC_JoinHandle *jh);
 319
 320
 321 /**
 322  * Function to call with the decision made for a join request.
 323  *
 324  * Must be called once and only once in response to an invocation of the
 325  * #GNUNET_PSYC_JoinCallback.
 326  *
 327  * @param jh Join request handle.
 328  * @param is_admitted #GNUNET_YES if joining is approved,
 329  *        #GNUNET_NO if it is disapproved.
 330  * @param relay_count Number of relays given.
 331  * @param relays Array of suggested peers that might be useful relays to use
 332  *        when joining the multicast group (essentially a list of peers that
 333  *        are already part of the multicast group and might thus be willing
 334  *        to help with routing).  If empty, only this local peer (which must
 335  *        be the multicast origin) is a good candidate for building the
 336  *        multicast tree.  Note that it is unnecessary to specify our own
 337  *        peer identity in this array.
 338  * @param method_name Method name for the message transmitted with the response.
 339  * @param env Environment containing transient variables for the message,
 340  *        or NULL.
 341  * @param data Data of the message.
 342  * @param data_size Size of @a data.
 343  */
 344 void
 345 GNUNET_PSYC_join_decision (struct GNUNET_PSYC_JoinHandle *jh,
 346                            int is_admitted,
 347                            uint32_t relay_count,
 348                            const struct GNUNET_PeerIdentity *relays,
 349                            const char *method_name,
 350                            const struct GNUNET_ENV_Environment *env,
 351                            const void *data,
 352                            size_t data_size);
 353
 354
 355 /**
 356  * Handle for the master of a PSYC channel.
 357  */
 358 struct GNUNET_PSYC_Master;
 359
 360
 361 /**
 362  * Function called after the channel master started.
 363  *
 364  * @param cls Closure.
 365  * @param last_message_id Last message ID sent to the channel.
 366  */
 367 typedef void
 368 (*GNUNET_PSYC_MasterStartCallback) (void *cls, uint64_t max_message_id);
 369
 370
 371 /**
 372  * Start a PSYC master channel.
 373  *
 374  * Will start a multicast group identified by the given ECC key.  Messages
 375  * received from group members will be given to the respective handler methods.
 376  * If a new member wants to join a group, the "join" method handler will be
 377  * invoked; the join handler must then generate a "join" message to approve the
 378  * joining of the new member.  The channel can also change group membership
 379  * without explicit requests.  Note that PSYC doesn't itself "understand" join
 380  * or part messages, the respective methods must call other PSYC functions to
 381  * inform PSYC about the meaning of the respective events.
 382  *
 383  * @param cfg Configuration to use (to connect to PSYC service).
 384  * @param channel_key ECC key that will be used to sign messages for this
 385  *        PSYC session. The public key is used to identify the PSYC channel.
 386  *        Note that end-users will usually not use the private key directly, but
 387  *        rather look it up in GNS for places managed by other users, or select
 388  *        a file with the private key(s) when setting up their own channels
 389  *        FIXME: we'll likely want to use NOT the p521 curve here, but a cheaper
 390  *        one in the future.
 391  * @param policy Channel policy specifying join and history restrictions.
 392  *        Used to automate join decisions.
 393  * @param message_cb Function to invoke on message parts received from slaves.
 394  * @param join_cb Function to invoke when a peer wants to join.
 395  * @param master_started_cb Function to invoke after the channel master started.
 396  * @param cls Closure for @a method and @a join_cb.
 397  * @return Handle for the channel master, NULL on error.
 398  */
 399 struct GNUNET_PSYC_Master *
 400 GNUNET_PSYC_master_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 401                           const struct GNUNET_CRYPTO_EddsaPrivateKey *channel_key,
 402                           enum GNUNET_PSYC_Policy policy,
 403                           GNUNET_PSYC_MessageCallback message_cb,
 404                           GNUNET_PSYC_JoinCallback join_cb,
 405                           GNUNET_PSYC_MasterStartCallback master_started_cb,
 406                           void *cls);
 407
 408
 409 /**
 410  * Function called to provide data for a transmission via PSYC.
 411  *
 412  * Note that returning #GNUNET_YES or #GNUNET_SYSERR (but not #GNUNET_NO)
 413  * invalidates the respective transmission handle.
 414  *
 415  * @param cls Closure.
 416  * @param[in,out] data_size Initially set to the number of bytes available in
 417  *        @a data, should be set to the number of bytes written to data.
 418  * @param[out] data Where to write the body of the message to give to the
 419  *         method. The function must copy at most @a data_size bytes to @a data.
 420  * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
 421  *         #GNUNET_NO on success, if more data is to be transmitted later.
 422  *         Should be used if @a data_size was not big enough to take all the
 423  *         data.  If 0 is returned in @a data_size the transmission is paused,
 424  *         and can be resumed with GNUNET_PSYC_master_transmit_resume().
 425  *         #GNUNET_YES if this completes the transmission (all data supplied)
 426  */
 427 typedef int
 428 (*GNUNET_PSYC_TransmitNotifyData) (void *cls,
 429                                    uint16_t *data_size,
 430                                    void *data);
 431
 432 /**
 433  * Function called to provide a modifier for a transmission via PSYC.
 434  *
 435  * Note that returning #GNUNET_YES or #GNUNET_SYSERR (but not #GNUNET_NO)
 436  * invalidates the respective transmission handle.
 437  *
 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 modifier's name and value.
 442  *         The function must copy at most @a data_size bytes to @a data.
 443  *         When this callback is first called for a modifier, @a data should
 444  *         contain: "name\0value".  If the whole value does not fit, subsequent
 445  *         calls to this function should write continuations of the value to
 446  *         @a data.
 447  * @param oper  Where to write the operator of the modifier.  Only needed during
 448  *         the first call to this callback at the beginning of the modifier.
 449  *         In case of subsequent calls asking for value continuations @a oper is
 450  *         set to #NULL.
 451  * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
 452  *         #GNUNET_NO on success, if more data is to be transmitted later.
 453  *         Should be used if @a data_size was not big enough to take all the
 454  *         data for the modifier's value (the name must be always returned
 455  *         during the first call to this callback).
 456  *         If 0 is returned in @a data_size the transmission is paused,
 457  *         and can be resumed with GNUNET_PSYC_master_transmit_resume().
 458  *         #GNUNET_YES if this completes the modifier (the whole value is supplied).
 459  */
 460 typedef int
 461 (*GNUNET_PSYC_TransmitNotifyModifier) (void *cls,
 462                                        uint16_t *data_size,
 463                                        void *data,
 464                                        uint8_t *oper);
 465
 466 /**
 467  * Flags for transmitting messages to a channel by the master.
 468  */
 469 enum GNUNET_PSYC_MasterTransmitFlags
 470 {
 471   GNUNET_PSYC_MASTER_TRANSMIT_NONE = 0,
 472   /**
 473    * Whether this message should reset the channel state,
 474    * i.e. remove all previously stored state variables.
 475    */
 476   GNUNET_PSYC_MASTER_TRANSMIT_RESET_STATE = 1 << 0,
 477
 478   /**
 479    * Whether we need to increment the group generation counter after
 480    * transmitting this message.
 481    */
 482   GNUNET_PSYC_MASTER_TRANSMIT_INC_GROUP_GEN = 1 << 1,
 483
 484   /**
 485    * Add PSYC header variable with the hash of the current channel state.
 486    */
 487   GNUNET_PSYC_MASTER_TRANSMIT_ADD_STATE_HASH = 1 << 2
 488 };
 489
 490
 491 /**
 492  * Handle for a pending PSYC transmission operation.
 493  */
 494 struct GNUNET_PSYC_MasterTransmitHandle;
 495
 496
 497 /**
 498  * Send a message to call a method to all members in the PSYC channel.
 499  *
 500  * @param master Handle to the PSYC channel.
 501  * @param method_name Which method should be invoked.
 502  * @param notify_mod Function to call to obtain modifiers.
 503  * @param notify_data Function to call to obtain fragments of the data.
 504  * @param notify_cls Closure for @a notify_mod and @a notify_data.
 505  * @param flags Flags for the message being transmitted.
 506  * @return Transmission handle, NULL on error (i.e. more than one request queued).
 507  */
 508 struct GNUNET_PSYC_MasterTransmitHandle *
 509 GNUNET_PSYC_master_transmit (struct GNUNET_PSYC_Master *master,
 510                              const char *method_name,
 511                              GNUNET_PSYC_TransmitNotifyModifier notify_mod,
 512                              GNUNET_PSYC_TransmitNotifyData notify_data,
 513                              void *notify_cls,
 514                              enum GNUNET_PSYC_MasterTransmitFlags flags);
 515
 516
 517 /**
 518  * Resume transmission to the channel.
 519  *
 520  * @param th Handle of the request that is being resumed.
 521  */
 522 void
 523 GNUNET_PSYC_master_transmit_resume (struct GNUNET_PSYC_MasterTransmitHandle *th);
 524
 525
 526 /**
 527  * Abort transmission request to channel.
 528  *
 529  * @param th Handle of the request that is being aborted.
 530  */
 531 void
 532 GNUNET_PSYC_master_transmit_cancel (struct GNUNET_PSYC_MasterTransmitHandle *th);
 533
 534
 535 /**
 536  * Stop a PSYC master channel.
 537  *
 538  * @param master PSYC channel master to stop.
 539  */
 540 void
 541 GNUNET_PSYC_master_stop (struct GNUNET_PSYC_Master *master);
 542
 543
 544 /**
 545  * Handle for a PSYC channel slave.
 546  */
 547 struct GNUNET_PSYC_Slave;
 548
 549
 550 /**
 551  * Function called after the slave joined.
 552  *
 553  * @param cls Closure.
 554  * @param max_message_id Last message ID sent to the channel.
 555  */
 556 typedef void
 557 (*GNUNET_PSYC_SlaveJoinCallback) (void *cls, uint64_t max_message_id);
 558
 559
 560 /**
 561  * Join a PSYC channel.
 562  *
 563  * The entity joining is always the local peer.  The user must immediately use
 564  * the GNUNET_PSYC_slave_transmit() functions to transmit a @e join_msg to the
 565  * channel; if the join request succeeds, the channel state (and @e recent
 566  * method calls) will be replayed to the joining member.  There is no explicit
 567  * notification on failure (as the channel may simply take days to approve,
 568  * and disapproval is simply being ignored).
 569  *
 570  * @param cfg Configuration to use.
 571  * @param channel_key ECC public key that identifies the channel we wish to join.
 572  * @param slave_key ECC private-public key pair that identifies the slave, and
 573  *        used by multicast to sign the join request and subsequent unicast
 574  *        requests sent to the master.
 575  * @param origin Peer identity of the origin.
 576  * @param relay_count Number of peers in the @a relays array.
 577  * @param relays Peer identities of members of the multicast group, which serve
 578  *        as relays and used to join the group at.
 579  * @param message_cb Function to invoke on message parts received from the
 580  *        channel, typically at least contains method handlers for @e join and
 581  *        @e part.
 582  * @param join_cb function invoked once we have joined with the current
 583  *        message ID of the channel
 584  * @param slave_joined_cb Function to invoke when a peer wants to join.
 585  * @param cls Closure for @a message_cb and @a slave_joined_cb.
 586  * @param method_name Method name for the join request.
 587  * @param env Environment containing transient variables for the request, or NULL.
 588  * @param data Payload for the join message.
 589  * @param data_size Number of bytes in @a data.
 590  * @return Handle for the slave, NULL on error.
 591  */
 592 struct GNUNET_PSYC_Slave *
 593 GNUNET_PSYC_slave_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
 594                         const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
 595                         const struct GNUNET_CRYPTO_EddsaPrivateKey *slave_key,
 596                         const struct GNUNET_PeerIdentity *origin,
 597                         uint32_t relay_count,
 598                         const struct GNUNET_PeerIdentity *relays,
 599                         GNUNET_PSYC_MessageCallback message_cb,
 600                         GNUNET_PSYC_JoinCallback join_cb,
 601                         GNUNET_PSYC_SlaveJoinCallback slave_joined_cb,
 602                         void *cls,
 603                         const char *method_name,
 604                         const struct GNUNET_ENV_Environment *env,
 605                         const void *data,
 606                         uint16_t data_size);
 607
 608
 609 /**
 610  * Part a PSYC channel.
 611  *
 612  * Will terminate the connection to the PSYC service.  Polite clients should
 613  * first explicitly send a part request (via GNUNET_PSYC_slave_transmit()).
 614  *
 615  * @param slave Slave handle.
 616  */
 617 void
 618 GNUNET_PSYC_slave_part (struct GNUNET_PSYC_Slave *slave);
 619
 620
 621 /**
 622  * Flags for transmitting messages to the channel master by a slave.
 623  */
 624 enum GNUNET_PSYC_SlaveTransmitFlags
 625 {
 626   GNUNET_PSYC_SLAVE_TRANSMIT_NONE = 0
 627 };
 628
 629
 630 /**
 631  * Handle for a pending PSYC transmission operation.
 632  */
 633 struct GNUNET_PSYC_SlaveTransmitHandle;
 634
 635
 636 /**
 637  * Request a message to be sent to the channel master.
 638  *
 639  * @param slave Slave handle.
 640  * @param method_name Which (PSYC) method should be invoked (on host).
 641  * @param notify_mod Function to call to obtain modifiers.
 642  * @param notify_data Function to call to obtain fragments of the data.
 643  * @param notify_cls Closure for @a notify.
 644  * @param flags Flags for the message being transmitted.
 645  * @return Transmission handle, NULL on error (i.e. more than one request queued).
 646  */
 647 struct GNUNET_PSYC_SlaveTransmitHandle *
 648 GNUNET_PSYC_slave_transmit (struct GNUNET_PSYC_Slave *slave,
 649                             const char *method_name,
 650                             GNUNET_PSYC_TransmitNotifyModifier notify_mod,
 651                             GNUNET_PSYC_TransmitNotifyData notify_data,
 652                             void *notify_cls,
 653                             enum GNUNET_PSYC_SlaveTransmitFlags flags);
 654
 655
 656 /**
 657  * Resume transmission to the master.
 658  *
 659  * @param th Handle of the request that is being resumed.
 660  */
 661 void
 662 GNUNET_PSYC_slave_transmit_resume (struct GNUNET_PSYC_MasterTransmitHandle *th);
 663
 664
 665 /**
 666  * Abort transmission request to master.
 667  *
 668  * @param th Handle of the request that is being aborted.
 669  */
 670 void
 671 GNUNET_PSYC_slave_transmit_cancel (struct GNUNET_PSYC_SlaveTransmitHandle *th);
 672
 673
 674 /**
 675  * Handle to access PSYC channel operations for both the master and slaves.
 676  */
 677 struct GNUNET_PSYC_Channel;
 678
 679
 680 /**
 681  * Convert a channel @a master to a @e channel handle to access the @e channel
 682  * APIs.
 683  *
 684  * @param master Channel master handle.
 685  * @return Channel handle, valid for as long as @a master is valid.
 686  */
 687 struct GNUNET_PSYC_Channel *
 688 GNUNET_PSYC_master_get_channel (struct GNUNET_PSYC_Master *master);
 689
 690
 691 /**
 692  * Convert @a slave to a @e channel handle to access the @e channel APIs.
 693  *
 694  * @param slave Slave handle.
 695  * @return Channel handle, valid for as long as @a slave is valid.
 696  */
 697 struct GNUNET_PSYC_Channel *
 698 GNUNET_PSYC_slave_get_channel (struct GNUNET_PSYC_Slave *slave);
 699
 700
 701 /**
 702  * Add a slave to the channel's membership list.
 703  *
 704  * Note that this will NOT generate any PSYC traffic, it will merely update the
 705  * local database to modify how we react to <em>membership test</em> queries.
 706  * The channel master still needs to explicitly transmit a @e join message to
 707  * notify other channel members and they then also must still call this function
 708  * in their respective methods handling the @e join message.  This way, how @e
 709  * join and @e part operations are exactly implemented is still up to the
 710  * application; for example, there might be a @e part_all method to kick out
 711  * everyone.
 712  *
 713  * Note that channel slaves are explicitly trusted to execute such methods
 714  * correctly; not doing so correctly will result in either denying other slaves
 715  * access or offering access to channel data to non-members.
 716  *
 717  * @param channel Channel handle.
 718  * @param slave_key Identity of channel slave to add.
 719  * @param announced_at ID of the message that announced the membership change.
 720  * @param effective_since Addition of slave is in effect since this message ID.
 721  */
 722 void
 723 GNUNET_PSYC_channel_slave_add (struct GNUNET_PSYC_Channel *channel,
 724                                const struct GNUNET_CRYPTO_EddsaPublicKey *slave_key,
 725                                uint64_t announced_at,
 726                                uint64_t effective_since);
 727
 728
 729 /**
 730  * Remove a slave from the channel's membership list.
 731  *
 732  * Note that this will NOT generate any PSYC traffic, it will merely update the
 733  * local database to modify how we react to <em>membership test</em> queries.
 734  * The channel master still needs to explicitly transmit a @e part message to
 735  * notify other channel members and they then also must still call this function
 736  * in their respective methods handling the @e part message.  This way, how
 737  * @e join and @e part operations are exactly implemented is still up to the
 738  * application; for example, there might be a @e part_all message to kick out
 739  * everyone.
 740  *
 741  * Note that channel members are explicitly trusted to perform these
 742  * operations correctly; not doing so correctly will result in either
 743  * denying members access or offering access to channel data to
 744  * non-members.
 745  *
 746  * @param channel Channel handle.
 747  * @param slave_key Identity of channel slave to remove.
 748  * @param announced_at ID of the message that announced the membership change.
 749  */
 750 void
 751 GNUNET_PSYC_channel_slave_remove (struct GNUNET_PSYC_Channel *channel,
 752                                   const struct GNUNET_CRYPTO_EddsaPublicKey
 753                                   *slave_key,
 754                                   uint64_t announced_at);
 755
 756
 757 /**
 758  * Function called to inform a member about stored state values for a channel.
 759  *
 760  * @param cls Closure.
 761  * @param name Name of the state variable.  A NULL value indicates that there
 762  *        are no more state variables to be returned.
 763  * @param value Value of the state variable.
 764  * @param value_size Number of bytes in @a value.
 765  */
 766 typedef void
 767 (*GNUNET_PSYC_StateCallback) (void *cls,
 768                               const char *name,
 769                               const void *value,
 770                               size_t value_size);
 771
 772
 773 /**
 774  * Function called when a requested operation has finished.
 775  *
 776  * @param cls Closure.
 777  */
 778 typedef void
 779 (*GNUNET_PSYC_FinishCallback) (void *cls);
 780
 781
 782 /**
 783  * Handle to a story telling operation.
 784  */
 785 struct GNUNET_PSYC_Story;
 786
 787
 788 /**
 789  * Request to be told the message history of the channel.
 790  *
 791  * Historic messages (but NOT the state at the time) will be replayed (given to
 792  * the normal method handlers) if available and if access is permitted.
 793  *
 794  * To get the latest message, use 0 for both the start and end message ID.
 795  *
 796  * @param channel Which channel should be replayed?
 797  * @param start_message_id Earliest interesting point in history.
 798  * @param end_message_id Last (exclusive) interesting point in history.
 799  * @param message_cb Function to invoke on message parts received from the story.
 800  * @param finish_cb Function to call when the requested story has been fully
 801  *        told (counting message IDs might not suffice, as some messages
 802  *        might be secret and thus the listener would not know the story is
 803  *        finished without being told explicitly); once this function
 804  *        has been called, the client must not call
 805  *        GNUNET_PSYC_channel_story_tell_cancel() anymore.
 806  * @param cls Closure for the callbacks.
 807  * @return Handle to cancel story telling operation.
 808  */
 809 struct GNUNET_PSYC_Story *
 810 GNUNET_PSYC_channel_story_tell (struct GNUNET_PSYC_Channel *channel,
 811                                 uint64_t start_message_id,
 812                                 uint64_t end_message_id,
 813                                 GNUNET_PSYC_MessageCallback message_cb,
 814                                 GNUNET_PSYC_FinishCallback finish_cb,
 815                                 void *cls);
 816
 817
 818 /**
 819  * Abort story telling.
 820  *
 821  * This function must not be called from within method handlers (as given to
 822  * GNUNET_PSYC_slave_join()) of the slave.
 823  *
 824  * @param story Story telling operation to stop.
 825  */
 826 void
 827 GNUNET_PSYC_channel_story_tell_cancel (struct GNUNET_PSYC_Story *story);
 828
 829
 830 /**
 831  * Handle for a state query operation.
 832  */
 833 struct GNUNET_PSYC_StateQuery;
 834
 835
 836 /**
 837  * Retrieve the best matching channel state variable.
 838  *
 839  * If the requested variable name is not present in the state, the nearest
 840  * less-specific name is matched; for example, requesting "_a_b" will match "_a"
 841  * if "_a_b" does not exist.
 842  *
 843  * @param channel Channel handle.
 844  * @param full_name Full name of the requested variable, the actual variable
 845  *        returned might have a shorter name..
 846  * @param cb Function called once when a matching state variable is found.
 847  *        Not called if there's no matching state variable.
 848  * @param cb_cls Closure for the callbacks.
 849  * @return Handle that can be used to cancel the query operation.
 850  */
 851 struct GNUNET_PSYC_StateQuery *
 852 GNUNET_PSYC_channel_state_get (struct GNUNET_PSYC_Channel *channel,
 853                                const char *full_name,
 854                                GNUNET_PSYC_StateCallback cb,
 855                                void *cb_cls);
 856
 857
 858 /**
 859  * Return all channel state variables whose name matches a given prefix.
 860  *
 861  * A name matches if it starts with the given @a name_prefix, thus requesting
 862  * the empty prefix ("") will match all values; requesting "_a_b" will also
 863  * return values stored under "_a_b_c".
 864  *
 865  * The @a state_cb is invoked on all matching state variables asynchronously, as
 866  * the state is stored in and retrieved from the PSYCstore,
 867  *
 868  * @param channel Channel handle.
 869  * @param name_prefix Prefix of the state variable name to match.
 870  * @param cb Function to call with the matching state variables.
 871  * @param cb_cls Closure for the callbacks.
 872  * @return Handle that can be used to cancel the query operation.
 873  */
 874 struct GNUNET_PSYC_StateQuery *
 875 GNUNET_PSYC_channel_state_get_prefix (struct GNUNET_PSYC_Channel *channel,
 876                                       const char *name_prefix,
 877                                       GNUNET_PSYC_StateCallback cb,
 878                                       void *cb_cls);
 879
 880
 881 /**
 882  * Cancel a state query operation.
 883  *
 884  * @param query Handle for the operation to cancel.
 885  */
 886 void
 887 GNUNET_PSYC_channel_state_get_cancel (struct GNUNET_PSYC_StateQuery *query);
 888
 889
 890 #if 0                           /* keep Emacsens' auto-indent happy */
 891 {
 892 #endif
 893 #ifdef __cplusplus
 894 }
 895 #endif
 896
 897 /* ifndef GNUNET_PSYC_SERVICE_H */
 898 #endif
 899 /* end of gnunet_psyc_service.h */