2 This file is part of GNUnet.
3 (C) 2009 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 2, 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 core/core_api.c
23 * @brief core service; this is the main API for encrypted P2P
25 * @author Christian Grothoff
28 #include "gnunet_core_service.h"
33 * Context for the core service connection.
35 struct GNUNET_CORE_Handle
41 struct GNUNET_SCHEDULER_Handle *sched;
44 * Configuration we're using.
46 struct GNUNET_CONFIGURATION_Handle *cfg;
49 * Closure for the various callbacks.
54 * Function to call once we've handshaked with the core service.
56 GNUNET_CORE_StartupCallback init;
59 * Function to call whenever we're notified about a peer connecting.
61 GNUNET_CORE_ClientEventHandler connects;
64 * Function to call whenever we're notified about a peer disconnecting.
66 GNUNET_CORE_ClientEventHandler disconnects;
69 * Function to call whenever we're asked to generate traffic
70 * (data provided to be transmitted back to the service).
72 GNUNET_CORE_BufferFillCallback bfc;
75 * Function to call whenever we receive an inbound message.
77 GNUNET_CORE_MessageCallback inbound_notify;
80 * Function to call whenever we receive an outbound message.
82 GNUNET_CORE_MessageCallback outbound_notify;
85 * Function handlers for messages of particular type.
87 const struct GNUNET_CORE_MessageHandler *handlers;
90 * Our connection to the service.
92 struct GNUNET_CLIENT_Connection *client;
95 * Handle for our current transmission request.
97 struct GNUNET_NETWORK_TransmitHandle *th;
100 * Head of doubly-linked list of pending requests.
102 struct GNUNET_CORE_TransmitHandle *pending_head;
105 * Tail of doubly-linked list of pending requests.
107 struct GNUNET_CORE_TransmitHandle *pending_tail;
110 * Currently submitted request (or NULL)
112 struct GNUNET_CORE_TransmitHandle *submitted;
115 * How long to wait until we time out the connection attempt?
117 struct GNUNET_TIME_Absolute startup_timeout;
120 * ID of reconnect task (if any).
122 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
125 * Number of entries in the handlers array.
130 * For inbound notifications without a specific handler, do
131 * we expect to only receive headers?
133 int inbound_hdr_only;
136 * For outbound notifications without a specific handler, do
137 * we expect to only receive headers?
139 int outbound_hdr_only;
142 * Are we currently disconnected and hence unable to forward
150 * Handle for a transmission request.
152 struct GNUNET_CORE_TransmitHandle
156 * We keep active transmit handles in a doubly-linked list.
158 struct GNUNET_CORE_TransmitHandle *next;
161 * We keep active transmit handles in a doubly-linked list.
163 struct GNUNET_CORE_TransmitHandle *prev;
166 * Corresponding core handle.
168 struct GNUNET_CORE_Handle *ch;
171 * Function that will be called to get the actual request
172 * (once we are ready to transmit this request to the core).
173 * The function will be called with a NULL buffer to signal
176 GNUNET_NETWORK_TransmitReadyNotify get_message;
179 * Closure for get_message.
181 void *get_message_cls;
184 * If this entry is for a configuration request, pointer
185 * to the information callback; otherwise NULL.
187 GNUNET_CORE_PeerConfigurationInfoCallback info;
195 * If this entry is for a transmission request, pointer
196 * to the notify callback; otherwise NULL.
198 GNUNET_NETWORK_TransmitReadyNotify notify;
201 * Closure for notify.
206 * Peer the request is about.
208 struct GNUNET_PeerIdentity peer;
211 * Timeout for this handle.
213 struct GNUNET_TIME_Absolute timeout;
216 * ID of timeout task.
218 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
221 * How important is this message?
226 * Size of this request.
235 * Function called when we are ready to transmit our
236 * "START" message (or when this operation timed out).
239 * @param size number of bytes available in buf
240 * @param buf where the callee should write the message
241 * @return number of bytes written to buf
243 static size_t transmit_start (void *cls, size_t size, void *buf);
247 * Our current client connection went down. Clean it up
248 * and try to reconnect!
251 reconnect (struct GNUNET_CORE_Handle *h)
253 GNUNET_CLIENT_disconnect (h->client);
254 h->currently_down = GNUNET_YES;
255 h->client = GNUNET_CLIENT_connect (h->sched, "core", h->cfg);
256 h->th = GNUNET_CLIENT_notify_transmit_ready (h->client,
257 sizeof (struct InitMessage) +
258 sizeof (uint16_t) * h->hcnt,
259 GNUNET_TIME_UNIT_SECONDS,
265 * The given request hit its timeout. Remove from the
266 * doubly-linked list and call the respective continuation.
268 * @param cls the transmit handle of the request that timed out
269 * @param tc context, can be NULL (!)
272 timeout_request (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
274 struct GNUNET_CORE_TransmitHandle *th = cls;
275 struct GNUNET_CORE_Handle *h;
278 th->timeout_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
279 GNUNET_assert (0 == th->get_message (th->get_message_cls, 0, NULL));
280 GNUNET_CORE_notify_transmit_ready_cancel (th);
285 * Function called when we are ready to transmit a request from our
286 * request list (or when this operation timed out).
289 * @param size number of bytes available in buf
290 * @param buf where the callee should write the message
291 * @return number of bytes written to buf
294 request_start (void *cls, size_t size, void *buf)
296 struct GNUNET_CORE_Handle *h = cls;
297 struct GNUNET_CORE_TransmitHandle *th;
301 th = h->pending_head;
304 timeout_request (th, NULL);
307 /* create new timeout task (in case core takes too long to respond!) */
308 th->timeout_task = GNUNET_SCHEDULER_add_delayed (h->sched,
310 GNUNET_SCHEDULER_PRIORITY_KEEP,
311 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
312 GNUNET_TIME_absolute_get_remaining
314 &timeout_request, th);
315 /* remove th from doubly-linked pending list, move to submitted */
316 GNUNET_assert (th->prev == NULL);
317 h->pending_head = th->next;
318 if (th->next == NULL)
319 h->pending_tail = NULL;
321 th->next->prev = NULL;
322 GNUNET_assert (h->submitted == NULL);
324 GNUNET_assert (size >= th->msize);
325 ret = th->get_message (th->get_message_cls, size, buf);
326 GNUNET_assert (ret <= size);
332 * Check the list of pending requests, send the next
336 trigger_next_request (struct GNUNET_CORE_Handle *h)
338 struct GNUNET_CORE_TransmitHandle *th;
339 if (h->currently_down)
340 return; /* connection temporarily down */
341 if (NULL == (th = h->pending_head))
342 return; /* no requests pending */
343 GNUNET_assert (NULL == h->th);
344 GNUNET_SCHEDULER_cancel (h->sched, th->timeout_task);
345 th->timeout_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
346 h->th = GNUNET_CLIENT_notify_transmit_ready (h->client,
348 GNUNET_TIME_absolute_get_remaining
349 (th->timeout), &request_start,
355 * cls is a pointer to a 32 bit number followed by that
356 * amount of data. If possible, copy to buf and return
357 * number of bytes copied. Always free the buffer.
360 copy_and_free (void *cls, size_t size, void *buf)
365 memcpy (&have, cbuf, sizeof (uint32_t));
368 /* timeout / error case */
372 memcpy (buf, cbuf + sizeof (uint32_t), have);
379 * Call bfc callback to solicit traffic for the given peer.
382 solicit_traffic (struct GNUNET_CORE_Handle *h,
383 const struct GNUNET_PeerIdentity *peer, uint32_t amount)
389 have = h->bfc (h->cls, peer, buf, amount);
392 GNUNET_assert (have >= sizeof (struct GNUNET_MessageHeader));
393 cbuf = GNUNET_malloc (have + sizeof (uint32_t));
394 memcpy (cbuf, &have, sizeof (uint32_t));
395 memcpy (cbuf + sizeof (uint32_t), buf, have);
396 GNUNET_CORE_notify_transmit_ready (h,
398 GNUNET_TIME_UNIT_SECONDS,
399 peer, have, ©_and_free, cbuf);
404 * Handler for most messages received from the core.
407 main_handler (void *cls, const struct GNUNET_MessageHeader *msg)
409 struct GNUNET_CORE_Handle *h = cls;
411 const struct ConnectNotifyMessage *cnm;
412 const struct NotifyTrafficMessage *ntm;
413 const struct ConfigurationInfoMessage *cim;
414 const struct SolicitTrafficMessage *stm;
415 const struct GNUNET_MessageHeader *em;
419 const struct GNUNET_CORE_MessageHandler *mh;
423 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
425 ("Client was disconnected from core service, trying to reconnect.\n"));
429 msize = ntohs (msg->size);
430 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
431 "Processing message of type %u and size %u from core service\n",
432 ntohs (msg->type), msize);
433 switch (ntohs (msg->type))
435 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT:
436 if (NULL == h->connects)
441 if (msize != sizeof (struct ConnectNotifyMessage))
446 cnm = (const struct ConnectNotifyMessage *) msg;
448 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT:
449 if (NULL == h->disconnects)
454 if (msize != sizeof (struct ConnectNotifyMessage))
459 cnm = (const struct ConnectNotifyMessage *) msg;
461 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND:
463 sizeof (struct NotifyTrafficMessage) +
464 sizeof (struct GNUNET_MessageHeader))
469 ntm = (const struct NotifyTrafficMessage *) msg;
470 em = (const struct GNUNET_MessageHeader *) &ntm[1];
471 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
472 "Received message of type %u from peer `%4s'\n",
473 ntohs (em->type), GNUNET_i2s (&ntm->peer));
474 if ((GNUNET_NO == h->inbound_hdr_only) &&
475 (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage)))
480 et = ntohs (em->type);
481 for (hpos = 0; hpos < h->hcnt; hpos++)
483 mh = &h->handlers[hpos];
486 if ((mh->expected_size != ntohs (em->size)) &&
487 (mh->expected_size != 0))
493 h->handlers[hpos].callback (h->cls, &ntm->peer, em))
495 /* error in processing, disconnect ! */
500 if (NULL != h->inbound_notify)
501 h->inbound_notify (h->cls, &ntm->peer, em);
503 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND:
505 sizeof (struct NotifyTrafficMessage) +
506 sizeof (struct GNUNET_MessageHeader))
511 ntm = (const struct NotifyTrafficMessage *) msg;
512 em = (const struct GNUNET_MessageHeader *) &ntm[1];
513 if ((GNUNET_NO == h->outbound_hdr_only) &&
514 (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage)))
519 if (NULL == h->outbound_notify)
524 h->outbound_notify (h->cls, &ntm->peer, em);
526 case GNUNET_MESSAGE_TYPE_CORE_CONFIGURATION_INFO:
527 if (msize != sizeof (struct ConfigurationInfoMessage))
532 if (NULL == h->submitted)
534 cim = (const struct ConfigurationInfoMessage *) msg;
536 /* process configuration data */
537 if (h->submitted->info != NULL)
538 h->submitted->info (h->submitted->info_cls,
541 ntohl (cim->bpm_out),
542 GNUNET_TIME_relative_ntoh (cim->latency),
543 (int) ntohl (cim->reserved_amount),
545 /* done, clean up! */
546 GNUNET_CORE_notify_transmit_ready_cancel (h->submitted);
547 trigger_next_request (h);
549 case GNUNET_MESSAGE_TYPE_CORE_SOLICIT_TRAFFIC:
550 if (msize != sizeof (struct SolicitTrafficMessage))
555 stm = (const struct SolicitTrafficMessage *) msg;
561 ss = ntohl (stm->solicit_size);
562 if ((ss > GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
563 (ss + sizeof (struct SendMessage) > GNUNET_SERVER_MAX_MESSAGE_SIZE))
568 solicit_traffic (h, &stm->peer, ss);
574 GNUNET_CLIENT_receive (h->client,
575 &main_handler, h, GNUNET_TIME_UNIT_FOREVER_REL);
581 * Function called when we are ready to transmit our
582 * "START" message (or when this operation timed out).
585 * @param size number of bytes available in buf
586 * @param buf where the callee should write the message
587 * @return number of bytes written to buf
589 static size_t transmit_start (void *cls, size_t size, void *buf);
593 * Function called on the first message received from
594 * the service (contains our public key, etc.).
595 * Should trigger calling the init callback
596 * and then start our regular message processing.
599 * @param msg message received, NULL on timeout or fatal error
602 init_reply_handler (void *cls, const struct GNUNET_MessageHeader *msg)
604 struct GNUNET_CORE_Handle *h = cls;
605 const struct InitReplyMessage *m;
606 GNUNET_CORE_StartupCallback init;
607 struct GNUNET_PeerIdentity my_identity;
610 (ntohs (msg->size) != sizeof (struct InitReplyMessage)) ||
611 (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY))
613 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
615 ("Error connecting to core service (failed to receive `%s' message).\n"),
617 GNUNET_break (msg == NULL);
618 transmit_start (h, 0, NULL);
621 m = (const struct InitReplyMessage *) msg;
622 /* start our message processing loop */
623 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
625 ("Successfully connected to core service, starting processing loop.\n"));
626 h->currently_down = GNUNET_NO;
627 trigger_next_request (h);
628 GNUNET_CLIENT_receive (h->client,
629 &main_handler, h, GNUNET_TIME_UNIT_FOREVER_REL);
630 if (NULL != (init = h->init))
632 /* mark so we don't call init on reconnect */
634 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
635 _("Successfully connected to core service.\n"));
636 GNUNET_CRYPTO_hash (&m->publicKey,
638 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
639 &my_identity.hashPubKey);
640 init (h->cls, h, &my_identity, &m->publicKey);
646 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
648 struct GNUNET_CORE_Handle *h = cls;
649 h->reconnect_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
655 * Function called when we are ready to transmit our
656 * "START" message (or when this operation timed out).
659 * @param size number of bytes available in buf
660 * @param buf where the callee should write the message
661 * @return number of bytes written to buf
664 transmit_start (void *cls, size_t size, void *buf)
666 struct GNUNET_CORE_Handle *h = cls;
667 struct InitMessage *init;
672 struct GNUNET_TIME_Relative delay;
677 if ((h->init == NULL) ||
678 (GNUNET_TIME_absolute_get ().value < h->startup_timeout.value))
680 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
681 _("Failed to connect to core service, retrying.\n"));
682 delay = GNUNET_TIME_absolute_get_remaining (h->startup_timeout);
683 if ((h->init == NULL) || (delay.value > 1000))
684 delay = GNUNET_TIME_UNIT_SECONDS;
687 GNUNET_TIME_relative_to_absolute (GNUNET_TIME_UNIT_MINUTES);
689 GNUNET_SCHEDULER_add_delayed (h->sched, GNUNET_NO,
690 GNUNET_SCHEDULER_PRIORITY_IDLE,
691 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
692 delay, &reconnect_task, h);
695 /* timeout on initial connect */
696 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
697 _("Failed to connect to core service, giving up.\n"));
698 h->init (h->cls, NULL, NULL, NULL);
699 GNUNET_CORE_disconnect (h);
702 msize = h->hcnt * sizeof (uint16_t) + sizeof (struct InitMessage);
703 GNUNET_assert (size >= msize);
705 init->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_INIT);
706 init->header.size = htons (msize);
707 opt = GNUNET_CORE_OPTION_NOTHING;
708 if (h->connects != NULL)
709 opt |= GNUNET_CORE_OPTION_SEND_CONNECT;
710 if (h->disconnects != NULL)
711 opt |= GNUNET_CORE_OPTION_SEND_DISCONNECT;
713 opt |= GNUNET_CORE_OPTION_SEND_BFC;
714 if (h->inbound_notify != NULL)
716 if (h->inbound_hdr_only)
717 opt |= GNUNET_CORE_OPTION_SEND_HDR_INBOUND;
719 opt |= GNUNET_CORE_OPTION_SEND_FULL_INBOUND;
721 if (h->outbound_notify != NULL)
723 if (h->outbound_hdr_only)
724 opt |= GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND;
726 opt |= GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND;
728 init->options = htonl (opt);
729 ts = (uint16_t *) & init[1];
730 for (hpos = 0; hpos < h->hcnt; hpos++)
731 ts[hpos] = htons (h->handlers[hpos].type);
732 GNUNET_CLIENT_receive (h->client,
735 GNUNET_TIME_absolute_get_remaining
736 (h->startup_timeout));
737 return sizeof (struct InitMessage) + h->hcnt * sizeof (uint16_t);
742 * Connect to the core service. Note that the connection may
743 * complete (or fail) asynchronously.
745 * @param sched scheduler to use
746 * @param cfg configuration to use
747 * @param timeout after how long should we give up trying to connect to the core service?
748 * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
749 * @param init callback to call on timeout or once we have successfully
750 * connected to the core service
751 * @param connects function to call on peer connect, can be NULL
752 * @param disconnects function to call on peer disconnect / timeout, can be NULL
753 * @param bfc function to call to fill up spare bandwidth, can be NULL
754 * @param inbound_notify function to call for all inbound messages, can be NULL
755 * @param inbound_hdr_only set to GNUNET_YES if inbound_notify will only read the
756 * GNUNET_MessageHeader and hence we do not need to give it the full message;
757 * can be used to improve efficiency, ignored if inbound_notify is NULLL
758 * @param outbound_notify function to call for all outbound messages, can be NULL
759 * @param outbound_hdr_only set to GNUNET_YES if outbound_notify will only read the
760 * GNUNET_MessageHeader and hence we do not need to give it the full message
761 * can be used to improve efficiency, ignored if outbound_notify is NULLL
762 * @param handlers callbacks for messages we care about, NULL-terminated
765 GNUNET_CORE_connect (struct GNUNET_SCHEDULER_Handle *sched,
766 struct GNUNET_CONFIGURATION_Handle *cfg,
767 struct GNUNET_TIME_Relative timeout,
769 GNUNET_CORE_StartupCallback init,
770 GNUNET_CORE_ClientEventHandler connects,
771 GNUNET_CORE_ClientEventHandler disconnects,
772 GNUNET_CORE_BufferFillCallback bfc,
773 GNUNET_CORE_MessageCallback inbound_notify,
774 int inbound_hdr_only,
775 GNUNET_CORE_MessageCallback outbound_notify,
776 int outbound_hdr_only,
777 const struct GNUNET_CORE_MessageHandler *handlers)
779 struct GNUNET_CORE_Handle *h;
781 GNUNET_assert (init != NULL);
782 h = GNUNET_malloc (sizeof (struct GNUNET_CORE_Handle));
787 h->connects = connects;
788 h->disconnects = disconnects;
790 h->inbound_notify = inbound_notify;
791 h->outbound_notify = outbound_notify;
792 h->inbound_hdr_only = inbound_hdr_only;
793 h->outbound_hdr_only = outbound_hdr_only;
794 h->handlers = handlers;
795 h->client = GNUNET_CLIENT_connect (sched, "core", cfg);
796 h->startup_timeout = GNUNET_TIME_relative_to_absolute (timeout);
798 while (handlers[h->hcnt].callback != NULL)
800 GNUNET_assert (h->hcnt <
801 (GNUNET_SERVER_MAX_MESSAGE_SIZE -
802 sizeof (struct InitMessage)) / sizeof (uint16_t));
803 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
804 "Trying to connect to core service in next %llu ms.\n",
807 GNUNET_CLIENT_notify_transmit_ready (h->client,
808 sizeof (struct InitMessage) +
809 sizeof (uint16_t) * h->hcnt, timeout,
815 * Disconnect from the core service.
817 * @param handle connection to core to disconnect
820 GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle)
822 if (handle->th != NULL)
823 GNUNET_NETWORK_notify_transmit_ready_cancel (handle->th);
824 if (handle->reconnect_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK)
825 GNUNET_SCHEDULER_cancel (handle->sched, handle->reconnect_task);
826 GNUNET_CLIENT_disconnect (handle->client);
827 GNUNET_free (handle);
832 * Build the configure message.
835 produce_configure_message (void *cls, size_t size, void *buf)
837 struct GNUNET_CORE_TransmitHandle *th = cls;
838 struct GNUNET_CORE_Handle *ch = th->ch;
842 /* communicate handle timeout/error! */
843 if (th->info != NULL)
844 th->info (th->info_cls, NULL, 0, 0, GNUNET_TIME_UNIT_ZERO, 0, 0.0);
845 if (th->timeout_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK)
846 GNUNET_CORE_notify_transmit_ready_cancel (th);
847 if (ch->submitted == th)
848 ch->submitted = NULL;
849 trigger_next_request (ch);
852 GNUNET_assert (size >= sizeof (struct RequestConfigureMessage));
853 memcpy (buf, &th[1], sizeof (struct RequestConfigureMessage));
854 if (th->prev == NULL)
855 ch->pending_head = th->next;
857 th->prev->next = th->next;
858 if (th->next == NULL)
859 ch->pending_tail = th->prev;
861 th->next->prev = th->prev;
862 GNUNET_assert (ch->submitted == NULL);
864 return sizeof (struct RequestConfigureMessage);
869 * Obtain statistics and/or change preferences for the given peer.
871 * @param handle connection to core to use
872 * @param peer identifies the peer
873 * @param timeout after how long should we give up (and call "info" with NULL
874 * for "peer" to signal an error)?
875 * @param bpm_out set to the current bandwidth limit (sending) for this peer,
876 * caller should set "bpm_out" to "-1" to avoid changing
877 * the current value; otherwise "bpm_out" will be lowered to
878 * the specified value; passing a pointer to "0" can be used to force
879 * us to disconnect from the peer; "bpm_out" might not increase
880 * as specified since the upper bound is generally
881 * determined by the other peer!
882 * @param amount reserve N bytes for receiving, negative
883 * amounts can be used to undo a (recent) reservation;
884 * @param preference increase incoming traffic share preference by this amount;
885 * in the absence of "amount" reservations, we use this
886 * preference value to assign proportional bandwidth shares
887 * to all connected peers
888 * @param info function to call with the resulting configuration information
889 * @param info_cls closure for info
892 GNUNET_CORE_peer_configure (struct GNUNET_CORE_Handle *handle,
893 const struct GNUNET_PeerIdentity *peer,
894 struct GNUNET_TIME_Relative timeout,
895 unsigned int bpm_out,
898 GNUNET_CORE_PeerConfigurationInfoCallback info,
901 struct RequestConfigureMessage *rcm;
902 struct GNUNET_CORE_TransmitHandle *th;
904 th = GNUNET_malloc (sizeof (struct GNUNET_CORE_TransmitHandle) +
905 sizeof (struct RequestConfigureMessage));
907 th->prev = handle->pending_tail;
908 if (handle->pending_tail == NULL)
909 handle->pending_head = th;
911 handle->pending_tail->next = th;
913 th->get_message = &produce_configure_message;
914 th->get_message_cls = th;
916 th->info_cls = info_cls;
917 th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
918 th->timeout_task = GNUNET_SCHEDULER_add_delayed (handle->sched,
920 GNUNET_SCHEDULER_PRIORITY_KEEP,
921 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
923 &timeout_request, th);
924 th->msize = sizeof (struct RequestConfigureMessage);
925 rcm = (struct RequestConfigureMessage *) &th[1];
926 rcm->header.size = htons (sizeof (struct RequestConfigureMessage));
927 rcm->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_REQUEST_CONFIGURE);
928 rcm->reserved = htonl (0);
929 rcm->limit_outbound_bpm = htonl (bpm_out);
930 rcm->reserve_inbound = htonl (amount);
931 rcm->preference_change = preference;
933 if (handle->pending_head == th)
934 trigger_next_request (handle);
939 * Build the message requesting data transmission.
942 produce_send (void *cls, size_t size, void *buf)
944 struct GNUNET_CORE_TransmitHandle *th = cls;
945 struct GNUNET_CORE_Handle *h;
946 struct SendMessage *sm;
948 GNUNET_NETWORK_TransmitReadyNotify notify;
954 /* timeout or error */
955 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
956 if (th->timeout_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK)
957 GNUNET_CORE_notify_transmit_ready_cancel (th);
958 trigger_next_request (h);
961 GNUNET_assert (th->timeout_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK);
962 sm = (struct SendMessage *) buf;
963 sm->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_SEND);
964 sm->priority = htonl (th->priority);
965 sm->deadline = GNUNET_TIME_absolute_hton (th->timeout);
968 notify_cls = th->notify_cls;
969 GNUNET_CORE_notify_transmit_ready_cancel (th);
970 trigger_next_request (h);
971 GNUNET_assert (size >= sizeof (struct SendMessage));
972 dt = notify (notify_cls, size - sizeof (struct SendMessage), &sm[1]);
973 sm->header.size = htons (dt + sizeof (struct SendMessage));
974 GNUNET_assert (dt + sizeof (struct SendMessage) < size);
975 return dt + sizeof (struct SendMessage);
980 * Ask the core to call "notify" once it is ready to transmit the
981 * given number of bytes to the specified "target". If we are not yet
982 * connected to the specified peer, a call to this function will cause
983 * us to try to establish a connection.
985 * @param handle connection to core service
986 * @param priority how important is the message?
987 * @param maxdelay how long can the message wait?
988 * @param target who should receive the message,
989 * use NULL for this peer (loopback)
990 * @param notify_size how many bytes of buffer space does notify want?
991 * @param notify function to call when buffer space is available
992 * @param notify_cls closure for notify
993 * @return non-NULL if the notify callback was queued,
994 * NULL if we can not even queue the request (insufficient
995 * memory); if NULL is returned, "notify" will NOT be called.
997 struct GNUNET_CORE_TransmitHandle *
998 GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle,
999 unsigned int priority,
1000 struct GNUNET_TIME_Relative maxdelay,
1001 const struct GNUNET_PeerIdentity *target,
1003 GNUNET_NETWORK_TransmitReadyNotify notify,
1006 struct GNUNET_CORE_TransmitHandle *th;
1008 GNUNET_assert (notify_size + sizeof (struct SendMessage) <
1009 GNUNET_SERVER_MAX_MESSAGE_SIZE);
1010 th = GNUNET_malloc (sizeof (struct GNUNET_CORE_TransmitHandle));
1012 /* append to list */
1013 th->prev = handle->pending_tail;
1014 if (handle->pending_tail == NULL)
1015 handle->pending_head = th;
1017 handle->pending_tail->next = th;
1018 th->get_message = &produce_send;
1019 th->get_message_cls = th;
1020 th->notify = notify;
1021 th->notify_cls = notify_cls;
1023 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1024 th->timeout_task = GNUNET_SCHEDULER_add_delayed (handle->sched,
1026 GNUNET_SCHEDULER_PRIORITY_KEEP,
1027 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
1029 &timeout_request, th);
1030 th->priority = priority;
1031 th->msize = sizeof (struct SendMessage) + notify_size;
1032 /* was the request queue previously empty? */
1033 if (handle->pending_head == th)
1034 trigger_next_request (handle);
1040 * Cancel the specified transmission-ready notification.
1042 * @param h handle that was returned by "notify_transmit_ready".
1045 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
1048 struct GNUNET_CORE_Handle *handle = h->ch;
1050 if (handle->submitted == h)
1052 handle->submitted = NULL;
1056 if (h->prev == NULL)
1057 handle->pending_head = h->next;
1059 h->prev->next = h->next;
1060 if (h->next == NULL)
1061 handle->pending_tail = h->prev;
1063 h->next->prev = h->prev;
1065 if (h->timeout_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK)
1066 GNUNET_SCHEDULER_cancel (handle->sched, h->timeout_task);
1071 /* end of core_api.c */