src/include/gnunet_psyc_service.h

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