123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002 |
- /*
- This file is part of GNUnet.
- (C) 2012, 2013 Christian Grothoff (and other contributing authors)
- 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 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., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
- */
- /**
- * @file multicast/multicast_api.c
- * @brief Multicast service; implements multicast groups using CADET connections.
- * @author Christian Grothoff
- * @author Gabor X Toth
- */
- #include "platform.h"
- #include "gnunet_util_lib.h"
- #include "gnunet_multicast_service.h"
- #include "multicast.h"
- #define LOG(kind,...) GNUNET_log_from (kind, "multicast-api",__VA_ARGS__)
- /**
- * Handle for a request to send a message to all multicast group members
- * (from the origin).
- */
- struct GNUNET_MULTICAST_OriginTransmitHandle
- {
- GNUNET_MULTICAST_OriginTransmitNotify notify;
- void *notify_cls;
- struct GNUNET_MULTICAST_Origin *origin;
- uint64_t message_id;
- uint64_t group_generation;
- uint64_t fragment_offset;
- };
- /**
- * Handle for a message to be delivered from a member to the origin.
- */
- struct GNUNET_MULTICAST_MemberTransmitHandle
- {
- GNUNET_MULTICAST_MemberTransmitNotify notify;
- void *notify_cls;
- struct GNUNET_MULTICAST_Member *member;
- uint64_t request_id;
- uint64_t fragment_offset;
- };
- struct GNUNET_MULTICAST_Group
- {
- /**
- * Configuration to use.
- */
- const struct GNUNET_CONFIGURATION_Handle *cfg;
- /**
- * Client connection to the service.
- */
- struct GNUNET_CLIENT_MANAGER_Connection *client;
- /**
- * Message to send on reconnect.
- */
- struct GNUNET_MessageHeader *connect_msg;
- GNUNET_MULTICAST_JoinRequestCallback join_req_cb;
- GNUNET_MULTICAST_MembershipTestCallback member_test_cb;
- GNUNET_MULTICAST_ReplayFragmentCallback replay_frag_cb;
- GNUNET_MULTICAST_ReplayMessageCallback replay_msg_cb;
- GNUNET_MULTICAST_MessageCallback message_cb;
- void *cb_cls;
- /**
- * Function called after disconnected from the service.
- */
- GNUNET_ContinuationCallback disconnect_cb;
- /**
- * Closure for @a disconnect_cb.
- */
- void *disconnect_cls;
- /**
- * Are we currently transmitting a message?
- */
- uint8_t in_transmit;
- /**
- * Is this the origin or a member?
- */
- uint8_t is_origin;
- /**
- * Is this channel in the process of disconnecting from the service?
- * #GNUNET_YES or #GNUNET_NO
- */
- uint8_t is_disconnecting;
- };
- /**
- * Handle for the origin of a multicast group.
- */
- struct GNUNET_MULTICAST_Origin
- {
- struct GNUNET_MULTICAST_Group grp;
- struct GNUNET_MULTICAST_OriginTransmitHandle tmit;
- GNUNET_MULTICAST_RequestCallback request_cb;
- };
- /**
- * Handle for a multicast group member.
- */
- struct GNUNET_MULTICAST_Member
- {
- struct GNUNET_MULTICAST_Group grp;
- struct GNUNET_MULTICAST_MemberTransmitHandle tmit;
- GNUNET_MULTICAST_JoinDecisionCallback join_dcsn_cb;
- uint64_t next_fragment_id;
- };
- /**
- * Handle that identifies a join request.
- *
- * Used to match calls to #GNUNET_MULTICAST_JoinCallback to the
- * corresponding calls to #GNUNET_MULTICAST_join_decision().
- */
- struct GNUNET_MULTICAST_JoinHandle
- {
- struct GNUNET_MULTICAST_Group *group;
- /**
- * Public key of the member requesting join.
- */
- struct GNUNET_CRYPTO_EcdsaPublicKey member_key;
- /**
- * Peer identity of the member requesting join.
- */
- struct GNUNET_PeerIdentity peer;
- };
- /**
- * Handle to pass back for the answer of a membership test.
- */
- struct GNUNET_MULTICAST_MembershipTestHandle
- {
- };
- /**
- * Opaque handle to a replay request from the multicast service.
- */
- struct GNUNET_MULTICAST_ReplayHandle
- {
- };
- /**
- * Handle for a replay request.
- */
- struct GNUNET_MULTICAST_MemberReplayHandle
- {
- };
- /**
- * Send first message to the service after connecting.
- */
- static void
- group_send_connect_msg (struct GNUNET_MULTICAST_Group *grp)
- {
- uint16_t cmsg_size = ntohs (grp->connect_msg->size);
- struct GNUNET_MessageHeader * cmsg = GNUNET_malloc (cmsg_size);
- memcpy (cmsg, grp->connect_msg, cmsg_size);
- GNUNET_CLIENT_MANAGER_transmit_now (grp->client, cmsg);
- }
- /**
- * Got disconnected from service. Reconnect.
- */
- static void
- group_recv_disconnect (void *cls,
- struct GNUNET_CLIENT_MANAGER_Connection *client,
- const struct GNUNET_MessageHeader *msg)
- {
- struct GNUNET_MULTICAST_Group *
- grp = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*grp));
- GNUNET_CLIENT_MANAGER_reconnect (client);
- group_send_connect_msg (grp);
- }
- /**
- * Receive join request from service.
- */
- static void
- group_recv_join_request (void *cls,
- struct GNUNET_CLIENT_MANAGER_Connection *client,
- const struct GNUNET_MessageHeader *msg)
- {
- struct GNUNET_MULTICAST_Group *
- grp = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*grp));
- const struct MulticastJoinRequestMessage *
- jreq = (const struct MulticastJoinRequestMessage *) msg;
- struct GNUNET_MULTICAST_JoinHandle *jh = GNUNET_malloc (sizeof (*jh));
- jh->group = grp;
- jh->member_key = jreq->member_key;
- jh->peer = jreq->peer;
- const struct GNUNET_MessageHeader *jmsg = NULL;
- if (sizeof (*jreq) + sizeof (*jmsg) <= ntohs (jreq->header.size))
- jmsg = (const struct GNUNET_MessageHeader *) &jreq[1];
- if (NULL != grp->join_req_cb)
- grp->join_req_cb (grp->cb_cls, &jreq->member_key, jmsg, jh);
- }
- /**
- * Receive multicast message from service.
- */
- static void
- group_recv_message (void *cls,
- struct GNUNET_CLIENT_MANAGER_Connection *client,
- const struct GNUNET_MessageHeader *msg)
- {
- struct GNUNET_MULTICAST_Group *
- grp = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*grp));
- struct GNUNET_MULTICAST_MessageHeader *
- mmsg = (struct GNUNET_MULTICAST_MessageHeader *) msg;
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Calling message callback with a message of size %u.\n",
- ntohs (mmsg->header.size));
- if (NULL != grp->message_cb)
- grp->message_cb (grp->cb_cls, mmsg);
- }
- /**
- * Origin receives uniquest request from a member.
- */
- static void
- origin_recv_request (void *cls,
- struct GNUNET_CLIENT_MANAGER_Connection *client,
- const struct GNUNET_MessageHeader *msg)
- {
- struct GNUNET_MULTICAST_Group *grp;
- struct GNUNET_MULTICAST_Origin *
- orig = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*grp));
- grp = &orig->grp;
- struct GNUNET_MULTICAST_RequestHeader *
- req = (struct GNUNET_MULTICAST_RequestHeader *) msg;
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Calling request callback with a request of size %u.\n",
- ntohs (req->header.size));
- if (NULL != orig->request_cb)
- orig->request_cb (grp->cb_cls, req);
- }
- /**
- * Member receives join decision.
- */
- static void
- member_recv_join_decision (void *cls,
- struct GNUNET_CLIENT_MANAGER_Connection *client,
- const struct GNUNET_MessageHeader *msg)
- {
- struct GNUNET_MULTICAST_Group *grp;
- struct GNUNET_MULTICAST_Member *
- mem = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*grp));
- grp = &mem->grp;
- const struct MulticastJoinDecisionMessageHeader *
- hdcsn = (const struct MulticastJoinDecisionMessageHeader *) msg;
- const struct MulticastJoinDecisionMessage *
- dcsn = (const struct MulticastJoinDecisionMessage *) &hdcsn[1];
- uint16_t dcsn_size = ntohs (dcsn->header.size);
- int is_admitted = ntohl (dcsn->is_admitted);
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "%p Member got join decision from multicast: %d\n",
- mem, is_admitted);
- const struct GNUNET_MessageHeader *join_resp = NULL;
- uint16_t join_resp_size = 0;
- uint16_t relay_count = ntohl (dcsn->relay_count);
- const struct GNUNET_PeerIdentity *relays = NULL;
- uint16_t relay_size = relay_count * sizeof (*relays);
- if (0 < relay_count && dcsn_size < sizeof (*dcsn) + relay_size)
- relays = (struct GNUNET_PeerIdentity *) &dcsn[1];
- if (sizeof (*dcsn) + relay_size + sizeof (*join_resp) <= dcsn_size)
- {
- join_resp = (const struct GNUNET_MessageHeader *) &dcsn[1];
- join_resp_size = ntohs (join_resp->size);
- }
- if (dcsn_size < sizeof (*dcsn) + relay_size + join_resp_size)
- {
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Received invalid join decision message from multicast.\n");
- GNUNET_break_op (0);
- is_admitted = GNUNET_SYSERR;
- }
- if (NULL != mem->join_dcsn_cb)
- mem->join_dcsn_cb (grp->cb_cls, is_admitted, &hdcsn->peer,
- relay_count, relays, join_resp);
- // FIXME:
- //if (GNUNET_YES != is_admitted)
- // GNUNET_MULTICAST_member_part (mem);
- }
- /**
- * Message handlers for an origin.
- */
- static struct GNUNET_CLIENT_MANAGER_MessageHandler origin_handlers[] =
- {
- { &group_recv_disconnect, NULL, 0, 0, GNUNET_NO },
- { &group_recv_message, NULL,
- GNUNET_MESSAGE_TYPE_MULTICAST_MESSAGE,
- sizeof (struct GNUNET_MULTICAST_MessageHeader), GNUNET_YES },
- { &origin_recv_request, NULL,
- GNUNET_MESSAGE_TYPE_MULTICAST_REQUEST,
- sizeof (struct GNUNET_MULTICAST_RequestHeader), GNUNET_YES },
- { &group_recv_join_request, NULL,
- GNUNET_MESSAGE_TYPE_MULTICAST_JOIN_REQUEST,
- sizeof (struct MulticastJoinRequestMessage), GNUNET_YES },
- { NULL, NULL, 0, 0, GNUNET_NO }
- };
- /**
- * Message handlers for a member.
- */
- static struct GNUNET_CLIENT_MANAGER_MessageHandler member_handlers[] =
- {
- { &group_recv_disconnect, NULL, 0, 0, GNUNET_NO },
- { &group_recv_message, NULL,
- GNUNET_MESSAGE_TYPE_MULTICAST_MESSAGE,
- sizeof (struct GNUNET_MULTICAST_MessageHeader), GNUNET_YES },
- { &group_recv_join_request, NULL,
- GNUNET_MESSAGE_TYPE_MULTICAST_JOIN_REQUEST,
- sizeof (struct MulticastJoinRequestMessage), GNUNET_YES },
- { &member_recv_join_decision, NULL,
- GNUNET_MESSAGE_TYPE_MULTICAST_JOIN_DECISION,
- sizeof (struct MulticastJoinDecisionMessage), GNUNET_YES },
- { NULL, NULL, 0, 0, GNUNET_NO }
- };
- static void
- group_cleanup (struct GNUNET_MULTICAST_Group *grp)
- {
- GNUNET_free (grp->connect_msg);
- if (NULL != grp->disconnect_cb)
- grp->disconnect_cb (grp->disconnect_cls);
- }
- static void
- origin_cleanup (void *cls)
- {
- struct GNUNET_MULTICAST_Origin *orig = cls;
- group_cleanup (&orig->grp);
- GNUNET_free (orig);
- }
- static void
- member_cleanup (void *cls)
- {
- struct GNUNET_MULTICAST_Member *mem = cls;
- group_cleanup (&mem->grp);
- GNUNET_free (mem);
- }
- /**
- * 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
- * #GNUNET_MULTICAST_JoinRequestCallback.
- *
- * @param join Join request handle.
- * @param is_admitted #GNUNET_YES if the join is approved,
- * #GNUNET_NO if it is disapproved,
- * #GNUNET_SYSERR if we cannot answer the request.
- * @param relay_count Number of relays given.
- * @param relays Array of suggested peers that might be useful relays to use
- * when joining the multicast group (essentially a list of peers that
- * are already part of the multicast group and might thus be willing
- * to help with routing). If empty, only this local peer (which must
- * be the multicast origin) is a good candidate for building the
- * multicast tree. Note that it is unnecessary to specify our own
- * peer identity in this array.
- * @param join_resp Message to send in response to the joining peer;
- * can also be used to redirect the peer to a different group at the
- * application layer; this response is to be transmitted to the
- * peer that issued the request even if admission is denied.
- */
- struct GNUNET_MULTICAST_ReplayHandle *
- GNUNET_MULTICAST_join_decision (struct GNUNET_MULTICAST_JoinHandle *join,
- int is_admitted,
- uint16_t relay_count,
- const struct GNUNET_PeerIdentity *relays,
- const struct GNUNET_MessageHeader *join_resp)
- {
- struct GNUNET_MULTICAST_Group *grp = join->group;
- uint16_t join_resp_size = (NULL != join_resp) ? ntohs (join_resp->size) : 0;
- uint16_t relay_size = relay_count * sizeof (*relays);
- struct MulticastJoinDecisionMessageHeader * hdcsn;
- struct MulticastJoinDecisionMessage *dcsn;
- hdcsn = GNUNET_malloc (sizeof (*hdcsn) + sizeof (*dcsn)
- + relay_size + join_resp_size);
- hdcsn->header.size = htons (sizeof (*hdcsn) + sizeof (*dcsn)
- + relay_size + join_resp_size);
- hdcsn->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_JOIN_DECISION);
- hdcsn->member_key = join->member_key;
- hdcsn->peer = join->peer;
- dcsn = (struct MulticastJoinDecisionMessage *) &hdcsn[1];
- dcsn->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_JOIN_DECISION);
- dcsn->header.size = htons (sizeof (*dcsn) + relay_size + join_resp_size);
- dcsn->is_admitted = htonl (is_admitted);
- dcsn->relay_count = htonl (relay_count);
- if (0 < relay_size)
- memcpy (&dcsn[1], relays, relay_size);
- if (0 < join_resp_size)
- memcpy (((char *) &dcsn[1]) + relay_size, join_resp, join_resp_size);
- GNUNET_CLIENT_MANAGER_transmit (grp->client, &hdcsn->header);
- GNUNET_free (join);
- return NULL;
- }
- /**
- * Call informing multicast about the decision taken for a membership test.
- *
- * @param mth Handle that was given for the query.
- * @param result #GNUNET_YES if peer was a member, #GNUNET_NO if peer was not a member,
- * #GNUNET_SYSERR if we cannot answer the membership test.
- */
- void
- GNUNET_MULTICAST_membership_test_result (struct GNUNET_MULTICAST_MembershipTestHandle *mth,
- int result)
- {
- }
- /**
- * Replay a message fragment for the multicast group.
- *
- * @param rh Replay handle identifying which replay operation was requested.
- * @param msg Replayed message fragment, NULL if unknown/error.
- * @param ec Error code.
- */
- void
- GNUNET_MULTICAST_replay_response (struct GNUNET_MULTICAST_ReplayHandle *rh,
- const struct GNUNET_MessageHeader *msg,
- enum GNUNET_MULTICAST_ReplayErrorCode ec)
- {
- }
- /**
- * Indicate the end of the replay session.
- *
- * Invalidates the replay handle.
- *
- * @param rh Replay session to end.
- */
- void
- GNUNET_MULTICAST_replay_response_end (struct GNUNET_MULTICAST_ReplayHandle *rh)
- {
- }
- /**
- * Replay a message for the multicast group.
- *
- * @param rh Replay handle identifying which replay operation was requested.
- * @param notify Function to call to get the message.
- * @param notify_cls Closure for @a notify.
- */
- void
- GNUNET_MULTICAST_replay_response2 (struct GNUNET_MULTICAST_ReplayHandle *rh,
- GNUNET_MULTICAST_ReplayTransmitNotify notify,
- void *notify_cls)
- {
- }
- /**
- * 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
- * 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).
- *
- * @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 max_fragment_id Maximum fragment ID already sent to the group.
- * 0 for a new group.
- * @param join_request_cb Function called to approve / disapprove joining of a peer.
- * @param member_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.
- * @param message_cb Function called with the message fragments sent to the
- * network by GNUNET_MULTICAST_origin_to_all(). These message fragments
- * should be stored for answering replay requests later.
- * @param cls Closure for the various callbacks that follow.
- *
- * @return Handle for the origin, NULL on error.
- */
- struct GNUNET_MULTICAST_Origin *
- GNUNET_MULTICAST_origin_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
- const struct GNUNET_CRYPTO_EddsaPrivateKey *priv_key,
- uint64_t max_fragment_id,
- GNUNET_MULTICAST_JoinRequestCallback join_request_cb,
- GNUNET_MULTICAST_MembershipTestCallback member_test_cb,
- GNUNET_MULTICAST_ReplayFragmentCallback replay_frag_cb,
- GNUNET_MULTICAST_ReplayMessageCallback replay_msg_cb,
- GNUNET_MULTICAST_RequestCallback request_cb,
- GNUNET_MULTICAST_MessageCallback message_cb,
- void *cls)
- {
- struct GNUNET_MULTICAST_Origin *orig = GNUNET_malloc (sizeof (*orig));
- struct GNUNET_MULTICAST_Group *grp = &orig->grp;
- struct MulticastOriginStartMessage *start = GNUNET_malloc (sizeof (*start));
- start->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_ORIGIN_START);
- start->header.size = htons (sizeof (*start));
- start->max_fragment_id = max_fragment_id;
- memcpy (&start->group_key, priv_key, sizeof (*priv_key));
- grp->connect_msg = (struct GNUNET_MessageHeader *) start;
- grp->is_origin = GNUNET_YES;
- grp->cfg = cfg;
- grp->cb_cls = cls;
- grp->join_req_cb = join_request_cb;
- grp->member_test_cb = member_test_cb;
- grp->replay_frag_cb = replay_frag_cb;
- grp->replay_msg_cb = replay_msg_cb;
- grp->message_cb = message_cb;
- orig->request_cb = request_cb;
- grp->client = GNUNET_CLIENT_MANAGER_connect (cfg, "multicast", origin_handlers);
- GNUNET_CLIENT_MANAGER_set_user_context_ (grp->client, orig, sizeof (*grp));
- group_send_connect_msg (grp);
- return orig;
- }
- /**
- * Stop a multicast group.
- *
- * @param origin Multicast group to stop.
- */
- void
- GNUNET_MULTICAST_origin_stop (struct GNUNET_MULTICAST_Origin *orig,
- GNUNET_ContinuationCallback stop_cb,
- void *stop_cls)
- {
- struct GNUNET_MULTICAST_Group *grp = &orig->grp;
- grp->is_disconnecting = GNUNET_YES;
- grp->disconnect_cb = stop_cb;
- grp->disconnect_cls = stop_cls;
- GNUNET_CLIENT_MANAGER_disconnect (orig->grp.client, GNUNET_YES,
- &origin_cleanup, orig);
- }
- static void
- origin_to_all (struct GNUNET_MULTICAST_Origin *orig)
- {
- LOG (GNUNET_ERROR_TYPE_DEBUG, "origin_to_all()\n");
- struct GNUNET_MULTICAST_Group *grp = &orig->grp;
- struct GNUNET_MULTICAST_OriginTransmitHandle *tmit = &orig->tmit;
- size_t buf_size = GNUNET_MULTICAST_FRAGMENT_MAX_SIZE;
- struct GNUNET_MULTICAST_MessageHeader *msg = GNUNET_malloc (buf_size);
- int ret = tmit->notify (tmit->notify_cls, &buf_size, &msg[1]);
- if (! (GNUNET_YES == ret || GNUNET_NO == ret)
- || GNUNET_MULTICAST_FRAGMENT_MAX_SIZE < buf_size)
- {
- LOG (GNUNET_ERROR_TYPE_ERROR,
- "OriginTransmitNotify() returned error or invalid message size.\n");
- /* FIXME: handle error */
- GNUNET_free (msg);
- return;
- }
- if (GNUNET_NO == ret && 0 == buf_size)
- {
- GNUNET_free (msg);
- return; /* Transmission paused. */
- }
- msg->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_MESSAGE);
- msg->header.size = htons (sizeof (*msg) + buf_size);
- msg->message_id = GNUNET_htonll (tmit->message_id);
- msg->group_generation = tmit->group_generation;
- msg->fragment_offset = GNUNET_htonll (tmit->fragment_offset);
- tmit->fragment_offset += sizeof (*msg) + buf_size;
- GNUNET_CLIENT_MANAGER_transmit (grp->client, &msg->header);
- }
- /**
- * Send a message to the multicast group.
- *
- * @param orig 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 struct GNUNET_MULTICAST_MessageHeader.
- * @param notify Function to call to get the message.
- * @param notify_cls Closure for @a notify.
- *
- * @return Message handle on success,
- * NULL on error (i.e. another request is already pending).
- */
- struct GNUNET_MULTICAST_OriginTransmitHandle *
- GNUNET_MULTICAST_origin_to_all (struct GNUNET_MULTICAST_Origin *orig,
- uint64_t message_id,
- uint64_t group_generation,
- GNUNET_MULTICAST_OriginTransmitNotify notify,
- void *notify_cls)
- {
- /* FIXME
- if (GNUNET_YES == orig->grp.in_transmit)
- return NULL;
- orig->grp.in_transmit = GNUNET_YES;
- */
- struct GNUNET_MULTICAST_OriginTransmitHandle *tmit = &orig->tmit;
- tmit->origin = orig;
- tmit->message_id = message_id;
- tmit->group_generation = group_generation;
- tmit->notify = notify;
- tmit->notify_cls = notify_cls;
- origin_to_all (orig);
- return tmit;
- }
- /**
- * Resume message transmission to multicast group.
- *
- * @param th Transmission to cancel.
- */
- void
- GNUNET_MULTICAST_origin_to_all_resume (struct GNUNET_MULTICAST_OriginTransmitHandle *th)
- {
- origin_to_all (th->origin);
- }
- /**
- * Cancel request for message transmission to multicast group.
- *
- * @param th Transmission to cancel.
- */
- void
- GNUNET_MULTICAST_origin_to_all_cancel (struct GNUNET_MULTICAST_OriginTransmitHandle *th)
- {
- }
- /**
- * Join a multicast group.
- *
- * The entity joining is always the local peer. Further information about the
- * candidate can be provided in the @a join_request message. If the join fails, 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
- * anytime by the multicast service to support relaying messages to other
- * members of the group.
- *
- * @param cfg Configuration to use.
- * @param group_key ECC public key that identifies the group to join.
- * @param member_key ECC key that identifies the member and used to sign
- * requests sent to the origin.
- * @param origin Peer ID of the origin to send unicast requsets to. If NULL,
- * unicast requests are sent back via multiple hops on the reverse path
- * of multicast messages.
- * @param relay_count Number of peers in the @a relays array.
- * @param relays Peer identities of members of the group, which serve as relays
- * and can be used to join the group at. and send the @a join_request to.
- * If empty, the @a join_request is sent directly to the @a origin.
- * @param join_msg Application-dependent join message to be passed to the peer
- * @a origin.
- * @param join_request_cb Function called to approve / disapprove joining of a peer.
- * @param join_decision_cb Function called to inform about the join decision.
- * @param member_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.
- * @param replay_msg_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.
- * @param message_cb Function to be called for all message fragments we
- * receive from the group, excluding those our @a replay_cb
- * already has.
- * @param cls Closure for callbacks.
- * @return Handle for the member, NULL on error.
- */
- 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_PeerIdentity *origin,
- uint16_t relay_count,
- const struct GNUNET_PeerIdentity *relays,
- const struct GNUNET_MessageHeader *join_msg,
- GNUNET_MULTICAST_JoinRequestCallback join_request_cb,
- GNUNET_MULTICAST_JoinDecisionCallback join_decision_cb,
- GNUNET_MULTICAST_MembershipTestCallback member_test_cb,
- GNUNET_MULTICAST_ReplayFragmentCallback replay_frag_cb,
- GNUNET_MULTICAST_ReplayMessageCallback replay_msg_cb,
- GNUNET_MULTICAST_MessageCallback message_cb,
- void *cls)
- {
- struct GNUNET_MULTICAST_Member *mem = GNUNET_malloc (sizeof (*mem));
- struct GNUNET_MULTICAST_Group *grp = &mem->grp;
- uint16_t relay_size = relay_count * sizeof (*relays);
- uint16_t join_msg_size = (NULL != join_msg) ? ntohs (join_msg->size) : 0;
- struct MulticastMemberJoinMessage *
- join = GNUNET_malloc (sizeof (*join) + relay_size + join_msg_size);
- join->header.size = htons (sizeof (*join) + relay_size + join_msg_size);
- join->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_MEMBER_JOIN);
- join->group_key = *group_key;
- join->member_key = *member_key;
- join->origin = *origin;
- if (0 < relay_size)
- memcpy (&join[1], relays, relay_size);
- if (0 < join_msg_size)
- memcpy (((char *) &join[1]) + relay_size, join_msg, join_msg_size);
- grp->connect_msg = (struct GNUNET_MessageHeader *) join;
- grp->is_origin = GNUNET_NO;
- grp->cfg = cfg;
- mem->join_dcsn_cb = join_decision_cb;
- grp->join_req_cb = join_request_cb;
- grp->member_test_cb = member_test_cb;
- grp->replay_frag_cb = replay_frag_cb;
- grp->message_cb = message_cb;
- grp->cb_cls = cls;
- grp->client = GNUNET_CLIENT_MANAGER_connect (cfg, "multicast", member_handlers);
- GNUNET_CLIENT_MANAGER_set_user_context_ (grp->client, mem, sizeof (*grp));
- group_send_connect_msg (grp);
- return mem;
- }
- /**
- * Part a multicast group.
- *
- * Disconnects from all group members and invalidates the @a member handle.
- *
- * An application-dependent part message can be transmitted beforehand using
- * #GNUNET_MULTICAST_member_to_origin())
- *
- * @param member Membership handle.
- */
- void
- GNUNET_MULTICAST_member_part (struct GNUNET_MULTICAST_Member *mem,
- GNUNET_ContinuationCallback part_cb,
- void *part_cls)
- {
- struct GNUNET_MULTICAST_Group *grp = &mem->grp;
- grp->is_disconnecting = GNUNET_YES;
- grp->disconnect_cb = part_cb;
- grp->disconnect_cls = part_cls;
- GNUNET_CLIENT_MANAGER_disconnect (mem->grp.client, GNUNET_YES,
- &member_cleanup, mem);
- }
- /**
- * Request a fragment to be replayed by fragment ID.
- *
- * Useful if messages below the @e max_known_fragment_id given when joining are
- * needed and not known to the client.
- *
- * @param member Membership handle.
- * @param fragment_id ID of a message fragment that this client would like to
- see replayed.
- * @param flags Additional flags for the replay request. It is used and defined
- * by the replay callback. FIXME: which replay callback? FIXME: use enum?
- * FIXME: why not pass reply cb here?
- * @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)
- {
- return NULL;
- }
- /**
- * Request a message fragment to be replayed.
- *
- * Useful if messages below the @e max_known_fragment_id given when joining are
- * needed and not known to the client.
- *
- * @param member Membership handle.
- * @param message_id ID of the message this client would like to see replayed.
- * @param fragment_offset Offset of the fragment within the message to replay.
- * @param flags Additional flags for the replay request. It is used & defined
- * by the replay callback.
- * @param result_cb Function to be called for the replayed message.
- * @param result_cb_cls Closure for @a result_cb.
- * @return Replay request handle, NULL on error.
- */
- 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)
- {
- return NULL;
- }
- /**
- * Cancel a replay request.
- *
- * @param rh Request to cancel.
- */
- void
- GNUNET_MULTICAST_member_replay_cancel (struct GNUNET_MULTICAST_MemberReplayHandle *rh)
- {
- }
- static void
- member_to_origin (struct GNUNET_MULTICAST_Member *mem)
- {
- LOG (GNUNET_ERROR_TYPE_DEBUG, "member_to_origin()\n");
- struct GNUNET_MULTICAST_Group *grp = &mem->grp;
- struct GNUNET_MULTICAST_MemberTransmitHandle *tmit = &mem->tmit;
- size_t buf_size = GNUNET_MULTICAST_FRAGMENT_MAX_SIZE;
- struct GNUNET_MULTICAST_RequestHeader *req = GNUNET_malloc (buf_size);
- int ret = tmit->notify (tmit->notify_cls, &buf_size, &req[1]);
- if (! (GNUNET_YES == ret || GNUNET_NO == ret)
- || GNUNET_MULTICAST_FRAGMENT_MAX_SIZE < buf_size)
- {
- LOG (GNUNET_ERROR_TYPE_ERROR,
- "MemberTransmitNotify() returned error or invalid message size.\n");
- /* FIXME: handle error */
- GNUNET_free (req);
- return;
- }
- if (GNUNET_NO == ret && 0 == buf_size)
- {
- /* Transmission paused. */
- GNUNET_free (req);
- return;
- }
- req->header.type = htons (GNUNET_MESSAGE_TYPE_MULTICAST_REQUEST);
- req->header.size = htons (sizeof (*req) + buf_size);
- req->request_id = GNUNET_htonll (tmit->request_id);
- req->fragment_offset = GNUNET_ntohll (tmit->fragment_offset);
- tmit->fragment_offset += sizeof (*req) + buf_size;
- GNUNET_CLIENT_MANAGER_transmit (grp->client, &req->header);
- }
- /**
- * Send a message to the origin of the multicast group.
- *
- * @param mem Membership handle.
- * @param request_id Application layer ID for the request. Opaque to multicast.
- * @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_MemberTransmitHandle *
- GNUNET_MULTICAST_member_to_origin (struct GNUNET_MULTICAST_Member *mem,
- uint64_t request_id,
- GNUNET_MULTICAST_MemberTransmitNotify notify,
- void *notify_cls)
- {
- /* FIXME
- if (GNUNET_YES == mem->grp.in_transmit)
- return NULL;
- mem->grp.in_transmit = GNUNET_YES;
- */
- struct GNUNET_MULTICAST_MemberTransmitHandle *tmit = &mem->tmit;
- tmit->member = mem;
- tmit->request_id = request_id;
- tmit->notify = notify;
- tmit->notify_cls = notify_cls;
- member_to_origin (mem);
- return tmit;
- }
- /**
- * Resume message transmission to origin.
- *
- * @param th Transmission to cancel.
- */
- void
- GNUNET_MULTICAST_member_to_origin_resume (struct GNUNET_MULTICAST_MemberTransmitHandle *th)
- {
- member_to_origin (th->member);
- }
- /**
- * Cancel request for message transmission to origin.
- *
- * @param th Transmission to cancel.
- */
- void
- GNUNET_MULTICAST_member_to_origin_cancel (struct GNUNET_MULTICAST_MemberTransmitHandle *th)
- {
- }
- /* end of multicast_api.c */
|