/*
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
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
+ GNUnet is free software: you can redistribute it and/or modify it
+ under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA.
+ Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
- * @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
/**
* 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.
/**
* Maximum size of a multicast message fragment.
*/
-#define GNUNET_MULTICAST_FRAGMENT_MAX_SIZE 63 * 1024
+#define GNUNET_MULTICAST_FRAGMENT_MAX_SIZE (63 * 1024)
#define GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD \
- GNUNET_MULTICAST_FRAGMENT_MAX_SIZE \
- - sizeof (struct GNUNET_MULTICAST_MessageHeader)
+ (GNUNET_MULTICAST_FRAGMENT_MAX_SIZE \
+ - sizeof (struct GNUNET_MULTICAST_MessageHeader))
/**
*
* @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.
*/
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);
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.
*/
* @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.
*/
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);
* @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.
*/
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,
/**
* Start a multicast group.
*
- * Will advertise the origin in the P2P overlay network under the respective
- * public key so that other peer can find this peer to join it. Peers that
- * issue GNUNET_MULTICAST_member_join() can then transmit a join request to
- * either an existing group member or to the origin. If the joining is
+ * Peers that issue GNUNET_MULTICAST_member_join() can transmit a join request
+ * to either an existing group member or to the origin. If the joining is
* approved, the member is cleared for @e replay and will begin to receive
* messages transmitted to the group. If joining is disapproved, the failed
* candidate will be given a response. Members in the group can send messages
- * to the origin (one at a time).
+ * to the origin.
+ *
+ * TODO: This function could optionally offer to advertise the origin in the
+ * P2P overlay network(where?) under the respective public key so that other
+ * peers can find an alternate PeerId to join it. Higher level protocols may
+ * however provide other means of solving the problem of the offline host
+ * (see secushare specs about that) and therefore merely need a way to provide
+ * a list of possible PeerIds.
*
* @param cfg
* Configuration to use.
* data. If 0 is returned in @a data_size the transmission is paused,
* and can be resumed with GNUNET_MULTICAST_origin_to_all_resume().
* #GNUNET_YES if this completes the transmission (all data supplied)
+ * @deprecated should move to MQ-style API!
*/
typedef int
(*GNUNET_MULTICAST_OriginTransmitNotify) (void *cls,
* Closure for @a notify.
*
* @return NULL on error (i.e. request already pending).
+ * @deprecated should move to MQ-style API!
*/
struct GNUNET_MULTICAST_OriginTransmitHandle *
GNUNET_MULTICAST_origin_to_all (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
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,
* @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);
/**
* @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.
*/
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);
/**
* data. If 0 is returned in @a data_size the transmission is paused,
* and can be resumed with GNUNET_MULTICAST_member_to_origin_resume().
* #GNUNET_YES if this completes the transmission (all data supplied)
+ * @deprecated should move to MQ-style API!
*/
typedef int
(*GNUNET_MULTICAST_MemberTransmitNotify) (void *cls,
* Closure for @a notify.
*
* @return Handle to cancel request, NULL on error (i.e. request already pending).
+ * @deprecated should move to MQ-style API!
*/
struct GNUNET_MULTICAST_MemberTransmitHandle *
GNUNET_MULTICAST_member_to_origin (struct GNUNET_MULTICAST_Member *member,
/* ifndef GNUNET_MULTICAST_SERVICE_H */
#endif
-/* end of gnunet_multicast_service.h */
+
+/** @} */ /* end of group */
projects / oweals / gnunet.git / blobdiff