2 This file is part of GNUnet.
3 Copyright (C) 2009-2016 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
21 * @file core/core_api.c
22 * @brief core service; this is the main API for encrypted P2P
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_constants.h"
29 #include "gnunet_core_service.h"
32 #define LOG(kind,...) GNUNET_log_from (kind, "core-api",__VA_ARGS__)
36 * Handle for a transmission request.
38 struct GNUNET_CORE_TransmitHandle
42 * Corresponding peer record.
44 struct PeerRecord *peer;
47 * Function that will be called to get the actual request
48 * (once we are ready to transmit this request to the core).
49 * The function will be called with a NULL buffer to signal
52 GNUNET_CONNECTION_TransmitReadyNotify get_message;
55 * Closure for @e get_message.
57 void *get_message_cls;
60 * Deadline for the transmission (the request does not get cancelled
61 * at this time, this is merely how soon the application wants this out).
63 struct GNUNET_TIME_Absolute deadline;
66 * When did this request get queued?
68 struct GNUNET_TIME_Absolute request_time;
71 * How important is this message?
73 enum GNUNET_CORE_Priority priority;
81 * Size of this request.
86 * Send message request ID for this request.
94 * Information we track for each peer.
100 * Corresponding CORE handle.
102 struct GNUNET_CORE_Handle *ch;
105 * Pending request, if any. 'th->peer' is set to NULL if the
106 * request is not active.
108 struct GNUNET_CORE_TransmitHandle th;
111 * Peer the record is about.
113 struct GNUNET_PeerIdentity peer;
116 * SendMessageRequest ID generator for this peer.
124 * Context for the core service connection.
126 struct GNUNET_CORE_Handle
130 * Configuration we're using.
132 const struct GNUNET_CONFIGURATION_Handle *cfg;
135 * Closure for the various callbacks.
140 * Function to call once we've handshaked with the core service.
142 GNUNET_CORE_StartupCallback init;
145 * Function to call whenever we're notified about a peer connecting.
147 GNUNET_CORE_ConnectEventHandler connects;
150 * Function to call whenever we're notified about a peer disconnecting.
152 GNUNET_CORE_DisconnectEventHandler disconnects;
155 * Function to call whenever we receive an inbound message.
157 GNUNET_CORE_MessageCallback inbound_notify;
160 * Function to call whenever we receive an outbound message.
162 GNUNET_CORE_MessageCallback outbound_notify;
165 * Function handlers for messages of particular type.
167 struct GNUNET_CORE_MessageHandler *handlers;
170 * Our message queue for transmissions to the service.
172 struct GNUNET_MQ_Handle *mq;
175 * Hash map listing all of the peers that we are currently
178 struct GNUNET_CONTAINER_MultiPeerMap *peers;
181 * Identity of this peer.
183 struct GNUNET_PeerIdentity me;
186 * ID of reconnect task (if any).
188 struct GNUNET_SCHEDULER_Task *reconnect_task;
191 * Current delay we use for re-trying to connect to core.
193 struct GNUNET_TIME_Relative retry_backoff;
196 * Number of entries in the handlers array.
201 * For inbound notifications without a specific handler, do
202 * we expect to only receive headers?
204 int inbound_hdr_only;
207 * For outbound notifications without a specific handler, do
208 * we expect to only receive headers?
210 int outbound_hdr_only;
213 * Are we currently disconnected and hence unable to forward
219 * Did we ever get INIT?
227 * Our current client connection went down. Clean it up
228 * and try to reconnect!
230 * @param h our handle to the core service
233 reconnect (struct GNUNET_CORE_Handle *h);
237 * Task schedule to try to re-connect to core.
239 * @param cls the `struct GNUNET_CORE_Handle`
240 * @param tc task context
243 reconnect_task (void *cls)
245 struct GNUNET_CORE_Handle *h = cls;
247 h->reconnect_task = NULL;
248 LOG (GNUNET_ERROR_TYPE_DEBUG,
249 "Connecting to CORE service after delay\n");
255 * Notify clients about disconnect and free the entry for connected
258 * @param cls the `struct GNUNET_CORE_Handle *`
259 * @param key the peer identity (not used)
260 * @param value the `struct PeerRecord` to free.
261 * @return #GNUNET_YES (continue)
264 disconnect_and_free_peer_entry (void *cls,
265 const struct GNUNET_PeerIdentity *key,
268 struct GNUNET_CORE_Handle *h = cls;
269 struct GNUNET_CORE_TransmitHandle *th;
270 struct PeerRecord *pr = value;
272 if (NULL != h->disconnects)
273 h->disconnects (h->cls,
275 /* all requests should have been cancelled, clean up anyway, just in case */
277 if (NULL != th->peer)
282 /* done with 'voluntary' cleanups, now on to normal freeing */
283 GNUNET_assert (GNUNET_YES ==
284 GNUNET_CONTAINER_multipeermap_remove (h->peers,
287 GNUNET_assert (pr->ch == h);
294 * Close down any existing connection to the CORE service and
295 * try re-establishing it later.
297 * @param h our handle
300 reconnect_later (struct GNUNET_CORE_Handle *h)
302 GNUNET_assert (NULL == h->reconnect_task);
305 GNUNET_MQ_destroy (h->mq);
308 h->currently_down = GNUNET_YES;
309 GNUNET_assert (h->reconnect_task == NULL);
311 GNUNET_SCHEDULER_add_delayed (h->retry_backoff,
314 GNUNET_CONTAINER_multipeermap_iterate (h->peers,
315 &disconnect_and_free_peer_entry,
317 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
322 * Generic error handler, called with the appropriate error code and
323 * the same closure specified at the creation of the message queue.
324 * Not every message queue implementation supports an error handler.
326 * @param cls closure, a `struct GNUNET_CORE_Handle *`
327 * @param error error code
330 handle_mq_error (void *cls,
331 enum GNUNET_MQ_Error error)
333 struct GNUNET_CORE_Handle *h = cls;
335 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
343 * Handle init reply message received from CORE service. Notify
344 * application that we are now connected to the CORE. Also fake
345 * loopback connection.
347 * @param cls the `struct GNUNET_CORE_Handle`
348 * @param m the init reply
351 handle_init_reply (void *cls,
352 const struct InitReplyMessage *m)
354 struct GNUNET_CORE_Handle *h = cls;
355 GNUNET_CORE_StartupCallback init;
356 struct PeerRecord *pr;
358 GNUNET_break (0 == ntohl (m->reserved));
359 GNUNET_break (GNUNET_YES == h->currently_down);
360 h->currently_down = GNUNET_NO;
361 h->retry_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
362 if (NULL != (init = h->init))
364 /* mark so we don't call init on reconnect */
366 h->me = m->my_identity;
367 LOG (GNUNET_ERROR_TYPE_DEBUG,
368 "Connected to core service of peer `%s'.\n",
369 GNUNET_i2s (&h->me));
370 h->have_init = GNUNET_YES;
376 LOG (GNUNET_ERROR_TYPE_DEBUG,
377 "Successfully reconnected to core service.\n");
378 if (GNUNET_NO == h->have_init)
380 h->me = m->my_identity;
381 h->have_init = GNUNET_YES;
385 GNUNET_break (0 == memcmp (&h->me,
387 sizeof (struct GNUNET_PeerIdentity)));
390 /* fake 'connect to self' */
391 pr = GNUNET_new (struct PeerRecord);
394 GNUNET_assert (GNUNET_YES ==
395 GNUNET_CONTAINER_multipeermap_put (h->peers,
398 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
399 if (NULL != h->connects)
406 * Handle connect message received from CORE service.
407 * Notify the application about the new connection.
409 * @param cls the `struct GNUNET_CORE_Handle`
410 * @param cnm the connect message
413 handle_connect_notify (void *cls,
414 const struct ConnectNotifyMessage *cnm)
416 struct GNUNET_CORE_Handle *h = cls;
417 struct PeerRecord *pr;
419 GNUNET_break (GNUNET_NO == h->currently_down);
420 LOG (GNUNET_ERROR_TYPE_DEBUG,
421 "Received notification about connection from `%s'.\n",
422 GNUNET_i2s (&cnm->peer));
423 if (0 == memcmp (&h->me,
425 sizeof (struct GNUNET_PeerIdentity)))
427 /* connect to self!? */
431 pr = GNUNET_CONTAINER_multipeermap_get (h->peers,
439 pr = GNUNET_new (struct PeerRecord);
440 pr->peer = cnm->peer;
442 GNUNET_assert (GNUNET_YES ==
443 GNUNET_CONTAINER_multipeermap_put (h->peers,
446 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
447 if (NULL != h->connects)
454 * Handle disconnect message received from CORE service.
455 * Notify the application about the lost connection.
457 * @param cls the `struct GNUNET_CORE_Handle`
458 * @param dnm message about the disconnect event
461 handle_disconnect_notify (void *cls,
462 const struct DisconnectNotifyMessage * dnm)
464 struct GNUNET_CORE_Handle *h = cls;
465 struct PeerRecord *pr;
467 GNUNET_break (GNUNET_NO == h->currently_down);
468 if (0 == memcmp (&h->me,
470 sizeof (struct GNUNET_PeerIdentity)))
472 /* connection to self!? */
476 GNUNET_break (0 == ntohl (dnm->reserved));
477 LOG (GNUNET_ERROR_TYPE_DEBUG,
478 "Received notification about disconnect from `%s'.\n",
479 GNUNET_i2s (&dnm->peer));
480 pr = GNUNET_CONTAINER_multipeermap_get (h->peers,
488 disconnect_and_free_peer_entry (h,
495 * Check that message received from CORE service is well-formed.
497 * @param cls the `struct GNUNET_CORE_Handle`
498 * @param ntm the message we got
499 * @return #GNUNET_OK if the message is well-formed
502 check_notify_inbound (void *cls,
503 const struct NotifyTrafficMessage *ntm)
505 struct GNUNET_CORE_Handle *h = cls;
507 const struct GNUNET_MessageHeader *em;
509 GNUNET_break (GNUNET_NO == h->currently_down);
510 msize = ntohs (ntm->header.size) - sizeof (struct NotifyTrafficMessage);
511 if (msize < sizeof (struct GNUNET_MessageHeader))
514 return GNUNET_SYSERR;
516 em = (const struct GNUNET_MessageHeader *) &ntm[1];
517 if ( (GNUNET_NO == h->inbound_hdr_only) &&
518 (msize != ntohs (em->size)) )
521 return GNUNET_SYSERR;
528 * Handle inbound message received from CORE service. If applicable,
529 * notify the application.
531 * @param cls the `struct GNUNET_CORE_Handle`
532 * @param ntm the message we got from CORE.
535 handle_notify_inbound (void *cls,
536 const struct NotifyTrafficMessage *ntm)
538 struct GNUNET_CORE_Handle *h = cls;
539 const struct GNUNET_MessageHeader *em;
540 struct PeerRecord *pr;
543 GNUNET_break (GNUNET_NO == h->currently_down);
544 LOG (GNUNET_ERROR_TYPE_DEBUG,
545 "Received inbound message from `%s'.\n",
546 GNUNET_i2s (&ntm->peer));
547 em = (const struct GNUNET_MessageHeader *) &ntm[1];
548 et = ntohs (em->type);
549 for (unsigned int hpos = 0; NULL != h->handlers[hpos].callback; hpos++)
551 const struct GNUNET_CORE_MessageHandler *mh;
553 mh = &h->handlers[hpos];
556 if ( (mh->expected_size != ntohs (em->size)) &&
557 (0 != mh->expected_size) )
559 LOG (GNUNET_ERROR_TYPE_ERROR,
560 "Unexpected message size %u for message of type %u from peer `%s'\n",
563 GNUNET_i2s (&ntm->peer));
567 pr = GNUNET_CONTAINER_multipeermap_get (h->peers,
576 h->handlers[hpos].callback (h->cls,
580 /* error in processing, do not process other messages! */
584 if (NULL != h->inbound_notify)
585 h->inbound_notify (h->cls,
592 * Check that message received from CORE service is well-formed.
594 * @param cls the `struct GNUNET_CORE_Handle`
595 * @param ntm the message we got
596 * @return #GNUNET_OK if the message is well-formed
599 check_notify_outbound (void *cls,
600 const struct NotifyTrafficMessage *ntm)
602 struct GNUNET_CORE_Handle *h = cls;
604 const struct GNUNET_MessageHeader *em;
606 GNUNET_break (GNUNET_NO == h->currently_down);
607 LOG (GNUNET_ERROR_TYPE_DEBUG,
608 "Received outbound message from `%s'.\n",
609 GNUNET_i2s (&ntm->peer));
610 msize = ntohs (ntm->header.size) - sizeof (struct NotifyTrafficMessage);
611 if (msize < sizeof (struct GNUNET_MessageHeader))
614 return GNUNET_SYSERR;
616 em = (const struct GNUNET_MessageHeader *) &ntm[1];
617 if ( (GNUNET_NO == h->outbound_hdr_only) &&
618 (msize != ntohs (em->size)) )
621 return GNUNET_SYSERR;
628 * Handle outbound message received from CORE service. If applicable,
629 * notify the application.
631 * @param cls the `struct GNUNET_CORE_Handle`
632 * @param ntm the message we got
635 handle_notify_outbound (void *cls,
636 const struct NotifyTrafficMessage *ntm)
638 struct GNUNET_CORE_Handle *h = cls;
639 const struct GNUNET_MessageHeader *em;
641 GNUNET_break (GNUNET_NO == h->currently_down);
642 em = (const struct GNUNET_MessageHeader *) &ntm[1];
643 LOG (GNUNET_ERROR_TYPE_DEBUG,
644 "Received notification about transmission to `%s'.\n",
645 GNUNET_i2s (&ntm->peer));
646 if (NULL == h->outbound_notify)
651 h->outbound_notify (h->cls,
658 * Handle message received from CORE service notifying us that we are
659 * now allowed to send a message to a peer. If that message is still
660 * pending, put it into the queue to be transmitted.
662 * @param cls the `struct GNUNET_CORE_Handle`
663 * @param ntm the message we got
666 handle_send_ready (void *cls,
667 const struct SendMessageReady *smr)
669 struct GNUNET_CORE_Handle *h = cls;
670 struct PeerRecord *pr;
671 struct GNUNET_CORE_TransmitHandle *th;
672 struct SendMessage *sm;
673 struct GNUNET_MQ_Envelope *env;
674 struct GNUNET_TIME_Relative delay;
675 struct GNUNET_TIME_Relative overdue;
677 unsigned int priority;
680 GNUNET_break (GNUNET_NO == h->currently_down);
681 pr = GNUNET_CONTAINER_multipeermap_get (h->peers,
689 LOG (GNUNET_ERROR_TYPE_DEBUG,
690 "Received notification about transmission readiness to `%s'.\n",
691 GNUNET_i2s (&smr->peer));
692 if (NULL == pr->th.peer)
694 /* request must have been cancelled between the original request
695 * and the response from CORE, ignore CORE's readiness */
699 if (ntohs (smr->smr_id) != th->smr_id)
701 /* READY message is for expired or cancelled message,
702 * ignore! (we should have already sent another request) */
705 /* ok, all good, send message out! */
707 env = GNUNET_MQ_msg_extra (sm,
709 GNUNET_MESSAGE_TYPE_CORE_SEND);
710 sm->priority = htonl ((uint32_t) th->priority);
711 sm->deadline = GNUNET_TIME_absolute_hton (th->deadline);
713 sm->cork = htonl ((uint32_t) (cork = th->cork));
714 sm->reserved = htonl (0);
715 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
716 "Calling get_message with buffer of %u bytes (%s)\n",
717 (unsigned int) th->msize,
718 cork ? "corked" : "uncorked");
719 /* FIXME: this is ugly and a bit brutal, but "get_message"
720 may call GNUNET_CORE_notify_transmit_ready() which
721 may call GNUNET_MQ_send() as well, and we MUST get this
722 message out before the next SEND_REQUEST. So we queue
723 it (even though incomplete) and then---relying on MQ being
724 nice and not actually touching 'env' until much later---
725 fill it afterwards. This is horrible style, and once
726 the core_api abandons GNUNET_CORE_notify_transmit_ready
727 in favor of an MQ-style API, this hack should no longer
729 GNUNET_MQ_send (h->mq,
731 delay = GNUNET_TIME_absolute_get_duration (th->request_time);
732 overdue = GNUNET_TIME_absolute_get_duration (th->deadline);
733 priority = th->priority;
734 ret = th->get_message (th->get_message_cls,
737 /* after this point, 'th' should not be used anymore, it
738 may now be about another message! */
739 sm->header.size = htons (ret + sizeof (struct SendMessage));
740 if (overdue.rel_value_us > GNUNET_CONSTANTS_LATENCY_WARN.rel_value_us)
741 LOG (GNUNET_ERROR_TYPE_WARNING,
742 "Transmitting overdue %u bytes to `%s' at priority %u with %s delay %s\n",
744 GNUNET_i2s (&pr->peer),
746 GNUNET_STRINGS_relative_time_to_string (delay,
748 (cork) ? " (corked)" : " (uncorked)");
750 LOG (GNUNET_ERROR_TYPE_DEBUG,
751 "Transmitting %u bytes to `%s' at priority %u with %s delay %s\n",
753 GNUNET_i2s (&pr->peer),
755 GNUNET_STRINGS_relative_time_to_string (delay,
757 (cork) ? " (corked)" : " (uncorked)");
762 * Our current client connection went down. Clean it up and try to
765 * @param h our handle to the core service
768 reconnect (struct GNUNET_CORE_Handle *h)
770 GNUNET_MQ_hd_fixed_size (init_reply,
771 GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY,
772 struct InitReplyMessage);
773 GNUNET_MQ_hd_fixed_size (connect_notify,
774 GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT,
775 struct ConnectNotifyMessage);
776 GNUNET_MQ_hd_fixed_size (disconnect_notify,
777 GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT,
778 struct DisconnectNotifyMessage);
779 GNUNET_MQ_hd_var_size (notify_inbound,
780 GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND,
781 struct NotifyTrafficMessage);
782 GNUNET_MQ_hd_var_size (notify_outbound,
783 GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND,
784 struct NotifyTrafficMessage);
785 GNUNET_MQ_hd_fixed_size (send_ready,
786 GNUNET_MESSAGE_TYPE_CORE_SEND_READY,
787 struct SendMessageReady);
788 struct GNUNET_MQ_MessageHandler handlers[] = {
789 make_init_reply_handler (h),
790 make_connect_notify_handler (h),
791 make_disconnect_notify_handler (h),
792 make_notify_inbound_handler (h),
793 make_notify_outbound_handler (h),
794 make_send_ready_handler (h),
795 GNUNET_MQ_handler_end ()
797 struct InitMessage *init;
798 struct GNUNET_MQ_Envelope *env;
802 GNUNET_assert (NULL == h->mq);
803 GNUNET_assert (GNUNET_YES == h->currently_down);
804 h->mq = GNUNET_CLIENT_connecT (h->cfg,
814 env = GNUNET_MQ_msg_extra (init,
815 sizeof (uint16_t) * h->hcnt,
816 GNUNET_MESSAGE_TYPE_CORE_INIT);
818 if (NULL != h->inbound_notify)
820 if (h->inbound_hdr_only)
821 opt |= GNUNET_CORE_OPTION_SEND_HDR_INBOUND;
823 opt |= GNUNET_CORE_OPTION_SEND_FULL_INBOUND;
825 if (NULL != h->outbound_notify)
827 if (h->outbound_hdr_only)
828 opt |= GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND;
830 opt |= GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND;
832 LOG (GNUNET_ERROR_TYPE_INFO,
833 "(Re)connecting to CORE service, monitoring messages of type %u\n",
835 init->options = htonl (opt);
836 ts = (uint16_t *) &init[1];
837 for (unsigned int hpos = 0; hpos < h->hcnt; hpos++)
838 ts[hpos] = htons (h->handlers[hpos].type);
839 GNUNET_MQ_send (h->mq,
845 * Connect to the core service. Note that the connection may complete
846 * (or fail) asynchronously.
848 * @param cfg configuration to use
849 * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
850 * @param init callback to call once we have successfully
851 * connected to the core service
852 * @param connects function to call on peer connect, can be NULL
853 * @param disconnects function to call on peer disconnect / timeout, can be NULL
854 * @param inbound_notify function to call for all inbound messages, can be NULL
855 * @param inbound_hdr_only set to #GNUNET_YES if inbound_notify will only read the
856 * GNUNET_MessageHeader and hence we do not need to give it the full message;
857 * can be used to improve efficiency, ignored if @a inbound_notify is NULL
858 * @param outbound_notify function to call for all outbound messages, can be NULL
859 * @param outbound_hdr_only set to #GNUNET_YES if outbound_notify will only read the
860 * GNUNET_MessageHeader and hence we do not need to give it the full message
861 * can be used to improve efficiency, ignored if @a outbound_notify is NULL
862 * @param handlers callbacks for messages we care about, NULL-terminated
863 * @return handle to the core service (only useful for disconnect until @a init is called);
864 * NULL on error (in this case, init is never called)
866 struct GNUNET_CORE_Handle *
867 GNUNET_CORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
869 GNUNET_CORE_StartupCallback init,
870 GNUNET_CORE_ConnectEventHandler connects,
871 GNUNET_CORE_DisconnectEventHandler disconnects,
872 GNUNET_CORE_MessageCallback inbound_notify,
873 int inbound_hdr_only,
874 GNUNET_CORE_MessageCallback outbound_notify,
875 int outbound_hdr_only,
876 const struct GNUNET_CORE_MessageHandler *handlers)
878 struct GNUNET_CORE_Handle *h;
881 h = GNUNET_new (struct GNUNET_CORE_Handle);
885 h->connects = connects;
886 h->disconnects = disconnects;
887 h->inbound_notify = inbound_notify;
888 h->outbound_notify = outbound_notify;
889 h->inbound_hdr_only = inbound_hdr_only;
890 h->outbound_hdr_only = outbound_hdr_only;
891 h->currently_down = GNUNET_YES;
892 h->peers = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
894 if (NULL != handlers)
895 while (NULL != handlers[hcnt].callback)
897 h->handlers = GNUNET_new_array (hcnt + 1,
898 struct GNUNET_CORE_MessageHandler);
899 if (NULL != handlers)
900 GNUNET_memcpy (h->handlers,
902 hcnt * sizeof (struct GNUNET_CORE_MessageHandler));
904 GNUNET_assert (hcnt <
905 (GNUNET_SERVER_MAX_MESSAGE_SIZE -
906 sizeof (struct InitMessage)) / sizeof (uint16_t));
907 LOG (GNUNET_ERROR_TYPE_DEBUG,
908 "Connecting to CORE service\n");
912 GNUNET_CORE_disconnect (h);
920 * Connect to the core service. Note that the connection may complete
921 * (or fail) asynchronously. This function primarily causes the given
922 * callback notification functions to be invoked whenever the
923 * specified event happens. The maximum number of queued
924 * notifications (queue length) is per client; the queue is shared
925 * across all types of notifications. So a slow client that registers
926 * for @a outbound_notify also risks missing @a inbound_notify messages.
927 * Certain events (such as connect/disconnect notifications) are not
928 * subject to queue size limitations.
930 * @param cfg configuration to use
931 * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
932 * @param init callback to call once we have successfully
933 * connected to the core service
934 * @param connects function to call on peer connect, can be NULL
935 * @param disconnects function to call on peer disconnect / timeout, can be NULL
936 * @param handlers callbacks for messages we care about, NULL-terminated
937 * note that the core is allowed to drop notifications about inbound
938 * messages if the client does not process them fast enough (for this
939 * notification type, a bounded queue is used)
940 * @return handle to the core service (only useful for disconnect until @a init is called),
941 * NULL on error (in this case, init is never called)
943 struct GNUNET_CORE_Handle *
944 GNUNET_CORE_connecT (const struct GNUNET_CONFIGURATION_Handle *cfg,
946 GNUNET_CORE_StartupCallback init,
947 GNUNET_CORE_ConnecTEventHandler connects,
948 GNUNET_CORE_DisconnecTEventHandler disconnects,
949 const struct GNUNET_MQ_MessageHandler *handlers)
951 GNUNET_break (0); // not implemented
952 // NOTE: re-enable core-related tests in ats-tests/ once implemented!
958 * Disconnect from the core service. This function can only
959 * be called *after* all pending #GNUNET_CORE_notify_transmit_ready()
960 * requests have been explicitly canceled.
962 * @param handle connection to core to disconnect
965 GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle)
967 LOG (GNUNET_ERROR_TYPE_DEBUG,
968 "Disconnecting from CORE service\n");
969 GNUNET_CONTAINER_multipeermap_iterate (handle->peers,
970 &disconnect_and_free_peer_entry,
972 GNUNET_CONTAINER_multipeermap_destroy (handle->peers);
973 handle->peers = NULL;
974 if (NULL != handle->reconnect_task)
976 GNUNET_SCHEDULER_cancel (handle->reconnect_task);
977 handle->reconnect_task = NULL;
979 if (NULL != handle->mq)
981 GNUNET_MQ_destroy (handle->mq);
984 GNUNET_free (handle->handlers);
985 GNUNET_free (handle);
990 * Ask the core to call @a notify once it is ready to transmit the
991 * given number of bytes to the specified @a target. Must only be
992 * called after a connection to the respective peer has been
993 * established (and the client has been informed about this). You may
994 * have one request of this type pending for each connected peer at
995 * any time. If a peer disconnects, the application MUST call
996 * #GNUNET_CORE_notify_transmit_ready_cancel on the respective
997 * transmission request, if one such request is pending.
999 * @param handle connection to core service
1000 * @param cork is corking allowed for this transmission?
1001 * @param priority how important is the message?
1002 * @param maxdelay how long can the message wait? Only effective if @a cork is #GNUNET_YES
1003 * @param target who should receive the message, never NULL (can be this peer's identity for loopback)
1004 * @param notify_size how many bytes of buffer space does @a notify want?
1005 * @param notify function to call when buffer space is available;
1006 * will be called with NULL on timeout; clients MUST cancel
1007 * all pending transmission requests DURING the disconnect
1009 * @param notify_cls closure for @a notify
1010 * @return non-NULL if the notify callback was queued,
1011 * NULL if we can not even queue the request (request already pending);
1012 * if NULL is returned, @a notify will NOT be called.
1014 struct GNUNET_CORE_TransmitHandle *
1015 GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle,
1017 enum GNUNET_CORE_Priority priority,
1018 struct GNUNET_TIME_Relative maxdelay,
1019 const struct GNUNET_PeerIdentity *target,
1021 GNUNET_CONNECTION_TransmitReadyNotify notify,
1024 struct PeerRecord *pr;
1025 struct GNUNET_CORE_TransmitHandle *th;
1026 struct SendMessageRequest *smr;
1027 struct GNUNET_MQ_Envelope *env;
1029 if (NULL == handle->mq)
1031 GNUNET_break (0); /* SEE #4588: do not call NTR from disconnect notification! */
1034 GNUNET_assert (NULL != notify);
1035 if ( (notify_size > GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE) ||
1036 (notify_size + sizeof (struct SendMessage) >= GNUNET_SERVER_MAX_MESSAGE_SIZE) )
1041 LOG (GNUNET_ERROR_TYPE_DEBUG,
1042 "Asking core for transmission of %u bytes to `%s'%s\n",
1043 (unsigned int) notify_size,
1044 GNUNET_i2s (target),
1045 cork ? " (corked)" : "");
1046 pr = GNUNET_CONTAINER_multipeermap_get (handle->peers,
1050 /* attempt to send to peer that is not connected */
1054 if (NULL != pr->th.peer)
1056 /* attempting to queue a second request for the same destination */
1063 sizeof (struct GNUNET_CORE_TransmitHandle));
1065 th->get_message = notify;
1066 th->get_message_cls = notify_cls;
1067 th->request_time = GNUNET_TIME_absolute_get ();
1068 if (GNUNET_YES == cork)
1069 th->deadline = GNUNET_TIME_relative_to_absolute (maxdelay);
1071 th->deadline = th->request_time;
1072 th->priority = priority;
1073 th->msize = notify_size;
1075 if (NULL == handle->mq)
1076 return th; /* see #4588 (hack until we transition core fully to MQ) */
1077 env = GNUNET_MQ_msg (smr,
1078 GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST);
1079 smr->priority = htonl ((uint32_t) th->priority);
1080 smr->deadline = GNUNET_TIME_absolute_hton (th->deadline);
1081 smr->peer = pr->peer;
1082 smr->reserved = htonl (0);
1083 smr->size = htons (th->msize);
1084 smr->smr_id = htons (th->smr_id = pr->smr_id_gen++);
1085 GNUNET_MQ_send (handle->mq,
1087 LOG (GNUNET_ERROR_TYPE_DEBUG,
1088 "Transmission request added to queue\n");
1094 * Cancel the specified transmission-ready notification.
1096 * @param th handle that was returned by #GNUNET_CORE_notify_transmit_ready().
1099 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle *th)
1101 struct PeerRecord *pr = th->peer;
1103 LOG (GNUNET_ERROR_TYPE_DEBUG,
1104 "Aborting transmission request to core for %u bytes to `%s'\n",
1105 (unsigned int) th->msize,
1106 GNUNET_i2s (&pr->peer));
1112 * Check if the given peer is currently connected. This function is for special
1113 * cirumstances (GNUNET_TESTBED uses it), normal users of the CORE API are
1114 * expected to track which peers are connected based on the connect/disconnect
1115 * callbacks from #GNUNET_CORE_connect(). This function is NOT part of the
1116 * 'versioned', 'official' API. The difference between this function and the
1117 * function GNUNET_CORE_is_peer_connected() is that this one returns
1118 * synchronously after looking in the CORE API cache. The function
1119 * GNUNET_CORE_is_peer_connected() sends a message to the CORE service and hence
1120 * its response is given asynchronously.
1122 * @param h the core handle
1123 * @param pid the identity of the peer to check if it has been connected to us
1124 * @return #GNUNET_YES if the peer is connected to us; #GNUNET_NO if not
1127 GNUNET_CORE_is_peer_connected_sync (const struct GNUNET_CORE_Handle *h,
1128 const struct GNUNET_PeerIdentity *pid)
1130 return GNUNET_CONTAINER_multipeermap_contains (h->peers,
1135 /* end of core_api.c */