Boston, MA 02111-1307, USA.
*/
-/**
+/**
* @file include/gnunet_multicast_service.h
* @brief multicast service; establish tunnels to distant peers
* @author Christian Grothoff
#include "gnunet_util_lib.h"
#include "gnunet_transport_service.h"
-/**
+/**
* Version number of GNUnet-multicast API.
*/
#define GNUNET_MULTICAST_VERSION 0x00000000
+/**
+ * Maximum size of a multicast message fragment.
+ */
+#define GNUNET_MULTICAST_FRAGMENT_MAX_SIZE 63 * 1024
-/**
+/**
* Opaque handle for a multicast group member.
*/
struct GNUNET_MULTICAST_Member;
-/**
+/**
* Handle for the origin of a multicast group.
*/
struct GNUNET_MULTICAST_Origin;
*/
GNUNET_MULTICAST_MESSAGE_LAST_FRAGMENT = 1 << 1,
- /**
+ /**
* OR'ed flags if message is not fragmented.
*/
GNUNET_MULTICAST_MESSAGE_NOT_FRAGMENTED
GNUNET_NETWORK_STRUCT_BEGIN
-/**
+/**
* Header of a multicast message fragment.
*
* This format is public as the replay mechanism must replay message fragments using the
struct GNUNET_MULTICAST_MessageHeader
{
- /**
+ /**
* Header for all multicast message fragments from the origin.
*/
struct GNUNET_MessageHeader header;
- /**
+ /**
* Number of hops this message fragment has taken since the origin.
*
* Helpful to determine shortest paths to the origin among honest peers for
*/
uint32_t hop_counter GNUNET_PACKED;
- /**
+ /**
* ECC signature of the message fragment.
*
* Signature must match the public key of the multicast group.
*/
struct GNUNET_CRYPTO_EccSignature signature;
- /**
+ /**
* Purpose for the signature and size of the signed data.
*/
struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
- /**
+ /**
* Number of the message fragment, monotonically increasing.
*/
uint64_t fragment_id GNUNET_PACKED;
- /**
+ /**
* Byte offset of this @e fragment of the @e message.
*/
uint64_t fragment_offset GNUNET_PACKED;
- /**
+ /**
* Number of the message this fragment belongs to.
*
* Set in GNUNET_MULTICAST_origin_to_all().
*/
uint64_t message_id GNUNET_PACKED;
- /**
+ /**
* Counter that monotonically increases whenever a member parts the group.
*
* Set in GNUNET_MULTICAST_origin_to_all().
GNUNET_NETWORK_STRUCT_END
-/**
+/**
* Handle that identifies a join request.
*
* Used to match calls to #GNUNET_MULTICAST_JoinCallback to the
struct GNUNET_MULTICAST_JoinHandle;
-/**
+/**
* Function to call with the decision made for a join request.
*
* Must be called once and only once in response to an invocation of the
const struct GNUNET_MessageHeader *join_response);
-/**
+/**
* Method called whenever another peer wants to join the multicast group.
*
* Implementations of this function must call GNUNET_MULTICAST_join_decision()
struct GNUNET_MULTICAST_JoinHandle *jh);
-/**
+/**
* Handle to pass back for the answer of a membership test.
*/
struct GNUNET_MULTICAST_MembershipTestHandle;
-/**
+/**
* Call informing multicast about the decision taken for a membership test.
*
* @param mth Handle that was given for the query.
int result);
-/**
+/**
* Method called to test if a member was in the group at a particular time.
*
* It is called when a replay request is received to determine if the requested
struct GNUNET_MULTICAST_MembershipTestHandle *mth);
-/**
+/**
* Function called whenever a group member has transmitted a request
* to the origin (other than joining or leaving).
*
* FIXME: need to distinguish between origin cancelling a message (some fragments
* were sent, then the rest 'discarded') and the case where we got disconnected;
* right now, both would mean 'msg' is NULL, but they could be quite different...
- * So the semantics from the receiver side of
+ * So the semantics from the receiver side of
* GNUNET_MULTICAST_member_to_origin_cancel() are not clear here. Maybe we
* should do something with the flags in this case?
*
enum GNUNET_MULTICAST_MessageFlags flags);
-/**
+/**
* Function called whenever a group member is receiving a message fragment from
* the origin.
*
* FIXME: need to distinguish between origin cancelling a message (some fragments
* were sent, then the rest 'discarded') and the case where we got disconnected;
* right now, both would mean 'msg' is NULL, but they could be quite different...
- * So the semantics from the receiver side of
+ * So the semantics from the receiver side of
* GNUNET_MULTICAST_origin_to_all_cancel() are not clear here.
*
* @param cls Closure (set from GNUNET_MULTICAST_member_join())
const struct GNUNET_MessageHeader *msg);
-/**
+/**
* Function called with the result of an asynchronous operation.
*
* @see GNUNET_MULTICAST_replay_fragment()
- *
+ *
* @param result Result of the operation.
*/
typedef void
int result);
-/**
+/**
* Opaque handle to a replay request from the multicast service.
*/
struct GNUNET_MULTICAST_ReplayHandle;
-/**
+/**
* Functions with this signature are called whenever the multicast service needs
* a message fragment to be replayed by fragment_id.
*
uint64_t flags,
struct GNUNET_MULTICAST_ReplayHandle *rh);
-/**
+/**
* Functions with this signature are called whenever the multicast service needs
* a message fragment to be replayed by message_id and fragment_offset.
*
struct GNUNET_MULTICAST_ReplayHandle *rh);
-/**
+/**
* Possible error codes during replay.
*/
enum GNUNET_MULTICAST_ReplayErrorCode
{
- /**
+ /**
* Everything is fine.
*/
GNUNET_MULTICAST_REC_OK = 0,
- /**
+ /**
* Message fragment not found in the message store.
*
* Either discarded if it is too old, or not arrived yet if this member has
*/
GNUNET_MULTICAST_REC_NOT_FOUND = 1,
- /**
+ /**
* Fragment ID counter was larger than the highest counter this
* replay function has ever encountered; thus it is likely the
* origin never sent it and we're at the HEAD of the multicast
*/
GNUNET_MULTICAST_REC_PAST_HEAD = 2,
- /**
+ /**
* Access is denied to the requested fragment, membership test did not pass.
*/
GNUNET_MULTICAST_REC_ACCESS_DENIED = 3,
- /**
+ /**
* Internal error (i.e. database error). Try some other peer.
*/
GNUNET_MULTICAST_REC_INTERNAL_ERROR = 4
};
-/**
+/**
* Replay a message fragment for the multicast group.
*
* @param rh Replay handle identifying which replay operation was requested.
enum GNUNET_MULTICAST_ReplayErrorCode ec);
-/**
+/**
* Indicate the end of the replay session.
*
* Invalidates the replay handle.
void *data);
-/**
+/**
* Replay a message for the multicast group.
*
* @param rh Replay handle identifying which replay operation was requested.
void *notify_cls);
-/**
+/**
* Start a multicast group.
*
* Will advertise the origin in the P2P overlay network under the respective
* @param cfg Configuration to use.
* @param priv_key ECC key that will be used to sign messages for this
* multicast session; public key is used to identify the multicast group;
- * @param last_fragment_id Last fragment ID to continue counting fragments from
- * when restarting the origin. 0 for a new group.
+ * @param next_fragment_id Next fragment ID to continue counting fragments from
+ * when restarting the origin. 1 for a new group.
* @param join_cb Function called to approve / disapprove joining of a peer.
- * @param test_cb Function multicast can use to test group membership.
+ * @param mem_test_cb Function multicast can use to test group membership.
* @param replay_frag_cb Function that can be called to replay a message fragment.
* @param replay_msg_cb Function that can be called to replay a message.
* @param request_cb Function called with message fragments from group members.
struct GNUNET_MULTICAST_Origin *
GNUNET_MULTICAST_origin_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
const struct GNUNET_CRYPTO_EccPrivateKey *priv_key,
- uint64_t last_fragment_id,
+ uint64_t next_fragment_id,
GNUNET_MULTICAST_JoinCallback join_cb,
- GNUNET_MULTICAST_MembershipTestCallback test_cb,
+ GNUNET_MULTICAST_MembershipTestCallback mem_test_cb,
GNUNET_MULTICAST_ReplayFragmentCallback replay_frag_cb,
GNUNET_MULTICAST_ReplayMessageCallback replay_msg_cb,
GNUNET_MULTICAST_RequestCallback request_cb,
/**
* Function called to provide data for a transmission from the origin to all
* members.
- * FIXME: what if origin needs to pause transmission for a while?
*
- * @param cls closure
- * @param data_size number of bytes available in @a data
- * @param data where to copy the message
- * @return number of bytes copied to @a data? (FIXME: size_t?), or status code?
+ * Note that returning #GNUNET_OK or #GNUNET_SYSERR (but not #GNUNET_NO)
+ * invalidates the respective transmission handle.
+ *
+ * @param cls Closure.
+ * @param[in,out] data_size Initially set to the number of bytes available in
+ * @a data, should be set to the number of bytes written to data.
+ * @param[out] data Where to write the body of the message to give to the
+ * method. The function must copy at most @a data_size bytes to @a data.
+ * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
+ * #GNUNET_NO on success, if more data is to be transmitted later.
+ * Should be used if @a data_size was not big enough to take all the
+ * 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)
*/
typedef int
(*GNUNET_MULTICAST_OriginTransmitNotify) (void *cls,
void *data);
-/**
+/**
* Handle for a request to send a message to all multicast group members
* (from the origin).
*/
struct GNUNET_MULTICAST_OriginMessageHandle;
-/**
+/**
* Send a message to the multicast group.
*
* @param origin Handle to the multicast group.
* @param message_id Application layer ID for the message. Opaque to multicast.
* @param group_generation Group generation of the message. Documented in
* GNUNET_MULTICAST_MessageHeader.
- * @param size Number of bytes to transmit.
- * FIXME: Needed? The end of the message can be flagged with a last fragment flag.
- * FIXME: what last fragment flag? OriginTransmitNotify is not that well documented...
- * FIXME: size_t? If this is a total size, uint64_t might be better!
- * FIXME: do we reserve "MAX" to indicate 'unknown'?
* @param notify Function to call to get the message.
* @param notify_cls Closure for @a notify.
* @return NULL on error (i.e. request already pending).
GNUNET_MULTICAST_origin_to_all (struct GNUNET_MULTICAST_Origin *origin,
uint64_t message_id,
uint64_t group_generation,
- size_t size,
GNUNET_MULTICAST_OriginTransmitNotify notify,
void *notify_cls);
-/**
+
+/**
+ * Resume message transmission to multicast group.
+ *
+ * @param mh Request to cancel.
+ */
+void
+GNUNET_MULTICAST_origin_to_all_resume (struct GNUNET_MULTICAST_OriginMessageHandle *mh);
+
+
+/**
* Cancel request for message transmission to multicast group.
*
* @param mh Request to cancel.
GNUNET_MULTICAST_origin_to_all_cancel (struct GNUNET_MULTICAST_OriginMessageHandle *mh);
-/**
+/**
* Stop a multicast group.
*
* @param origin Multicast group to stop.
GNUNET_MULTICAST_origin_stop (struct GNUNET_MULTICAST_Origin *origin);
-/**
+/**
* Join a multicast group.
*
* The entity joining is always the local peer. Further information about the
* @a message_cb is invoked with a (failure) response and then with NULL. If
* the join succeeds, outstanding (state) messages and ongoing multicast
* messages will be given to the @a message_cb until the member decides to part
- * the group. The @a test_cb and @a replay_cb functions may be called at
+ * the group. The @a mem_test_cb and @a replay_cb functions may be called at
* anytime by the multicast service to support relaying messages to other
* members of the group.
*
* identity/pseudonym to peer identity, application-level message to
* origin, etc.).
* @param join_cb Function called to approve / disapprove joining of a peer.
- * @param test_cb Function multicast can use to test group membership.
+ * @param mem_test_cb Function multicast can use to test group membership.
* @param replay_frag_cb Function that can be called to replay message fragments
* this peer already knows from this group. NULL if this
* client is unable to support replay.
const struct GNUNET_PeerIdentity *relays,
const struct GNUNET_MessageHeader *join_request,
GNUNET_MULTICAST_JoinCallback join_cb,
- GNUNET_MULTICAST_MembershipTestCallback test_cb,
+ GNUNET_MULTICAST_MembershipTestCallback mem_test_cb,
GNUNET_MULTICAST_ReplayFragmentCallback replay_frag_cb,
GNUNET_MULTICAST_ReplayMessageCallback replay_msg_cb,
GNUNET_MULTICAST_MessageCallback message_cb,
void *cls);
-/**
+/**
* Handle for a replay request.
*/
struct GNUNET_MULTICAST_MemberReplayHandle;
-/**
+/**
* Request a fragment to be replayed by fragment ID.
*
* Useful if messages below the @e max_known_fragment_id given when joining are
uint64_t flags);
-/**
+/**
* Request a message fr to be replayed.
*
* Useful if messages below the @e max_known_fragment_id given when joining are
void *result_cb_cls);
-/**
+/**
* Cancel a replay request.
*
* @param rh Request to cancel.
GNUNET_MULTICAST_member_replay_cancel (struct GNUNET_MULTICAST_MemberReplayHandle *rh);
-/**
+/**
* Part a multicast group.
*
* Disconnects from all group members and invalidates the @a member handle.
GNUNET_MULTICAST_member_part (struct GNUNET_MULTICAST_Member *member);
-/**
+/**
* Function called to provide data for a transmission from a member to the origin.
*
- * @param cls closure
- * @param data_size number of bytes available in @a data
- * @param data where to copy data for transmission
- * @return number of bytes copied to data
+ * Note that returning #GNUNET_OK or #GNUNET_SYSERR (but not #GNUNET_NO)
+ * invalidates the respective transmission handle.
+ *
+ * @param cls Closure.
+ * @param[in,out] data_size Initially set to the number of bytes available in
+ * @a data, should be set to the number of bytes written to data.
+ * @param[out] data Where to write the body of the message to give to the
+ * method. The function must copy at most @a data_size bytes to @a data.
+ * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
+ * #GNUNET_NO on success, if more data is to be transmitted later.
+ * Should be used if @a data_size was not big enough to take all the
+ * 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)
*/
typedef int
(*GNUNET_MULTICAST_MemberTransmitNotify) (void *cls,
void *data);
-/**
+/**
* Handle for a message to be delivered from a member to the origin.
*/
struct GNUNET_MULTICAST_MemberRequestHandle;
-/**
+/**
* Send a message to the origin of the multicast group.
- *
+ *
* @param member Membership handle.
* @param message_id Application layer ID for the message. Opaque to multicast.
- * @param size Number of bytes we want to send to origin.
- * FIXME: this should probably be a uint64_t?
* @param notify Callback to call to get the message.
* @param notify_cls Closure for @a notify.
* @return Handle to cancel request, NULL on error (i.e. request already pending).
struct GNUNET_MULTICAST_MemberRequestHandle *
GNUNET_MULTICAST_member_to_origin (struct GNUNET_MULTICAST_Member *member,
uint64_t message_id,
- size_t size,
GNUNET_MULTICAST_MemberTransmitNotify notify,
void *notify_cls);
-/**
+/**
+ * Resume message transmission to origin.
+ *
+ * @param rh Request to cancel.
+ */
+void
+GNUNET_MULTICAST_member_to_origin_resume (struct GNUNET_MULTICAST_MemberRequestHandle *rh);
+
+
+/**
* Cancel request for message transmission to origin.
*
* @param rh Request to cancel.
projects / oweals / gnunet.git / blobdiff