src/include/gnunet_multicast_service.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2012, 2013 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @author Gabor X Toth
  23  * @author Christian Grothoff
  24  *
  25  * @file
  26  * Multicast service; multicast messaging via CADET
  27  *
  28  * @defgroup multicast  Multicast service
  29  * Multicast messaging via CADET.
  30  * @{
  31  */
  32
  33 #ifndef GNUNET_MULTICAST_SERVICE_H
  34 #define GNUNET_MULTICAST_SERVICE_H
  35
  36 #ifdef __cplusplus
  37 extern "C"
  38 {
  39 #if 0                           /* keep Emacsens' auto-indent happy */
  40 }
  41 #endif
  42 #endif
  43
  44 #include "gnunet_util_lib.h"
  45 #include "gnunet_transport_service.h"
  46
  47 /**
  48  * Version number of GNUnet-multicast API.
  49  */
  50 #define GNUNET_MULTICAST_VERSION 0x00000000
  51
  52 /**
  53  * Opaque handle for a multicast group member.
  54  */
  55 struct GNUNET_MULTICAST_Member;
  56
  57 /**
  58  * Handle for the origin of a multicast group.
  59  */
  60 struct GNUNET_MULTICAST_Origin;
  61
  62
  63 enum GNUNET_MULTICAST_MessageFlags
  64 {
  65   /**
  66    * First fragment of a message.
  67    */
  68   GNUNET_MULTICAST_MESSAGE_FIRST_FRAGMENT = 1 << 0,
  69
  70   /**
  71    * Last fragment of a message.
  72    */
  73   GNUNET_MULTICAST_MESSAGE_LAST_FRAGMENT = 1 << 1,
  74
  75   /**
  76    * OR'ed flags if message is not fragmented.
  77    */
  78   GNUNET_MULTICAST_MESSAGE_NOT_FRAGMENTED
  79     = GNUNET_MULTICAST_MESSAGE_FIRST_FRAGMENT
  80   | GNUNET_MULTICAST_MESSAGE_LAST_FRAGMENT,
  81
  82   /**
  83    * Historic message, used only locally when replaying messages from local
  84    * storage.
  85    */
  86   GNUNET_MULTICAST_MESSAGE_HISTORIC = 1 << 30
  87
  88 };
  89
  90
  91 GNUNET_NETWORK_STRUCT_BEGIN
  92
  93 /**
  94  * Header of a multicast message fragment.
  95  *
  96  * This format is public as the replay mechanism must replay message fragments using the
  97  * same format.  This is needed as we want to integrity-check message fragments within
  98  * the multicast layer to avoid multicasting mal-formed messages.
  99  */
 100 struct GNUNET_MULTICAST_MessageHeader
 101 {
 102
 103   /**
 104    * Header for all multicast message fragments from the origin.
 105    */
 106   struct GNUNET_MessageHeader header;
 107
 108   /**
 109    * Number of hops this message fragment has taken since the origin.
 110    *
 111    * Helpful to determine shortest paths to the origin among honest peers for
 112    * unicast requests from members.  Updated at each hop and thus not signed and
 113    * not secure.
 114    */
 115   uint32_t hop_counter GNUNET_PACKED;
 116
 117   /**
 118    * ECC signature of the message fragment.
 119    *
 120    * Signature must match the public key of the multicast group.
 121    */
 122   struct GNUNET_CRYPTO_EddsaSignature signature;
 123
 124   /**
 125    * Purpose for the signature and size of the signed data.
 126    */
 127   struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
 128
 129   /**
 130    * Number of the message fragment, monotonically increasing starting from 1.
 131    */
 132   uint64_t fragment_id GNUNET_PACKED;
 133
 134   /**
 135    * Byte offset of this @e fragment of the @e message.
 136    */
 137   uint64_t fragment_offset GNUNET_PACKED;
 138
 139   /**
 140    * Number of the message this fragment belongs to.
 141    *
 142    * Set in GNUNET_MULTICAST_origin_to_all().
 143    */
 144   uint64_t message_id GNUNET_PACKED;
 145
 146   /**
 147    * Counter that monotonically increases whenever a member parts the group.
 148    *
 149    * Set in GNUNET_MULTICAST_origin_to_all().
 150    *
 151    * It has significance in case of replay requests: when a member has missed
 152    * messages and gets a replay request: in this case if the @a group_generation
 153    * is still the same before and after the missed messages, it means that no
 154    * @e join or @e part operations happened during the missed messages.
 155    */
 156   uint64_t group_generation GNUNET_PACKED;
 157
 158   /**
 159    * Flags for this message fragment.
 160    *
 161    * @see enum GNUNET_MULTICAST_MessageFlags
 162    */
 163   uint32_t flags GNUNET_PACKED;
 164
 165   /* Followed by message body. */
 166 };
 167
 168
 169 /**
 170  * Header of a request from a member to the origin.
 171  */
 172 struct GNUNET_MULTICAST_RequestHeader
 173 {
 174   /**
 175    * Header for all requests from a member to the origin.
 176    */
 177   struct GNUNET_MessageHeader header;
 178
 179   /**
 180    * Public key of the sending member.
 181    */
 182   struct GNUNET_CRYPTO_EcdsaPublicKey member_pub_key;
 183
 184   /**
 185    * ECC signature of the request fragment.
 186    *
 187    * Signature must match the public key of the multicast group.
 188    */
 189   struct GNUNET_CRYPTO_EcdsaSignature signature;
 190
 191   /**
 192    * Purpose for the signature and size of the signed data.
 193    */
 194   struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
 195
 196   /**
 197    * Number of the request fragment.
 198    * Monotonically increasing from 1.
 199    */
 200   uint64_t fragment_id GNUNET_PACKED;
 201
 202   /**
 203    * Byte offset of this @e fragment of the @e request.
 204    */
 205   uint64_t fragment_offset GNUNET_PACKED;
 206
 207   /**
 208    * Number of the request this fragment belongs to.
 209    *
 210    * Set in GNUNET_MULTICAST_origin_to_all().
 211    */
 212   uint64_t request_id GNUNET_PACKED;
 213
 214   /**
 215    * Flags for this request.
 216    */
 217   enum GNUNET_MULTICAST_MessageFlags flags GNUNET_PACKED;
 218
 219   /* Followed by request body. */
 220 };
 221
 222 GNUNET_NETWORK_STRUCT_END
 223
 224
 225 /**
 226  * Maximum size of a multicast message fragment.
 227  */
 228 #define GNUNET_MULTICAST_FRAGMENT_MAX_SIZE 63 * 1024
 229
 230 #define GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD           \
 231   GNUNET_MULTICAST_FRAGMENT_MAX_SIZE                    \
 232   - sizeof (struct GNUNET_MULTICAST_MessageHeader)
 233
 234
 235 /**
 236  * Handle that identifies a join request.
 237  *
 238  * Used to match calls to #GNUNET_MULTICAST_JoinRequestCallback to the
 239  * corresponding calls to #GNUNET_MULTICAST_join_decision().
 240  */
 241 struct GNUNET_MULTICAST_JoinHandle;
 242
 243
 244 /**
 245  * Function to call with the decision made for a join request.
 246  *
 247  * Must be called once and only once in response to an invocation of the
 248  * #GNUNET_MULTICAST_JoinRequestCallback.
 249  *
 250  * @param jh
 251  *        Join request handle.
 252  * @param is_admitted
 253  *        #GNUNET_YES    if the join is approved,
 254  *        #GNUNET_NO     if it is disapproved,
 255  *        #GNUNET_SYSERR if we cannot answer the request.
 256  * @param relay_count
 257  *        Number of relays given.
 258  * @param relays
 259  *        Array of suggested peers that might be useful relays to use
 260  *        when joining the multicast group (essentially a list of peers that
 261  *        are already part of the multicast group and might thus be willing
 262  *        to help with routing).  If empty, only this local peer (which must
 263  *        be the multicast origin) is a good candidate for building the
 264  *        multicast tree.  Note that it is unnecessary to specify our own
 265  *        peer identity in this array.
 266  * @param join_resp
 267  *        Message to send in response to the joining peer;
 268  *        can also be used to redirect the peer to a different group at the
 269  *        application layer; this response is to be transmitted to the
 270  *        peer that issued the request even if admission is denied.
 271  */
 272 struct GNUNET_MULTICAST_ReplayHandle *
 273 GNUNET_MULTICAST_join_decision (struct GNUNET_MULTICAST_JoinHandle *jh,
 274                                 int is_admitted,
 275                                 uint16_t relay_count,
 276                                 const struct GNUNET_PeerIdentity *relays,
 277                                 const struct GNUNET_MessageHeader *join_resp);
 278
 279
 280 /**
 281  * Method called whenever another peer wants to join the multicast group.
 282  *
 283  * Implementations of this function must call GNUNET_MULTICAST_join_decision()
 284  * with the decision.
 285  *
 286  * @param cls
 287  *        Closure.
 288  * @param member_pub_key
 289  *        Public key of the member requesting join.
 290  * @param join_msg
 291  *        Application-dependent join message from the new member.
 292  * @param jh
 293  *        Join handle to pass to GNUNET_MULTICAST_join_decison().
 294  */
 295 typedef void
 296 (*GNUNET_MULTICAST_JoinRequestCallback) (void *cls,
 297                                          const struct GNUNET_CRYPTO_EcdsaPublicKey *member_pub_key,
 298                                          const struct GNUNET_MessageHeader *join_msg,
 299                                          struct GNUNET_MULTICAST_JoinHandle *jh);
 300
 301
 302 /**
 303  * Method called to inform about the decision in response to a join request.
 304  *
 305  * If @a is_admitted is not #GNUNET_YES, then the multicast service disconnects
 306  * the client and the multicast member handle returned by
 307  * GNUNET_MULTICAST_member_join() is invalidated.
 308  *
 309  * @param cls
 310  *         Closure.
 311  * @param is_admitted
 312  *         #GNUNET_YES or #GNUNET_NO or #GNUNET_SYSERR
 313  * @param peer
 314  *        The peer we are connected to and the join decision is from.
 315  * @param relay_count
 316  *        Number of peers in the @a relays array.
 317  * @param relays
 318  *        Peer identities of members of the group, which serve as relays
 319  *        and can be used to join the group at.  If empty, only the origin can
 320  *        be used to connect to the group.
 321  * @param join_msg
 322  *        Application-dependent join message from the origin.
 323  */
 324 typedef void
 325 (*GNUNET_MULTICAST_JoinDecisionCallback) (void *cls,
 326                                           int is_admitted,
 327                                           const struct GNUNET_PeerIdentity *peer,
 328                                           uint16_t relay_count,
 329                                           const struct GNUNET_PeerIdentity *relays,
 330                                           const struct GNUNET_MessageHeader *join_msg);
 331
 332
 333 /**
 334  * Function called whenever a group member has transmitted a request
 335  * to the origin (other than joining or leaving).
 336  *
 337  * FIXME: need to distinguish between origin cancelling a message (some fragments
 338  * were sent, then the rest 'discarded') and the case where we got disconnected;
 339  * right now, both would mean 'msg' is NULL, but they could be quite different...
 340  * So the semantics from the receiver side of
 341  * GNUNET_MULTICAST_member_to_origin_cancel() are not clear here.   Maybe we
 342  * should do something with the flags in this case?
 343  *
 344  * @param cls
 345  *        Closure (set from GNUNET_MULTICAST_origin_start).
 346  * @param sender
 347  *        Identity of the sender.
 348  * @param req
 349  *        Request to the origin.
 350  * @param flags
 351  *        Flags for the request.
 352  */
 353 typedef void
 354 (*GNUNET_MULTICAST_RequestCallback) (void *cls,
 355                                      const struct GNUNET_MULTICAST_RequestHeader *req);
 356
 357
 358 /**
 359  * Function called whenever a group member is receiving a message fragment from
 360  * the origin.
 361  *
 362  * If admission to the group is denied, this function is called once with the
 363  * response of the @e origin (as given to GNUNET_MULTICAST_join_decision()) and
 364  * then a second time with NULL to indicate that the connection failed for good.
 365  *
 366  * FIXME: need to distinguish between origin cancelling a message (some fragments
 367  * were sent, then the rest 'discarded') and the case where we got disconnected;
 368  * right now, both would mean 'msg' is NULL, but they could be quite different...
 369  * So the semantics from the receiver side of
 370  * GNUNET_MULTICAST_origin_to_all_cancel() are not clear here.
 371  *
 372  * @param cls
 373  *        Closure (set from GNUNET_MULTICAST_member_join())
 374  * @param msg
 375  *        Message from the origin, NULL if the origin shut down
 376  *        (or we were kicked out, and we should thus call
 377  *        GNUNET_MULTICAST_member_part() next)
 378  */
 379 typedef void
 380 (*GNUNET_MULTICAST_MessageCallback) (void *cls,
 381                                      const struct GNUNET_MULTICAST_MessageHeader *msg);
 382
 383
 384 /**
 385  * Opaque handle to a replay request from the multicast service.
 386  */
 387 struct GNUNET_MULTICAST_ReplayHandle;
 388
 389
 390 /**
 391  * Functions with this signature are called whenever the multicast service needs
 392  * a message fragment to be replayed by fragment_id.
 393  *
 394  * Implementations of this function MUST call GNUNET_MULTICAST_replay() ONCE
 395  * (with a message or an error); however, if the origin is destroyed or the
 396  * group is left, the replay handle must no longer be used.
 397  *
 398  * @param cls
 399  *        Closure (set from GNUNET_MULTICAST_origin_start()
 400  *        or GNUNET_MULTICAST_member_join()).
 401  * @param member_pub_key
 402  *        The member requesting replay.
 403  * @param fragment_id
 404  *        Which message fragment should be replayed.
 405  * @param flags
 406  *        Flags for the replay.
 407  * @param rh
 408  *        Handle to pass to message transmit function.
 409  */
 410 typedef void
 411 (*GNUNET_MULTICAST_ReplayFragmentCallback) (void *cls,
 412                                             const struct GNUNET_CRYPTO_EcdsaPublicKey *member_pub_key,
 413                                             uint64_t fragment_id,
 414                                             uint64_t flags,
 415                                             struct GNUNET_MULTICAST_ReplayHandle *rh);
 416
 417 /**
 418  * Functions with this signature are called whenever the multicast service needs
 419  * a message fragment to be replayed by message_id and fragment_offset.
 420  *
 421  * Implementations of this function MUST call GNUNET_MULTICAST_replay() ONCE
 422  * (with a message or an error); however, if the origin is destroyed or the
 423  * group is left, the replay handle must no longer be used.
 424  *
 425  * @param cls
 426  *        Closure (set from GNUNET_MULTICAST_origin_start()
 427  *        or GNUNET_MULTICAST_member_join()).
 428  * @param member_pub_key
 429  *        The member requesting replay.
 430  * @param message_id
 431  *        Which message should be replayed.
 432  * @param fragment_offset
 433  *        Offset of the fragment within of @a message_id to be replayed.
 434  * @param flags
 435  *        Flags for the replay.
 436  * @param rh
 437  *        Handle to pass to message transmit function.
 438  */
 439 typedef void
 440 (*GNUNET_MULTICAST_ReplayMessageCallback) (void *cls,
 441                                            const struct GNUNET_CRYPTO_EcdsaPublicKey *member_pub_key,
 442                                            uint64_t message_id,
 443                                            uint64_t fragment_offset,
 444                                            uint64_t flags,
 445                                            struct GNUNET_MULTICAST_ReplayHandle *rh);
 446
 447
 448 /**
 449  * Possible error codes during replay.
 450  */
 451 enum GNUNET_MULTICAST_ReplayErrorCode
 452 {
 453
 454   /**
 455    * Everything is fine.
 456    */
 457   GNUNET_MULTICAST_REC_OK = 0,
 458
 459   /**
 460    * Message fragment not found in the message store.
 461    *
 462    * Either discarded if it is too old, or not arrived yet if this member has
 463    * missed some messages.
 464    */
 465   GNUNET_MULTICAST_REC_NOT_FOUND = 1,
 466
 467   /**
 468    * Fragment ID counter was larger than the highest counter this
 469    * replay function has ever encountered; thus it is likely the
 470    * origin never sent it and we're at the HEAD of the multicast
 471    * stream as far as this node is concerned.
 472    *
 473    * FIXME: needed?
 474    */
 475   GNUNET_MULTICAST_REC_PAST_HEAD = 2,
 476
 477   /**
 478    * Access is denied to the requested fragment, membership test did not pass.
 479    */
 480   GNUNET_MULTICAST_REC_ACCESS_DENIED = 3,
 481
 482   /**
 483    * Internal error (i.e. database error).  Try some other peer.
 484    */
 485   GNUNET_MULTICAST_REC_INTERNAL_ERROR = 4
 486
 487 };
 488
 489
 490 /**
 491  * Replay a message fragment for the multicast group.
 492  *
 493  * @param rh
 494  *        Replay handle identifying which replay operation was requested.
 495  * @param msg
 496  *        Replayed message fragment, NULL if not found / an error occurred.
 497  * @param ec
 498  *        Error code.  See enum GNUNET_MULTICAST_ReplayErrorCode
 499  *        If not #GNUNET_MULTICAST_REC_OK, the replay handle is invalidated.
 500  */
 501 void
 502 GNUNET_MULTICAST_replay_response (struct GNUNET_MULTICAST_ReplayHandle *rh,
 503                                   const struct GNUNET_MessageHeader *msg,
 504                                   enum GNUNET_MULTICAST_ReplayErrorCode ec);
 505
 506
 507 /**
 508  * Indicate the end of the replay session.
 509  *
 510  * Invalidates the replay handle.
 511  *
 512  * @param rh Replay session to end.
 513  */
 514 void
 515 GNUNET_MULTICAST_replay_response_end (struct GNUNET_MULTICAST_ReplayHandle *rh);
 516
 517
 518 /**
 519  * Function called to provide data for a transmission for a replay.
 520  *
 521  * @see GNUNET_MULTICAST_replay2()
 522  */
 523 typedef int
 524 (*GNUNET_MULTICAST_ReplayTransmitNotify) (void *cls,
 525                                           size_t *data_size,
 526                                           void *data);
 527
 528
 529 /**
 530  * Replay a message for the multicast group.
 531  *
 532  * @param rh
 533  *        Replay handle identifying which replay operation was requested.
 534  * @param notify
 535  *        Function to call to get the message.
 536  * @param notify_cls
 537  *        Closure for @a notify.
 538  */
 539 void
 540 GNUNET_MULTICAST_replay_response2 (struct GNUNET_MULTICAST_ReplayHandle *rh,
 541                                    GNUNET_MULTICAST_ReplayTransmitNotify notify,
 542                                    void *notify_cls);
 543
 544
 545 /**
 546  * Start a multicast group.
 547  *
 548  * Will advertise the origin in the P2P overlay network under the respective
 549  * public key so that other peer can find this peer to join it.  Peers that
 550  * issue GNUNET_MULTICAST_member_join() can then transmit a join request to
 551  * either an existing group member or to the origin.  If the joining is
 552  * approved, the member is cleared for @e replay and will begin to receive
 553  * messages transmitted to the group.  If joining is disapproved, the failed
 554  * candidate will be given a response.  Members in the group can send messages
 555  * to the origin (one at a time).
 556  *
 557  * @param cfg
 558  *        Configuration to use.
 559  * @param priv_key
 560  *        ECC key that will be used to sign messages for this
 561  *        multicast session; public key is used to identify the multicast group;
 562  * @param max_fragment_id
 563  *        Maximum fragment ID already sent to the group.
 564  *        0 for a new group.
 565  * @param join_request_cb
 566  *        Function called to approve / disapprove joining of a peer.
 567  * @param replay_frag_cb
 568  *        Function that can be called to replay a message fragment.
 569  * @param replay_msg_cb
 570  *        Function that can be called to replay a message.
 571  * @param request_cb
 572  *        Function called with message fragments from group members.
 573  * @param message_cb
 574  *        Function called with the message fragments sent to the
 575  *        network by GNUNET_MULTICAST_origin_to_all().  These message fragments
 576  *        should be stored for answering replay requests later.
 577  * @param cls
 578  *        Closure for the various callbacks that follow.
 579  *
 580  * @return Handle for the origin, NULL on error.
 581  */
 582 struct GNUNET_MULTICAST_Origin *
 583 GNUNET_MULTICAST_origin_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 584                                const struct GNUNET_CRYPTO_EddsaPrivateKey *priv_key,
 585                                uint64_t max_fragment_id,
 586                                GNUNET_MULTICAST_JoinRequestCallback join_request_cb,
 587                                GNUNET_MULTICAST_ReplayFragmentCallback replay_frag_cb,
 588                                GNUNET_MULTICAST_ReplayMessageCallback replay_msg_cb,
 589                                GNUNET_MULTICAST_RequestCallback request_cb,
 590                                GNUNET_MULTICAST_MessageCallback message_cb,
 591                                void *cls);
 592
 593 /**
 594  * Function called to provide data for a transmission from the origin to all
 595  * members.
 596  *
 597  * Note that returning #GNUNET_OK or #GNUNET_SYSERR (but not #GNUNET_NO)
 598  * invalidates the respective transmission handle.
 599  *
 600  * @param cls
 601  *        Closure.
 602  * @param[in,out] data_size
 603  *        Initially set to the number of bytes available in
 604  *        @a data, should be set to the number of bytes written to data.
 605  * @param[out] data
 606  *        Where to write the body of the message to give to the
 607  *         method. The function must copy at most @a data_size bytes to @a data.
 608  *
 609  * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
 610  *         #GNUNET_NO on success, if more data is to be transmitted later.
 611  *         Should be used if @a data_size was not big enough to take all the
 612  *         data.  If 0 is returned in @a data_size the transmission is paused,
 613  *         and can be resumed with GNUNET_MULTICAST_origin_to_all_resume().
 614  *         #GNUNET_YES if this completes the transmission (all data supplied)
 615  */
 616 typedef int
 617 (*GNUNET_MULTICAST_OriginTransmitNotify) (void *cls,
 618                                           size_t *data_size,
 619                                           void *data);
 620
 621
 622 /**
 623  * Handle for a request to send a message to all multicast group members
 624  * (from the origin).
 625  */
 626 struct GNUNET_MULTICAST_OriginTransmitHandle;
 627
 628
 629 /**
 630  * Send a message to the multicast group.
 631  *
 632  * @param origin
 633  *        Handle to the multicast group.
 634  * @param message_id
 635  *        Application layer ID for the message.  Opaque to multicast.
 636  * @param group_generation
 637  *        Group generation of the message.  Documented in
 638  *        struct GNUNET_MULTICAST_MessageHeader.
 639  * @param notify
 640  *        Function to call to get the message.
 641  * @param notify_cls
 642  *        Closure for @a notify.
 643  *
 644  * @return NULL on error (i.e. request already pending).
 645  */
 646 struct GNUNET_MULTICAST_OriginTransmitHandle *
 647 GNUNET_MULTICAST_origin_to_all (struct GNUNET_MULTICAST_Origin *origin,
 648                                 uint64_t message_id,
 649                                 uint64_t group_generation,
 650                                 GNUNET_MULTICAST_OriginTransmitNotify notify,
 651                                 void *notify_cls);
 652
 653
 654
 655 /**
 656  * Resume message transmission to multicast group.
 657  *
 658  * @param th  Transmission to cancel.
 659  */
 660 void
 661 GNUNET_MULTICAST_origin_to_all_resume (struct GNUNET_MULTICAST_OriginTransmitHandle *th);
 662
 663
 664 /**
 665  * Cancel request for message transmission to multicast group.
 666  *
 667  * @param th  Transmission to cancel.
 668  */
 669 void
 670 GNUNET_MULTICAST_origin_to_all_cancel (struct GNUNET_MULTICAST_OriginTransmitHandle *th);
 671
 672
 673 /**
 674  * Stop a multicast group.
 675  *
 676  * @param origin Multicast group to stop.
 677  */
 678 void
 679 GNUNET_MULTICAST_origin_stop (struct GNUNET_MULTICAST_Origin *origin,
 680                               GNUNET_ContinuationCallback stop_cb,
 681                               void *stop_cls);
 682
 683
 684 /**
 685  * Join a multicast group.
 686  *
 687  * The entity joining is always the local peer.  Further information about the
 688  * candidate can be provided in @a join_msg.  If the join fails, the
 689  * @a message_cb is invoked with a (failure) response and then with NULL.  If
 690  * the join succeeds, outstanding (state) messages and ongoing multicast
 691  * messages will be given to the @a message_cb until the member decides to part
 692  * the group.  The @a mem_test_cb and @a replay_cb functions may be called at
 693  * anytime by the multicast service to support relaying messages to other
 694  * members of the group.
 695  *
 696  * @param cfg
 697  *        Configuration to use.
 698  * @param group_key
 699  *        ECC public key that identifies the group to join.
 700  * @param member_pub_key
 701  *        ECC key that identifies the member
 702  *        and used to sign requests sent to the origin.
 703  * @param origin
 704  *        Peer ID of the origin to send unicast requsets to.  If NULL,
 705  *        unicast requests are sent back via multiple hops on the reverse path
 706  *        of multicast messages.
 707  * @param relay_count
 708  *        Number of peers in the @a relays array.
 709  * @param relays
 710  *        Peer identities of members of the group, which serve as relays
 711  *        and can be used to join the group at. and send the @a join_request to.
 712  *        If empty, the @a join_request is sent directly to the @a origin.
 713  * @param join_msg
 714  *        Application-dependent join message to be passed to the peer @a origin.
 715  * @param join_request_cb
 716  *        Function called to approve / disapprove joining of a peer.
 717  * @param join_decision_cb
 718  *        Function called to inform about the join decision.
 719  * @param replay_frag_cb
 720  *        Function that can be called to replay message fragments
 721  *        this peer already knows from this group. NULL if this
 722  *        client is unable to support replay.
 723  * @param replay_msg_cb
 724  *        Function that can be called to replay message fragments
 725  *        this peer already knows from this group. NULL if this
 726  *        client is unable to support replay.
 727  * @param message_cb
 728  *        Function to be called for all message fragments we
 729  *        receive from the group, excluding those our @a replay_cb
 730  *        already has.
 731  * @param cls
 732  *        Closure for callbacks.
 733  *
 734  * @return Handle for the member, NULL on error.
 735  */
 736 struct GNUNET_MULTICAST_Member *
 737 GNUNET_MULTICAST_member_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
 738                               const struct GNUNET_CRYPTO_EddsaPublicKey *group_key,
 739                               const struct GNUNET_CRYPTO_EcdsaPrivateKey *member_pub_key,
 740                               const struct GNUNET_PeerIdentity *origin,
 741                               uint16_t relay_count,
 742                               const struct GNUNET_PeerIdentity *relays,
 743                               const struct GNUNET_MessageHeader *join_request,
 744                               GNUNET_MULTICAST_JoinRequestCallback join_request_cb,
 745                               GNUNET_MULTICAST_JoinDecisionCallback join_decision_cb,
 746                               GNUNET_MULTICAST_ReplayFragmentCallback replay_frag_cb,
 747                               GNUNET_MULTICAST_ReplayMessageCallback replay_msg_cb,
 748                               GNUNET_MULTICAST_MessageCallback message_cb,
 749                               void *cls);
 750
 751 /**
 752  * Handle for a replay request.
 753  */
 754 struct GNUNET_MULTICAST_MemberReplayHandle;
 755
 756
 757 /**
 758  * Request a fragment to be replayed by fragment ID.
 759  *
 760  * Useful if messages below the @e max_known_fragment_id given when joining are
 761  * needed and not known to the client.
 762  *
 763  * @param member
 764  *        Membership handle.
 765  * @param fragment_id
 766  *        ID of a message fragment that this client would like to see replayed.
 767  * @param flags
 768  *        Additional flags for the replay request.
 769  *        It is used and defined by GNUNET_MULTICAST_ReplayFragmentCallback
 770  *
 771  * @return Replay request handle, NULL on error.
 772  */
 773 struct GNUNET_MULTICAST_MemberReplayHandle *
 774 GNUNET_MULTICAST_member_replay_fragment (struct GNUNET_MULTICAST_Member *member,
 775                                          uint64_t fragment_id,
 776                                          uint64_t flags);
 777
 778
 779 /**
 780  * Request a message fr to be replayed.
 781  *
 782  * Useful if messages below the @e max_known_fragment_id given when joining are
 783  * needed and not known to the client.
 784  *
 785  * @param member
 786  *        Membership handle.
 787  * @param message_id
 788  *        ID of the message this client would like to see replayed.
 789  * @param fragment_offset
 790  *        Offset of the fragment within the message to replay.
 791  * @param flags
 792  *        Additional flags for the replay request.
 793  *        It is used & defined by GNUNET_MULTICAST_ReplayMessageCallback
 794  *
 795  * @return Replay request handle, NULL on error.
 796  */
 797 struct GNUNET_MULTICAST_MemberReplayHandle *
 798 GNUNET_MULTICAST_member_replay_message (struct GNUNET_MULTICAST_Member *member,
 799                                         uint64_t message_id,
 800                                         uint64_t fragment_offset,
 801                                         uint64_t flags);
 802
 803
 804 /**
 805  * Cancel a replay request.
 806  *
 807  * @param rh
 808  *        Request to cancel.
 809  */
 810 void
 811 GNUNET_MULTICAST_member_replay_cancel (struct GNUNET_MULTICAST_MemberReplayHandle *rh);
 812
 813
 814 /**
 815  * Part a multicast group.
 816  *
 817  * Disconnects from all group members and invalidates the @a member handle.
 818  *
 819  * An application-dependent part message can be transmitted beforehand using
 820  * #GNUNET_MULTICAST_member_to_origin())
 821  *
 822  * @param member
 823  *        Membership handle.
 824  */
 825 void
 826 GNUNET_MULTICAST_member_part (struct GNUNET_MULTICAST_Member *member,
 827                               GNUNET_ContinuationCallback part_cb,
 828                               void *part_cls);
 829
 830
 831 /**
 832  * Function called to provide data for a transmission from a member to the origin.
 833  *
 834  * Note that returning #GNUNET_OK or #GNUNET_SYSERR (but not #GNUNET_NO)
 835  * invalidates the respective transmission handle.
 836  *
 837  * @param cls
 838  *        Closure.
 839  * @param[in,out] data_size
 840  *        Initially set to the number of bytes available in
 841  *        @a data, should be set to the number of bytes written to data.
 842  * @param[out] data
 843  *        Where to write the body of the message to give to the
 844  *        method. The function must copy at most @a data_size bytes to @a data.
 845  *
 846  * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
 847  *         #GNUNET_NO on success, if more data is to be transmitted later.
 848  *         Should be used if @a data_size was not big enough to take all the
 849  *         data.  If 0 is returned in @a data_size the transmission is paused,
 850  *         and can be resumed with GNUNET_MULTICAST_member_to_origin_resume().
 851  *         #GNUNET_YES if this completes the transmission (all data supplied)
 852  */
 853 typedef int
 854 (*GNUNET_MULTICAST_MemberTransmitNotify) (void *cls,
 855                                           size_t *data_size,
 856                                           void *data);
 857
 858
 859 /**
 860  * Handle for a message to be delivered from a member to the origin.
 861  */
 862 struct GNUNET_MULTICAST_MemberTransmitHandle;
 863
 864
 865 /**
 866  * Send a message to the origin of the multicast group.
 867  *
 868  * @param member
 869  *        Membership handle.
 870  * @param request_id
 871  *        Application layer ID for the request.  Opaque to multicast.
 872  * @param notify
 873  *        Callback to call to get the message.
 874  * @param notify_cls
 875  *        Closure for @a notify.
 876  *
 877  * @return Handle to cancel request, NULL on error (i.e. request already pending).
 878  */
 879 struct GNUNET_MULTICAST_MemberTransmitHandle *
 880 GNUNET_MULTICAST_member_to_origin (struct GNUNET_MULTICAST_Member *member,
 881                                    uint64_t request_id,
 882                                    GNUNET_MULTICAST_MemberTransmitNotify notify,
 883                                    void *notify_cls);
 884
 885
 886 /**
 887  * Resume message transmission to origin.
 888  *
 889  * @param th
 890  *        Transmission to cancel.
 891  */
 892 void
 893 GNUNET_MULTICAST_member_to_origin_resume (struct GNUNET_MULTICAST_MemberTransmitHandle *th);
 894
 895
 896 /**
 897  * Cancel request for message transmission to origin.
 898  *
 899  * @param th
 900  *        Transmission to cancel.
 901  */
 902 void
 903 GNUNET_MULTICAST_member_to_origin_cancel (struct GNUNET_MULTICAST_MemberTransmitHandle *th);
 904
 905
 906 #if 0                           /* keep Emacsens' auto-indent happy */
 907 {
 908 #endif
 909 #ifdef __cplusplus
 910 }
 911 #endif
 912
 913 /* ifndef GNUNET_MULTICAST_SERVICE_H */
 914 #endif
 915
 916 /** @} */  /* end of group */