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