2 This file is part of GNUnet.
3 (C) 2012, 2013 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file multicast/multicast_api.c
23 * @brief Multicast service; implements multicast groups using CADET connections.
24 * @author Christian Grothoff
25 * @author Gabor X Toth
29 #include "gnunet_util_lib.h"
30 #include "gnunet_multicast_service.h"
31 #include "multicast.h"
33 #define LOG(kind,...) GNUNET_log_from (kind, "multicast-api",__VA_ARGS__)
37 * Handle for a request to send a message to all multicast group members
40 struct GNUNET_MULTICAST_OriginTransmitHandle
42 GNUNET_MULTICAST_OriginTransmitNotify notify;
44 struct GNUNET_MULTICAST_Origin *origin;
47 uint64_t group_generation;
48 uint64_t fragment_offset;
53 * Handle for a message to be delivered from a member to the origin.
55 struct GNUNET_MULTICAST_MemberTransmitHandle
57 GNUNET_MULTICAST_MemberTransmitNotify notify;
59 struct GNUNET_MULTICAST_Member *member;
62 uint64_t fragment_offset;
66 struct GNUNET_MULTICAST_Group
69 * Configuration to use.
71 const struct GNUNET_CONFIGURATION_Handle *cfg;
74 * Client connection to the service.
76 struct GNUNET_CLIENT_MANAGER_Connection *client;
79 * Message to send on reconnect.
81 struct GNUNET_MessageHeader *connect_msg;
83 GNUNET_MULTICAST_JoinRequestCallback join_req_cb;
84 GNUNET_MULTICAST_MembershipTestCallback member_test_cb;
85 GNUNET_MULTICAST_ReplayFragmentCallback replay_frag_cb;
86 GNUNET_MULTICAST_ReplayMessageCallback replay_msg_cb;
87 GNUNET_MULTICAST_MessageCallback message_cb;
91 * Are we currently transmitting a message?
96 * Is this the origin or a member?
103 * Handle for the origin of a multicast group.
105 struct GNUNET_MULTICAST_Origin
107 struct GNUNET_MULTICAST_Group grp;
108 struct GNUNET_MULTICAST_OriginTransmitHandle tmit;
110 GNUNET_MULTICAST_RequestCallback request_cb;
115 * Handle for a multicast group member.
117 struct GNUNET_MULTICAST_Member
119 struct GNUNET_MULTICAST_Group grp;
120 struct GNUNET_MULTICAST_MemberTransmitHandle tmit;
122 GNUNET_MULTICAST_JoinDecisionCallback join_dcsn_cb;
124 uint64_t next_fragment_id;
129 * Handle that identifies a join request.
131 * Used to match calls to #GNUNET_MULTICAST_JoinCallback to the
132 * corresponding calls to #GNUNET_MULTICAST_join_decision().
134 struct GNUNET_MULTICAST_JoinHandle
136 struct GNUNET_MULTICAST_Group *group;
139 * Public key of the member requesting join.
141 struct GNUNET_CRYPTO_EddsaPublicKey member_key;
144 * Peer identity of the member requesting join.
146 struct GNUNET_PeerIdentity member_peer;
151 * Handle to pass back for the answer of a membership test.
153 struct GNUNET_MULTICAST_MembershipTestHandle
159 * Opaque handle to a replay request from the multicast service.
161 struct GNUNET_MULTICAST_ReplayHandle
167 * Handle for a replay request.
169 struct GNUNET_MULTICAST_MemberReplayHandle
175 * Send first message to the service after connecting.
178 group_send_connect_msg (struct GNUNET_MULTICAST_Group *grp)
180 uint16_t cmsg_size = ntohs (grp->connect_msg->size);
181 struct GNUNET_MessageHeader * cmsg = GNUNET_malloc (cmsg_size);
182 memcpy (cmsg, grp->connect_msg, cmsg_size);
183 GNUNET_CLIENT_MANAGER_transmit_now (grp->client, cmsg);
188 * Got disconnected from service. Reconnect.
191 group_recv_disconnect (void *cls,
192 struct GNUNET_CLIENT_MANAGER_Connection *client,
193 const struct GNUNET_MessageHeader *msg)
195 struct GNUNET_MULTICAST_Group *
196 grp = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*grp));
197 GNUNET_CLIENT_MANAGER_reconnect (client);
198 group_send_connect_msg (grp);
203 * Receive join request from service.
206 group_recv_join_request (void *cls,
207 struct GNUNET_CLIENT_MANAGER_Connection *client,
208 const struct GNUNET_MessageHeader *msg)
210 struct GNUNET_MULTICAST_Group *
211 grp = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*grp));
213 const struct MulticastJoinRequestMessage *
214 jreq = (const struct MulticastJoinRequestMessage *) msg;
216 struct GNUNET_MULTICAST_JoinHandle *jh = GNUNET_malloc (sizeof (*jh));
218 jh->member_key = jreq->member_key;
219 jh->member_peer = jreq->member_peer;
221 const struct GNUNET_MessageHeader *jmsg = NULL;
222 if (sizeof (*jreq) + sizeof (*jmsg) <= ntohs (jreq->header.size))
223 jmsg = (const struct GNUNET_MessageHeader *) &jreq[1];
225 if (NULL != grp->join_req_cb)
226 grp->join_req_cb (grp->cb_cls, &jreq->member_key, jmsg, jh);
231 * Receive multicast message from service.
234 group_recv_message (void *cls,
235 struct GNUNET_CLIENT_MANAGER_Connection *client,
236 const struct GNUNET_MessageHeader *msg)
238 struct GNUNET_MULTICAST_Group *
239 grp = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*grp));
240 struct GNUNET_MULTICAST_MessageHeader *
241 mmsg = (struct GNUNET_MULTICAST_MessageHeader *) msg;
243 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
244 "Calling message callback with a message of size %u.\n",
245 ntohs (mmsg->header.size));
247 if (NULL != grp->message_cb)
248 grp->message_cb (grp->cb_cls, mmsg);
253 * Origin receives uniquest request from a member.
256 origin_recv_request (void *cls,
257 struct GNUNET_CLIENT_MANAGER_Connection *client,
258 const struct GNUNET_MessageHeader *msg)
260 struct GNUNET_MULTICAST_Group *grp;
261 struct GNUNET_MULTICAST_Origin *
262 orig = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*grp));
264 struct GNUNET_MULTICAST_RequestHeader *
265 req = (struct GNUNET_MULTICAST_RequestHeader *) msg;
267 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
268 "Calling request callback with a request of size %u.\n",
269 ntohs (req->header.size));
271 if (NULL != orig->request_cb)
272 orig->request_cb (grp->cb_cls, req);
277 * Member receives join decision.
280 member_recv_join_decision (void *cls,
281 struct GNUNET_CLIENT_MANAGER_Connection *client,
282 const struct GNUNET_MessageHeader *msg)
284 struct GNUNET_MULTICAST_Group *grp;
285 struct GNUNET_MULTICAST_Member *
286 mem = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*grp));
289 const struct MulticastJoinDecisionMessageHeader *
290 hdcsn = (const struct MulticastJoinDecisionMessageHeader *) msg;
291 const struct MulticastJoinDecisionMessage *
292 dcsn = (const struct MulticastJoinDecisionMessage *) &hdcsn[1];
294 uint16_t dcsn_size = ntohs (dcsn->header.size);
295 int is_admitted = ntohl (dcsn->is_admitted);
297 const struct GNUNET_MessageHeader *join_resp = NULL;
298 uint16_t join_resp_size = 0;
300 uint16_t relay_count = ntohl (dcsn->relay_count);
301 const struct GNUNET_PeerIdentity *relays = NULL;
302 uint16_t relay_size = relay_count * sizeof (*relays);
303 if (0 < relay_count && dcsn_size < sizeof (*dcsn) + relay_size)
304 relays = (struct GNUNET_PeerIdentity *) &dcsn[1];
306 if (sizeof (*dcsn) + relay_size + sizeof (*join_resp) <= dcsn_size)
308 join_resp = (const struct GNUNET_MessageHeader *) &dcsn[1];
309 join_resp_size = ntohs (join_resp->size);
311 if (dcsn_size < sizeof (*dcsn) + relay_size + join_resp_size)
313 LOG (GNUNET_ERROR_TYPE_DEBUG,
314 "Received invalid join decision message from multicast.\n");
316 is_admitted = GNUNET_SYSERR;
319 if (NULL != mem->join_dcsn_cb)
320 mem->join_dcsn_cb (grp->cb_cls, is_admitted, &hdcsn->peer,
321 relay_count, relays, join_resp);
323 if (GNUNET_YES != is_admitted)
324 GNUNET_MULTICAST_member_part (mem);
329 * Message handlers for an origin.
331 static struct GNUNET_CLIENT_MANAGER_MessageHandler origin_handlers[] =
333 { &group_recv_disconnect, NULL, 0, 0, GNUNET_NO },
335 { &group_recv_message, NULL,
336 GNUNET_MESSAGE_TYPE_MULTICAST_MESSAGE,
337 sizeof (struct GNUNET_MULTICAST_MessageHeader), GNUNET_YES },
339 { &origin_recv_request, NULL,
340 GNUNET_MESSAGE_TYPE_MULTICAST_REQUEST,
341 sizeof (struct GNUNET_MULTICAST_RequestHeader), GNUNET_YES },
343 { &group_recv_join_request, NULL,
344 GNUNET_MESSAGE_TYPE_MULTICAST_JOIN_REQUEST,
345 sizeof (struct MulticastJoinRequestMessage), GNUNET_YES },
347 { NULL, NULL, 0, 0, GNUNET_NO }
352 * Message handlers for a member.
354 static struct GNUNET_CLIENT_MANAGER_MessageHandler member_handlers[] =
356 { &group_recv_disconnect, NULL, 0, 0, GNUNET_NO },
358 { &group_recv_message, NULL,
359 GNUNET_MESSAGE_TYPE_MULTICAST_MESSAGE,
360 sizeof (struct GNUNET_MULTICAST_MessageHeader), GNUNET_YES },
362 { &group_recv_join_request, NULL,
363 GNUNET_MESSAGE_TYPE_MULTICAST_JOIN_REQUEST,
364 sizeof (struct MulticastJoinRequestMessage), GNUNET_YES },
366 { &member_recv_join_decision, NULL,
367 GNUNET_MESSAGE_TYPE_MULTICAST_JOIN_DECISION,
368 sizeof (struct MulticastJoinDecisionMessage), GNUNET_YES },
370 { NULL, NULL, 0, 0, GNUNET_NO }
375 * Function to call with the decision made for a join request.
377 * Must be called once and only once in response to an invocation of the
378 * #GNUNET_MULTICAST_JoinRequestCallback.
380 * @param join Join request handle.
381 * @param is_admitted #GNUNET_YES if the join is approved,
382 * #GNUNET_NO if it is disapproved,
383 * #GNUNET_SYSERR if we cannot answer the request.
384 * @param relay_count Number of relays given.
385 * @param relays Array of suggested peers that might be useful relays to use
386 * when joining the multicast group (essentially a list of peers that
387 * are already part of the multicast group and might thus be willing
388 * to help with routing). If empty, only this local peer (which must
389 * be the multicast origin) is a good candidate for building the
390 * multicast tree. Note that it is unnecessary to specify our own
391 * peer identity in this array.
392 * @param join_resp Message to send in response to the joining peer;
393 * can also be used to redirect the peer to a different group at the
394 * application layer; this response is to be transmitted to the
395 * peer that issued the request even if admission is denied.
397 struct GNUNET_MULTICAST_ReplayHandle *
398 GNUNET_MULTICAST_join_decision (struct GNUNET_MULTICAST_JoinHandle *join,
400 uint16_t relay_count,
401 const struct GNUNET_PeerIdentity *relays,
402 const struct GNUNET_MessageHeader *join_resp)
404 struct GNUNET_MULTICAST_Group *grp = join->group;
405 uint16_t join_resp_size = (NULL != join_resp) ? ntohs (join_resp->size) : 0;
406 uint16_t relay_size = relay_count * sizeof (*relays);
408 struct MulticastJoinDecisionMessageHeader * hdcsn;
409 struct MulticastJoinDecisionMessage *dcsn;
410 hdcsn = GNUNET_malloc (sizeof (*hdcsn) + sizeof (*dcsn)
411 + relay_size + join_resp_size);
412 hdcsn->header.size = htons (sizeof (*hdcsn) + sizeof (*dcsn)
413 + relay_size + join_resp_size);
414 hdcsn->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_JOIN_DECISION);
415 hdcsn->member_key = join->member_key;
416 hdcsn->peer = join->member_peer;
418 dcsn = (struct MulticastJoinDecisionMessage *) &hdcsn[1];
419 dcsn->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_JOIN_DECISION);
420 dcsn->header.size = htons (sizeof (*dcsn) + relay_size + join_resp_size);
421 dcsn->is_admitted = htonl (is_admitted);
422 dcsn->relay_count = htonl (relay_count);
424 memcpy (&dcsn[1], relays, relay_size);
425 if (0 < join_resp_size)
426 memcpy (((char *) &dcsn[1]) + relay_size, join_resp, join_resp_size);
428 GNUNET_CLIENT_MANAGER_transmit (grp->client, &hdcsn->header);
435 * Call informing multicast about the decision taken for a membership test.
437 * @param mth Handle that was given for the query.
438 * @param result #GNUNET_YES if peer was a member, #GNUNET_NO if peer was not a member,
439 * #GNUNET_SYSERR if we cannot answer the membership test.
442 GNUNET_MULTICAST_membership_test_result (struct GNUNET_MULTICAST_MembershipTestHandle *mth,
449 * Replay a message fragment for the multicast group.
451 * @param rh Replay handle identifying which replay operation was requested.
452 * @param msg Replayed message fragment, NULL if unknown/error.
453 * @param ec Error code.
456 GNUNET_MULTICAST_replay_response (struct GNUNET_MULTICAST_ReplayHandle *rh,
457 const struct GNUNET_MessageHeader *msg,
458 enum GNUNET_MULTICAST_ReplayErrorCode ec)
464 * Indicate the end of the replay session.
466 * Invalidates the replay handle.
468 * @param rh Replay session to end.
471 GNUNET_MULTICAST_replay_response_end (struct GNUNET_MULTICAST_ReplayHandle *rh)
477 * Replay a message for the multicast group.
479 * @param rh Replay handle identifying which replay operation was requested.
480 * @param notify Function to call to get the message.
481 * @param notify_cls Closure for @a notify.
484 GNUNET_MULTICAST_replay_response2 (struct GNUNET_MULTICAST_ReplayHandle *rh,
485 GNUNET_MULTICAST_ReplayTransmitNotify notify,
492 * Start a multicast group.
494 * Will advertise the origin in the P2P overlay network under the respective
495 * public key so that other peer can find this peer to join it. Peers that
496 * issue GNUNET_MULTICAST_member_join() can then transmit a join request to
497 * either an existing group member or to the origin. If the joining is
498 * approved, the member is cleared for @e replay and will begin to receive
499 * messages transmitted to the group. If joining is disapproved, the failed
500 * candidate will be given a response. Members in the group can send messages
501 * to the origin (one at a time).
503 * @param cfg Configuration to use.
504 * @param priv_key ECC key that will be used to sign messages for this
505 * multicast session; public key is used to identify the multicast group;
506 * @param max_fragment_id Maximum fragment ID already sent to the group.
508 * @param join_request_cb Function called to approve / disapprove joining of a peer.
509 * @param member_test_cb Function multicast can use to test group membership.
510 * @param replay_frag_cb Function that can be called to replay a message fragment.
511 * @param replay_msg_cb Function that can be called to replay a message.
512 * @param request_cb Function called with message fragments from group members.
513 * @param message_cb Function called with the message fragments sent to the
514 * network by GNUNET_MULTICAST_origin_to_all(). These message fragments
515 * should be stored for answering replay requests later.
516 * @param cls Closure for the various callbacks that follow.
518 * @return Handle for the origin, NULL on error.
520 struct GNUNET_MULTICAST_Origin *
521 GNUNET_MULTICAST_origin_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
522 const struct GNUNET_CRYPTO_EddsaPrivateKey *priv_key,
523 uint64_t max_fragment_id,
524 GNUNET_MULTICAST_JoinRequestCallback join_request_cb,
525 GNUNET_MULTICAST_MembershipTestCallback member_test_cb,
526 GNUNET_MULTICAST_ReplayFragmentCallback replay_frag_cb,
527 GNUNET_MULTICAST_ReplayMessageCallback replay_msg_cb,
528 GNUNET_MULTICAST_RequestCallback request_cb,
529 GNUNET_MULTICAST_MessageCallback message_cb,
532 struct GNUNET_MULTICAST_Origin *orig = GNUNET_malloc (sizeof (*orig));
533 struct GNUNET_MULTICAST_Group *grp = &orig->grp;
534 struct MulticastOriginStartMessage *start = GNUNET_malloc (sizeof (*start));
536 start->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_ORIGIN_START);
537 start->header.size = htons (sizeof (*start));
538 start->max_fragment_id = max_fragment_id;
539 memcpy (&start->group_key, priv_key, sizeof (*priv_key));
541 grp->connect_msg = (struct GNUNET_MessageHeader *) start;
542 grp->is_origin = GNUNET_YES;
546 grp->join_req_cb = join_request_cb;
547 grp->member_test_cb = member_test_cb;
548 grp->replay_frag_cb = replay_frag_cb;
549 grp->replay_msg_cb = replay_msg_cb;
550 grp->message_cb = message_cb;
552 orig->request_cb = request_cb;
554 grp->client = GNUNET_CLIENT_MANAGER_connect (cfg, "multicast", origin_handlers);
555 GNUNET_CLIENT_MANAGER_set_user_context_ (grp->client, orig, sizeof (*grp));
556 group_send_connect_msg (grp);
563 * Stop a multicast group.
565 * @param origin Multicast group to stop.
568 GNUNET_MULTICAST_origin_stop (struct GNUNET_MULTICAST_Origin *orig)
570 GNUNET_CLIENT_MANAGER_disconnect (orig->grp.client, GNUNET_YES);
576 origin_to_all (struct GNUNET_MULTICAST_Origin *orig)
578 LOG (GNUNET_ERROR_TYPE_DEBUG, "origin_to_all()\n");
579 struct GNUNET_MULTICAST_Group *grp = &orig->grp;
580 struct GNUNET_MULTICAST_OriginTransmitHandle *tmit = &orig->tmit;
582 size_t buf_size = GNUNET_MULTICAST_FRAGMENT_MAX_SIZE;
583 struct GNUNET_MULTICAST_MessageHeader *msg = GNUNET_malloc (buf_size);
584 int ret = tmit->notify (tmit->notify_cls, &buf_size, &msg[1]);
586 if (! (GNUNET_YES == ret || GNUNET_NO == ret)
587 || GNUNET_MULTICAST_FRAGMENT_MAX_SIZE < buf_size)
589 LOG (GNUNET_ERROR_TYPE_ERROR,
590 "OriginTransmitNotify() returned error or invalid message size.\n");
591 /* FIXME: handle error */
596 if (GNUNET_NO == ret && 0 == buf_size)
599 return; /* Transmission paused. */
602 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_MESSAGE);
603 msg->header.size = htons (sizeof (*msg) + buf_size);
604 msg->message_id = GNUNET_htonll (tmit->message_id);
605 msg->group_generation = tmit->group_generation;
606 msg->fragment_offset = GNUNET_htonll (tmit->fragment_offset);
607 tmit->fragment_offset += sizeof (*msg) + buf_size;
609 GNUNET_CLIENT_MANAGER_transmit (grp->client, &msg->header);
614 * Send a message to the multicast group.
616 * @param orig Handle to the multicast group.
617 * @param message_id Application layer ID for the message. Opaque to multicast.
618 * @param group_generation Group generation of the message.
619 * Documented in struct GNUNET_MULTICAST_MessageHeader.
620 * @param notify Function to call to get the message.
621 * @param notify_cls Closure for @a notify.
623 * @return Message handle on success,
624 * NULL on error (i.e. another request is already pending).
626 struct GNUNET_MULTICAST_OriginTransmitHandle *
627 GNUNET_MULTICAST_origin_to_all (struct GNUNET_MULTICAST_Origin *orig,
629 uint64_t group_generation,
630 GNUNET_MULTICAST_OriginTransmitNotify notify,
634 if (GNUNET_YES == orig->grp.in_transmit)
636 orig->grp.in_transmit = GNUNET_YES;
639 struct GNUNET_MULTICAST_OriginTransmitHandle *tmit = &orig->tmit;
641 tmit->message_id = message_id;
642 tmit->group_generation = group_generation;
643 tmit->notify = notify;
644 tmit->notify_cls = notify_cls;
646 origin_to_all (orig);
652 * Resume message transmission to multicast group.
654 * @param th Transmission to cancel.
657 GNUNET_MULTICAST_origin_to_all_resume (struct GNUNET_MULTICAST_OriginTransmitHandle *th)
659 origin_to_all (th->origin);
664 * Cancel request for message transmission to multicast group.
666 * @param th Transmission to cancel.
669 GNUNET_MULTICAST_origin_to_all_cancel (struct GNUNET_MULTICAST_OriginTransmitHandle *th)
675 * Join a multicast group.
677 * The entity joining is always the local peer. Further information about the
678 * candidate can be provided in the @a join_request message. If the join fails, the
679 * @a message_cb is invoked with a (failure) response and then with NULL. If
680 * the join succeeds, outstanding (state) messages and ongoing multicast
681 * messages will be given to the @a message_cb until the member decides to part
682 * the group. The @a test_cb and @a replay_cb functions may be called at
683 * anytime by the multicast service to support relaying messages to other
684 * members of the group.
686 * @param cfg Configuration to use.
687 * @param group_key ECC public key that identifies the group to join.
688 * @param member_key ECC key that identifies the member and used to sign
689 * requests sent to the origin.
690 * @param origin Peer ID of the origin to send unicast requsets to. If NULL,
691 * unicast requests are sent back via multiple hops on the reverse path
692 * of multicast messages.
693 * @param relay_count Number of peers in the @a relays array.
694 * @param relays Peer identities of members of the group, which serve as relays
695 * and can be used to join the group at. and send the @a join_request to.
696 * If empty, the @a join_request is sent directly to the @a origin.
697 * @param join_msg Application-dependent join message to be passed to the peer
699 * @param join_request_cb Function called to approve / disapprove joining of a peer.
700 * @param join_decision_cb Function called to inform about the join decision.
701 * @param member_test_cb Function multicast can use to test group membership.
702 * @param replay_frag_cb Function that can be called to replay message fragments
703 * this peer already knows from this group. NULL if this
704 * client is unable to support replay.
705 * @param replay_msg_cb Function that can be called to replay message fragments
706 * this peer already knows from this group. NULL if this
707 * client is unable to support replay.
708 * @param message_cb Function to be called for all message fragments we
709 * receive from the group, excluding those our @a replay_cb
711 * @param cls Closure for callbacks.
712 * @return Handle for the member, NULL on error.
714 struct GNUNET_MULTICAST_Member *
715 GNUNET_MULTICAST_member_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
716 const struct GNUNET_CRYPTO_EddsaPublicKey *group_key,
717 const struct GNUNET_CRYPTO_EddsaPrivateKey *member_key,
718 const struct GNUNET_PeerIdentity *origin,
719 uint16_t relay_count,
720 const struct GNUNET_PeerIdentity *relays,
721 const struct GNUNET_MessageHeader *join_msg,
722 GNUNET_MULTICAST_JoinRequestCallback join_request_cb,
723 GNUNET_MULTICAST_JoinDecisionCallback join_decision_cb,
724 GNUNET_MULTICAST_MembershipTestCallback member_test_cb,
725 GNUNET_MULTICAST_ReplayFragmentCallback replay_frag_cb,
726 GNUNET_MULTICAST_ReplayMessageCallback replay_msg_cb,
727 GNUNET_MULTICAST_MessageCallback message_cb,
730 struct GNUNET_MULTICAST_Member *mem = GNUNET_malloc (sizeof (*mem));
731 struct GNUNET_MULTICAST_Group *grp = &mem->grp;
733 uint16_t relay_size = relay_count * sizeof (*relays);
734 uint16_t join_msg_size = (NULL != join_msg) ? ntohs (join_msg->size) : 0;
735 struct MulticastMemberJoinMessage *
736 join = GNUNET_malloc (sizeof (*join) + relay_size + join_msg_size);
737 join->header.size = htons (sizeof (*join) + relay_size + join_msg_size);
738 join->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_MEMBER_JOIN);
739 join->group_key = *group_key;
740 join->member_key = *member_key;
741 join->origin = *origin;
743 memcpy (&join[1], relays, relay_size);
744 if (0 < join_msg_size)
745 memcpy (((char *) &join[1]) + relay_size, join_msg, join_msg_size);
747 grp->connect_msg = (struct GNUNET_MessageHeader *) join;
748 grp->is_origin = GNUNET_NO;
751 mem->join_dcsn_cb = join_decision_cb;
752 grp->join_req_cb = join_request_cb;
753 grp->member_test_cb = member_test_cb;
754 grp->replay_frag_cb = replay_frag_cb;
755 grp->message_cb = message_cb;
758 grp->client = GNUNET_CLIENT_MANAGER_connect (cfg, "multicast", member_handlers);
759 GNUNET_CLIENT_MANAGER_set_user_context_ (grp->client, mem, sizeof (*grp));
760 group_send_connect_msg (grp);
767 * Part a multicast group.
769 * Disconnects from all group members and invalidates the @a member handle.
771 * An application-dependent part message can be transmitted beforehand using
772 * #GNUNET_MULTICAST_member_to_origin())
774 * @param member Membership handle.
777 GNUNET_MULTICAST_member_part (struct GNUNET_MULTICAST_Member *mem)
779 GNUNET_CLIENT_MANAGER_disconnect (mem->grp.client, GNUNET_YES);
785 * Request a fragment to be replayed by fragment ID.
787 * Useful if messages below the @e max_known_fragment_id given when joining are
788 * needed and not known to the client.
790 * @param member Membership handle.
791 * @param fragment_id ID of a message fragment that this client would like to
793 * @param flags Additional flags for the replay request. It is used and defined
794 * by the replay callback. FIXME: which replay callback? FIXME: use enum?
795 * FIXME: why not pass reply cb here?
796 * @return Replay request handle, NULL on error.
798 struct GNUNET_MULTICAST_MemberReplayHandle *
799 GNUNET_MULTICAST_member_replay_fragment (struct GNUNET_MULTICAST_Member *member,
800 uint64_t fragment_id,
808 * Request a message fragment to be replayed.
810 * Useful if messages below the @e max_known_fragment_id given when joining are
811 * needed and not known to the client.
813 * @param member Membership handle.
814 * @param message_id ID of the message this client would like to see replayed.
815 * @param fragment_offset Offset of the fragment within the message to replay.
816 * @param flags Additional flags for the replay request. It is used & defined
817 * by the replay callback.
818 * @param result_cb Function to be called for the replayed message.
819 * @param result_cb_cls Closure for @a result_cb.
820 * @return Replay request handle, NULL on error.
822 struct GNUNET_MULTICAST_MemberReplayHandle *
823 GNUNET_MULTICAST_member_replay_message (struct GNUNET_MULTICAST_Member *member,
825 uint64_t fragment_offset,
827 GNUNET_MULTICAST_ResultCallback result_cb,
835 * Cancel a replay request.
837 * @param rh Request to cancel.
840 GNUNET_MULTICAST_member_replay_cancel (struct GNUNET_MULTICAST_MemberReplayHandle *rh)
846 member_to_origin (struct GNUNET_MULTICAST_Member *mem)
848 LOG (GNUNET_ERROR_TYPE_DEBUG, "member_to_origin()\n");
849 struct GNUNET_MULTICAST_Group *grp = &mem->grp;
850 struct GNUNET_MULTICAST_MemberTransmitHandle *tmit = &mem->tmit;
852 size_t buf_size = GNUNET_MULTICAST_FRAGMENT_MAX_SIZE;
853 struct GNUNET_MULTICAST_RequestHeader *req = GNUNET_malloc (buf_size);
854 int ret = tmit->notify (tmit->notify_cls, &buf_size, &req[1]);
856 if (! (GNUNET_YES == ret || GNUNET_NO == ret)
857 || GNUNET_MULTICAST_FRAGMENT_MAX_SIZE < buf_size)
859 LOG (GNUNET_ERROR_TYPE_ERROR,
860 "MemberTransmitNotify() returned error or invalid message size.\n");
861 /* FIXME: handle error */
866 if (GNUNET_NO == ret && 0 == buf_size)
868 /* Transmission paused. */
873 req->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_REQUEST);
874 req->header.size = htons (sizeof (*req) + buf_size);
875 req->request_id = GNUNET_htonll (tmit->request_id);
876 req->fragment_offset = GNUNET_ntohll (tmit->fragment_offset);
877 tmit->fragment_offset += sizeof (*req) + buf_size;
879 GNUNET_CLIENT_MANAGER_transmit (grp->client, &req->header);
884 * Send a message to the origin of the multicast group.
886 * @param mem Membership handle.
887 * @param request_id Application layer ID for the request. Opaque to multicast.
888 * @param notify Callback to call to get the message.
889 * @param notify_cls Closure for @a notify.
890 * @return Handle to cancel request, NULL on error (i.e. request already pending).
892 struct GNUNET_MULTICAST_MemberTransmitHandle *
893 GNUNET_MULTICAST_member_to_origin (struct GNUNET_MULTICAST_Member *mem,
895 GNUNET_MULTICAST_MemberTransmitNotify notify,
899 if (GNUNET_YES == mem->grp.in_transmit)
901 mem->grp.in_transmit = GNUNET_YES;
904 struct GNUNET_MULTICAST_MemberTransmitHandle *tmit = &mem->tmit;
906 tmit->request_id = request_id;
907 tmit->notify = notify;
908 tmit->notify_cls = notify_cls;
910 member_to_origin (mem);
916 * Resume message transmission to origin.
918 * @param th Transmission to cancel.
921 GNUNET_MULTICAST_member_to_origin_resume (struct GNUNET_MULTICAST_MemberTransmitHandle *th)
928 * Cancel request for message transmission to origin.
930 * @param th Transmission to cancel.
933 GNUNET_MULTICAST_member_to_origin_cancel (struct GNUNET_MULTICAST_MemberTransmitHandle *th)
938 /* end of multicast_api.c */