convert fs publish to MQ

[oweals/gnunet.git] / src / include / gnunet_multicast_service.h

diff --git a/src/include/gnunet_multicast_service.h b/src/include/gnunet_multicast_service.h
index 056cfa6420fa009e9f4aa77c78343c7ece6f5dec..d6673c5aa883aa7f40268d675af9d1010cbffb91 100644 (file)
--- a/src/include/gnunet_multicast_service.h
+++ b/src/include/gnunet_multicast_service.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     Copyright (C) 2012, 2013 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2012, 2013 GNUnet e.V.
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -19,10 +19,15 @@
 */
 
 /**
- * @file include/gnunet_multicast_service.h
- * @brief multicast service; establish tunnels to distant peers
- * @author Christian Grothoff
  * @author Gabor X Toth
+ * @author Christian Grothoff
+ *
+ * @file
+ * Multicast service; multicast messaging via CADET
+ *
+ * @defgroup multicast  Multicast service
+ * Multicast messaging via CADET.
+ * @{
  */
 
 #ifndef GNUNET_MULTICAST_SERVICE_H
@@ -174,7 +179,7 @@ struct GNUNET_MULTICAST_RequestHeader
   /**
    * Public key of the sending member.
    */
-  struct GNUNET_CRYPTO_EcdsaPublicKey member_key;
+  struct GNUNET_CRYPTO_EcdsaPublicKey member_pub_key;
 
   /**
    * ECC signature of the request fragment.
@@ -280,7 +285,7 @@ GNUNET_MULTICAST_join_decision (struct GNUNET_MULTICAST_JoinHandle *jh,
  *
  * @param cls
  *        Closure.
- * @param member_key
+ * @param member_pub_key
  *        Public key of the member requesting join.
  * @param join_msg
  *        Application-dependent join message from the new member.
@@ -289,7 +294,7 @@ GNUNET_MULTICAST_join_decision (struct GNUNET_MULTICAST_JoinHandle *jh,
  */
 typedef void
 (*GNUNET_MULTICAST_JoinRequestCallback) (void *cls,
-                                         const struct GNUNET_CRYPTO_EcdsaPublicKey *member_key,
+                                         const struct GNUNET_CRYPTO_EcdsaPublicKey *member_pub_key,
                                          const struct GNUNET_MessageHeader *join_msg,
                                          struct GNUNET_MULTICAST_JoinHandle *jh);
 
@@ -376,19 +381,6 @@ typedef void
                                      const struct GNUNET_MULTICAST_MessageHeader *msg);
 
 
-/**
- * Function called with the result of an asynchronous operation.
- *
- * @see GNUNET_MULTICAST_replay_fragment()
- *
- * @param result
- *        Result of the operation.
- */
-typedef void
-(*GNUNET_MULTICAST_ResultCallback) (void *cls,
-                                    int result);
-
-
 /**
  * Opaque handle to a replay request from the multicast service.
  */
@@ -406,7 +398,7 @@ struct GNUNET_MULTICAST_ReplayHandle;
  * @param cls
  *        Closure (set from GNUNET_MULTICAST_origin_start()
  *        or GNUNET_MULTICAST_member_join()).
- * @param member_key
+ * @param member_pub_key
  *        The member requesting replay.
  * @param fragment_id
  *        Which message fragment should be replayed.
@@ -417,7 +409,7 @@ struct GNUNET_MULTICAST_ReplayHandle;
  */
 typedef void
 (*GNUNET_MULTICAST_ReplayFragmentCallback) (void *cls,
-                                            const struct GNUNET_CRYPTO_EcdsaPublicKey *member_key,
+                                            const struct GNUNET_CRYPTO_EcdsaPublicKey *member_pub_key,
                                             uint64_t fragment_id,
                                             uint64_t flags,
                                             struct GNUNET_MULTICAST_ReplayHandle *rh);
@@ -433,7 +425,7 @@ typedef void
  * @param cls
  *        Closure (set from GNUNET_MULTICAST_origin_start()
  *        or GNUNET_MULTICAST_member_join()).
- * @param member_key
+ * @param member_pub_key
  *        The member requesting replay.
  * @param message_id
  *        Which message should be replayed.
@@ -446,7 +438,7 @@ typedef void
  */
 typedef void
 (*GNUNET_MULTICAST_ReplayMessageCallback) (void *cls,
-                                           const struct GNUNET_CRYPTO_EcdsaPublicKey *member_key,
+                                           const struct GNUNET_CRYPTO_EcdsaPublicKey *member_pub_key,
                                            uint64_t message_id,
                                            uint64_t fragment_offset,
                                            uint64_t flags,
@@ -705,7 +697,7 @@ GNUNET_MULTICAST_origin_stop (struct GNUNET_MULTICAST_Origin *origin,
  *        Configuration to use.
  * @param group_key
  *        ECC public key that identifies the group to join.
- * @param member_key
+ * @param member_pub_key
  *        ECC key that identifies the member
  *        and used to sign requests sent to the origin.
  * @param origin
@@ -744,7 +736,7 @@ GNUNET_MULTICAST_origin_stop (struct GNUNET_MULTICAST_Origin *origin,
 struct GNUNET_MULTICAST_Member *
 GNUNET_MULTICAST_member_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
                               const struct GNUNET_CRYPTO_EddsaPublicKey *group_key,
-                              const struct GNUNET_CRYPTO_EcdsaPrivateKey *member_key,
+                              const struct GNUNET_CRYPTO_EcdsaPrivateKey *member_pub_key,
                               const struct GNUNET_PeerIdentity *origin,
                               uint16_t relay_count,
                               const struct GNUNET_PeerIdentity *relays,
@@ -775,19 +767,13 @@ struct GNUNET_MULTICAST_MemberReplayHandle;
  * @param flags
  *        Additional flags for the replay request.
  *        It is used and defined by GNUNET_MULTICAST_ReplayFragmentCallback
- * @param result_cb
- *        Function to call when the replayed message fragment arrives.
- * @param result_cls
- *        Closure for @a result_cb.
  *
  * @return Replay request handle, NULL on error.
  */
 struct GNUNET_MULTICAST_MemberReplayHandle *
 GNUNET_MULTICAST_member_replay_fragment (struct GNUNET_MULTICAST_Member *member,
                                          uint64_t fragment_id,
-                                         uint64_t flags,
-                                         GNUNET_MULTICAST_ResultCallback result_cb,
-                                         void *result_cb_cls);
+                                         uint64_t flags);
 
 
 /**
@@ -805,10 +791,6 @@ GNUNET_MULTICAST_member_replay_fragment (struct GNUNET_MULTICAST_Member *member,
  * @param flags
  *        Additional flags for the replay request.
  *        It is used & defined by GNUNET_MULTICAST_ReplayMessageCallback
- * @param result_cb
- *        Function to call for each replayed message fragment.
- * @param result_cls
- *        Closure for @a result_cb.
  *
  * @return Replay request handle, NULL on error.
  */
@@ -816,9 +798,7 @@ struct GNUNET_MULTICAST_MemberReplayHandle *
 GNUNET_MULTICAST_member_replay_message (struct GNUNET_MULTICAST_Member *member,
                                         uint64_t message_id,
                                         uint64_t fragment_offset,
-                                        uint64_t flags,
-                                        GNUNET_MULTICAST_ResultCallback result_cb,
-                                        void *result_cb_cls);
+                                        uint64_t flags);
 
 
 /**
@@ -932,4 +912,5 @@ GNUNET_MULTICAST_member_to_origin_cancel (struct GNUNET_MULTICAST_MemberTransmit
 
 /* ifndef GNUNET_MULTICAST_SERVICE_H */
 #endif
-/* end of gnunet_multicast_service.h */
+
+/** @} */  /* end of group */