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 transport/transport_api.c
23 * @brief library to access the low-level P2P IO service
24 * @author Christian Grothoff
27 * - set_quota with low bandwidth should cause peer
28 * disconnects (currently never does that) (MINOR)
31 #include "gnunet_client_lib.h"
32 #include "gnunet_arm_service.h"
33 #include "gnunet_hello_lib.h"
34 #include "gnunet_protocols.h"
35 #include "gnunet_server_lib.h"
36 #include "gnunet_time_lib.h"
37 #include "gnunet_transport_service.h"
38 #include "transport.h"
41 * After how long do we give up on transmitting a HELLO
44 #define OFFER_HELLO_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
47 * After how long do we give automatically retry an unsuccessful
50 #define CONNECT_RETRY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 750)
53 * How long should ARM wait when starting up the
54 * transport service before reporting back?
56 #define START_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
59 * How long should ARM wait when stopping the
60 * transport service before reporting back?
62 #define STOP_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
65 * Entry in linked list of all of our current neighbours.
71 * This is a linked list.
73 struct NeighbourList *next;
76 * Active transmit handle, can be NULL. Used to move
77 * from ready to wait list on disconnect and to block
78 * two transmissions to the same peer from being scheduled
81 struct GNUNET_TRANSPORT_TransmitHandle *transmit_handle;
84 * Identity of this neighbour.
86 struct GNUNET_PeerIdentity id;
89 * At what time did we reset last_sent last?
91 struct GNUNET_TIME_Absolute last_quota_update;
94 * How many bytes have we sent since the "last_quota_update"
100 * Quota for outbound traffic to the neighbour in bytes/ms.
105 * Set to GNUNET_YES if we are currently allowed to
106 * transmit a message to the transport service for this
107 * peer, GNUNET_NO otherwise.
112 * Set to GNUNET_YES if we have received an ACK for the
113 * given peer. Peers that receive our HELLO always respond
114 * with an ACK to let us know that we are successfully
115 * communicating. Note that a PING can not be used for this
116 * since PINGs are only send if a HELLO address requires
117 * confirmation (and also, PINGs are not passed to the
118 * transport API itself).
126 * Linked list of requests from clients for our HELLO
127 * that were deferred.
133 * This is a linked list.
135 struct HelloWaitList *next;
138 * Reference back to our transport handle.
140 struct GNUNET_TRANSPORT_Handle *handle;
143 * Callback to call once we got our HELLO.
145 GNUNET_TRANSPORT_ReceiveCallback rec;
153 * When to time out (call rec with NULL).
155 struct GNUNET_TIME_Absolute timeout;
158 * Timeout task (used to trigger timeout,
159 * cancel if we get the HELLO in time).
161 GNUNET_SCHEDULER_TaskIdentifier task;
168 * Opaque handle for a transmission-ready request.
170 struct GNUNET_TRANSPORT_TransmitHandle
174 * We keep the transmit handles that are waiting for
175 * a transport-level connection in a doubly linked list.
177 struct GNUNET_TRANSPORT_TransmitHandle *next;
180 * We keep the transmit handles that are waiting for
181 * a transport-level connection in a doubly linked list.
183 struct GNUNET_TRANSPORT_TransmitHandle *prev;
186 * Handle of the main transport data structure.
188 struct GNUNET_TRANSPORT_Handle *handle;
191 * Neighbour for this handle, can be NULL if the service
192 * is not yet connected to the target.
194 struct NeighbourList *neighbour;
197 * Which peer is this transmission going to be for? All
198 * zeros if it is control-traffic to the service.
200 struct GNUNET_PeerIdentity target;
203 * Function to call when notify_size bytes are available
206 GNUNET_CONNECTION_TransmitReadyNotify notify;
209 * Closure for notify.
214 * transmit_ready task Id. The task is used to introduce the
215 * artificial delay that may be required to maintain the bandwidth
216 * limits. Later, this will be the ID of the "transmit_timeout"
217 * task which is used to signal a timeout if the transmission could
218 * not be done in a timely fashion.
220 GNUNET_SCHEDULER_TaskIdentifier notify_delay_task;
223 * Timeout for this request.
225 struct GNUNET_TIME_Absolute timeout;
228 * How many bytes is our notify callback waiting for?
233 * How important is this message?
235 unsigned int priority;
241 * Handle for the transport service (includes all of the
242 * state for the transport service).
244 struct GNUNET_TRANSPORT_Handle
248 * Closure for the callbacks.
253 * Function to call for received data.
255 GNUNET_TRANSPORT_ReceiveCallback rec;
258 * function to call on connect events
260 GNUNET_TRANSPORT_NotifyConnect nc_cb;
263 * function to call on disconnect events
265 GNUNET_TRANSPORT_NotifyDisconnect nd_cb;
268 * The current HELLO message for this peer. Updated
269 * whenever transports change their addresses.
271 struct GNUNET_HELLO_Message *my_hello;
274 * My client connection to the transport service.
276 struct GNUNET_CLIENT_Connection *client;
279 * Handle to our registration with the client for notification.
281 struct GNUNET_CLIENT_TransmitHandle *network_handle;
284 * Linked list of transmit handles that are waiting for the
285 * transport to connect to the respective peer. When we
286 * receive notification that the transport connected to a
287 * peer, we go over this list and check if someone has already
288 * requested a transmission to the new peer; if so, we trigger
291 struct GNUNET_TRANSPORT_TransmitHandle *connect_wait_head;
294 * Linked list of transmit handles that are waiting for the
295 * transport to be ready for transmission to the respective
297 * receive notification that the transport disconnected from
298 * a peer, we go over this list and move the entry back to
299 * the connect_wait list.
301 struct GNUNET_TRANSPORT_TransmitHandle *connect_ready_head;
304 * Linked list of pending requests for our HELLO.
306 struct HelloWaitList *hwl_head;
311 struct GNUNET_SCHEDULER_Handle *sched;
316 const struct GNUNET_CONFIGURATION_Handle *cfg;
319 * Linked list of the current neighbours of this peer.
321 struct NeighbourList *neighbours;
324 * ID of the task trying to reconnect to the
327 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
330 * Delay until we try to reconnect.
332 struct GNUNET_TIME_Relative reconnect_delay;
335 * Do we currently have a transmission pending?
336 * (schedule transmission was called but has not
339 int transmission_scheduled;
343 static struct NeighbourList *
344 find_neighbour (struct GNUNET_TRANSPORT_Handle *h,
345 const struct GNUNET_PeerIdentity *peer)
347 struct NeighbourList *pos;
350 while ((pos != NULL) &&
351 (0 != memcmp (peer, &pos->id, sizeof (struct GNUNET_PeerIdentity))))
358 * Schedule the task to send one message from the
359 * connect_ready list to the service.
361 static void schedule_transmission (struct GNUNET_TRANSPORT_Handle *h);
365 * Transmit message to client...
368 transport_notify_ready (void *cls, size_t size, void *buf)
370 struct GNUNET_TRANSPORT_Handle *h = cls;
371 struct GNUNET_TRANSPORT_TransmitHandle *th;
372 struct NeighbourList *n;
376 h->network_handle = NULL;
377 h->transmission_scheduled = GNUNET_NO;
381 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
382 "Could not transmit to transport service, cancelling pending requests\n");
384 th = h->connect_ready_head;
385 if (th->next != NULL)
386 th->next->prev = NULL;
387 h->connect_ready_head = th->next;
388 if (NULL != (n = th->neighbour))
390 GNUNET_assert (n->transmit_handle == th);
391 n->transmit_handle = NULL;
393 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
395 GNUNET_SCHEDULER_cancel (h->sched,
396 th->notify_delay_task);
397 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
399 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
401 if (h->connect_ready_head != NULL) schedule_transmission (h); /* FIXME: is this ok? */
405 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
406 "Ready to transmit %u bytes to transport service\n", size);
410 h->network_handle = NULL;
411 h->transmission_scheduled = GNUNET_NO;
414 th = h->connect_ready_head;
415 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
417 GNUNET_SCHEDULER_cancel (h->sched,
418 th->notify_delay_task);
419 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
421 GNUNET_assert (th->notify_size <= size);
422 if (th->next != NULL)
423 th->next->prev = NULL;
424 h->connect_ready_head = th->next;
425 if (NULL != (n = th->neighbour))
427 GNUNET_assert (n->transmit_handle == th);
428 n->transmit_handle = NULL;
430 ret += th->notify (th->notify_cls, size, &cbuf[ret]);
436 while ((h->connect_ready_head != NULL) &&
437 (h->connect_ready_head->notify_size <= size));
438 if (h->connect_ready_head != NULL)
439 schedule_transmission (h);
441 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
442 "Transmitting %u bytes to transport service\n", ret);
449 * Schedule the task to send one message from the
450 * connect_ready list to the service.
453 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
455 struct GNUNET_TRANSPORT_TransmitHandle *th;
457 GNUNET_assert (NULL == h->network_handle);
458 if (h->client == NULL)
460 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
461 "Could not yet schedule transmission: we are not yet connected to the transport service!\n");
462 return; /* not yet connected */
464 th = h->connect_ready_head;
466 return; /* no request pending */
467 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
469 /* remove existing time out task, will be integrated
470 with transmit_ready notification! */
471 GNUNET_SCHEDULER_cancel (h->sched,
472 th->notify_delay_task);
473 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
475 h->transmission_scheduled = GNUNET_YES;
476 h->network_handle = GNUNET_CLIENT_notify_transmit_ready (h->client,
478 GNUNET_TIME_absolute_get_remaining
481 &transport_notify_ready,
483 GNUNET_assert (NULL != h->network_handle);
488 * Insert the given transmit handle in the given sorted
489 * doubly linked list based on timeout.
491 * @param head pointer to the head of the linked list
492 * @param th element to insert into the list
495 insert_transmit_handle (struct GNUNET_TRANSPORT_TransmitHandle **head,
496 struct GNUNET_TRANSPORT_TransmitHandle *th)
498 struct GNUNET_TRANSPORT_TransmitHandle *pos;
499 struct GNUNET_TRANSPORT_TransmitHandle *prev;
503 while ((pos != NULL) && (pos->timeout.value < th->timeout.value))
511 if (th->next != NULL)
527 * Cancel a pending notify delay task (if pending) and also remove the
528 * given transmit handle from whatever list is on.
530 * @param th handle for the transmission request to manipulate
533 remove_from_any_list (struct GNUNET_TRANSPORT_TransmitHandle *th)
535 struct GNUNET_TRANSPORT_Handle *h;
538 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
540 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
541 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
543 if (th->prev == NULL)
545 if (th == h->connect_wait_head)
546 h->connect_wait_head = th->next;
548 h->connect_ready_head = th->next;
552 th->prev->next = th->next;
554 if (th->next != NULL)
555 th->next->prev = th->prev;
560 * Schedule a request to connect to the given
561 * neighbour (and if successful, add the specified
562 * handle to the wait list).
564 * @param th handle for a request to transmit once we
568 try_connect (struct GNUNET_TRANSPORT_TransmitHandle *th);
572 * Called when our transmit request timed out before any transport
573 * reported success connecting to the desired peer or before the
574 * transport was ready to receive. Signal error and free
578 peer_transmit_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
580 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
582 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
583 if (th->neighbour != NULL)
584 th->neighbour->transmit_handle = NULL;
586 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
587 "Request for transmission to peer `%s' timed out.\n",
588 GNUNET_i2s(&th->target));
590 remove_from_any_list (th);
591 th->notify (th->notify_cls, 0, NULL);
599 * Queue control request for transmission to the transport
602 * @param h handle to the transport service
603 * @param size number of bytes to be transmitted
604 * @param at_head request must be added to the head of the queue
605 * (otherwise request will be appended)
606 * @param timeout how long this transmission can wait (at most)
607 * @param notify function to call to get the content
608 * @param notify_cls closure for notify
611 schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h,
614 struct GNUNET_TIME_Relative timeout,
615 GNUNET_CONNECTION_TransmitReadyNotify notify,
618 struct GNUNET_TRANSPORT_TransmitHandle *th;
620 th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
623 th->notify_cls = notify_cls;
624 th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
625 th->notify_size = size;
626 th->notify_delay_task
627 = GNUNET_SCHEDULER_add_delayed (h->sched,
629 &peer_transmit_timeout, th);
632 th->next = h->connect_ready_head;
633 h->connect_ready_head = th;
634 if (th->next != NULL)
639 insert_transmit_handle (&h->connect_ready_head, th);
641 if (GNUNET_NO == h->transmission_scheduled)
642 schedule_transmission (h);
647 * Update the quota values for the given neighbour now.
650 update_quota (struct NeighbourList *n)
652 struct GNUNET_TIME_Relative delta;
656 delta = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
657 allowed = delta.value * n->quota_out;
658 if (n->last_sent < allowed)
660 remaining = allowed - n->last_sent;
661 if (n->quota_out > 0)
662 remaining /= n->quota_out;
665 if (remaining > MAX_BANDWIDTH_CARRY)
666 remaining = MAX_BANDWIDTH_CARRY;
668 n->last_quota_update = GNUNET_TIME_absolute_get ();
669 n->last_quota_update.value -= remaining;
673 n->last_sent -= allowed;
674 n->last_quota_update = GNUNET_TIME_absolute_get ();
679 struct SetQuotaContext
681 struct GNUNET_TRANSPORT_Handle *handle;
683 struct GNUNET_PeerIdentity target;
685 GNUNET_SCHEDULER_Task cont;
689 struct GNUNET_TIME_Absolute timeout;
696 send_set_quota (void *cls, size_t size, void *buf)
698 struct SetQuotaContext *sqc = cls;
699 struct QuotaSetMessage *msg;
703 GNUNET_SCHEDULER_add_continuation (sqc->handle->sched,
706 GNUNET_SCHEDULER_REASON_TIMEOUT);
711 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
712 "Transmitting `%s' request with respect to `%4s'.\n",
713 "SET_QUOTA", GNUNET_i2s (&sqc->target));
715 GNUNET_assert (size >= sizeof (struct QuotaSetMessage));
717 msg->header.size = htons (sizeof (struct QuotaSetMessage));
718 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
719 msg->quota_in = htonl (sqc->quota_in);
720 memcpy (&msg->peer, &sqc->target, sizeof (struct GNUNET_PeerIdentity));
721 if (sqc->cont != NULL)
722 GNUNET_SCHEDULER_add_continuation (sqc->handle->sched,
725 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
727 return sizeof (struct QuotaSetMessage);
732 * Set the share of incoming bandwidth for the given
733 * peer to the specified amount.
735 * @param handle connection to transport service
736 * @param target who's bandwidth quota is being changed
737 * @param quota_in incoming bandwidth quota in bytes per ms; 0 can
738 * be used to force all traffic to be discarded
739 * @param quota_out outgoing bandwidth quota in bytes per ms; 0 can
740 * be used to force all traffic to be discarded
741 * @param timeout how long to wait until signaling failure if
742 * we can not communicate the quota change
743 * @param cont continuation to call when done, will be called
744 * either with reason "TIMEOUT" or with reason "PREREQ_DONE"
745 * @param cont_cls closure for continuation
748 GNUNET_TRANSPORT_set_quota (struct GNUNET_TRANSPORT_Handle *handle,
749 const struct GNUNET_PeerIdentity *target,
752 struct GNUNET_TIME_Relative timeout,
753 GNUNET_SCHEDULER_Task cont, void *cont_cls)
755 struct NeighbourList *n;
756 struct SetQuotaContext *sqc;
758 n = find_neighbour (handle, target);
762 if (n->quota_out < quota_out)
763 n->last_quota_update = GNUNET_TIME_absolute_get ();
764 n->quota_out = quota_out;
766 sqc = GNUNET_malloc (sizeof (struct SetQuotaContext));
767 sqc->handle = handle;
768 sqc->target = *target;
770 sqc->cont_cls = cont_cls;
771 sqc->timeout = GNUNET_TIME_relative_to_absolute (timeout);
772 sqc->quota_in = quota_in;
773 schedule_control_transmit (handle,
774 sizeof (struct QuotaSetMessage),
775 GNUNET_NO, timeout, &send_set_quota, sqc);
780 * A "get_hello" request has timed out. Signal the client
784 hello_wait_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
786 struct HelloWaitList *hwl = cls;
787 struct HelloWaitList *pos;
788 struct HelloWaitList *prev;
790 hwl->task = GNUNET_SCHEDULER_NO_TASK;
791 if (GNUNET_TIME_absolute_get_remaining (hwl->timeout).value > 0)
794 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
795 _("First attempt to obtain `%s' from transport service failed, will try again for %llums.\n"),
797 GNUNET_TIME_absolute_get_remaining (hwl->timeout).value);
799 hwl->task = GNUNET_SCHEDULER_add_delayed (hwl->handle->sched,
800 GNUNET_TIME_absolute_get_remaining (hwl->timeout),
801 &hello_wait_timeout, hwl);
805 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
806 _("Timeout trying to obtain `%s' from transport service.\n"),
809 pos = hwl->handle->hwl_head;
812 GNUNET_assert (pos != NULL);
817 hwl->handle->hwl_head = hwl->next;
819 prev->next = hwl->next;
820 if (hwl->rec != NULL)
821 hwl->rec (hwl->rec_cls, GNUNET_TIME_UNIT_ZERO, NULL, NULL);
827 * Obtain the HELLO message for this peer.
829 * @param handle connection to transport service
830 * @param timeout how long to wait for the HELLO
831 * @param rec function to call with the HELLO, sender will be our peer
832 * identity; message and sender will be NULL on timeout
833 * (handshake with transport service pending/failed).
834 * cost estimate will be 0.
835 * @param rec_cls closure for rec
838 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
839 struct GNUNET_TIME_Relative timeout,
840 GNUNET_TRANSPORT_ReceiveCallback rec,
843 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pk;
844 struct GNUNET_PeerIdentity me;
845 struct HelloWaitList *hwl;
847 if (handle->my_hello == NULL)
849 hwl = GNUNET_malloc (sizeof (struct HelloWaitList));
850 hwl->next = handle->hwl_head;
851 handle->hwl_head = hwl;
852 hwl->handle = handle;
854 hwl->rec_cls = rec_cls;
855 hwl->timeout = GNUNET_TIME_relative_to_absolute (timeout);
856 hwl->task = GNUNET_SCHEDULER_add_delayed (handle->sched,
858 &hello_wait_timeout, hwl);
861 GNUNET_assert (GNUNET_OK == GNUNET_HELLO_get_key (handle->my_hello, &pk));
862 GNUNET_CRYPTO_hash (&pk,
863 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
867 GNUNET_TIME_UNIT_ZERO,
868 &me, (const struct GNUNET_MessageHeader *) handle->my_hello);
873 send_hello (void *cls, size_t size, void *buf)
875 struct GNUNET_MessageHeader *hello = cls;
881 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
882 "Timeout while trying to transmit `%s' request.\n",
889 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
890 "Transmitting `%s' request.\n", "HELLO");
892 msize = ntohs (hello->size);
893 GNUNET_assert (size >= msize);
894 memcpy (buf, hello, msize);
901 * Offer the transport service the HELLO of another peer. Note that
902 * the transport service may just ignore this message if the HELLO is
903 * malformed or useless due to our local configuration.
905 * @param handle connection to transport service
906 * @param hello the hello message
909 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
910 const struct GNUNET_MessageHeader *hello)
912 struct GNUNET_MessageHeader *hc;
915 if (handle->client == NULL)
918 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
919 "Not connected to transport service, dropping offered HELLO\n");
923 GNUNET_break (ntohs (hello->type) == GNUNET_MESSAGE_TYPE_HELLO);
924 size = ntohs (hello->size);
925 GNUNET_break (size >= sizeof (struct GNUNET_MessageHeader));
926 hc = GNUNET_malloc (size);
927 memcpy (hc, hello, size);
928 schedule_control_transmit (handle,
930 GNUNET_NO, OFFER_HELLO_TIMEOUT, &send_hello, hc);
935 * Function we use for handling incoming messages.
937 static void demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg);
941 send_start (void *cls, size_t size, void *buf)
943 struct GNUNET_MessageHeader *s = buf;
948 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
949 "Timeout while trying to transmit `%s' request.\n",
955 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
956 "Transmitting `%s' request.\n", "START");
958 GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
959 s->size = htons (sizeof (struct GNUNET_MessageHeader));
960 s->type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_START);
961 return sizeof (struct GNUNET_MessageHeader);
966 * We're ready to transmit the request that the transport service
967 * should connect to a new peer. In addition to sending the
968 * request, schedule the next phase for the transmission processing
969 * that caused the connect request in the first place.
972 request_connect (void *cls, size_t size, void *buf)
974 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
975 struct TryConnectMessage *tcm;
976 struct GNUNET_TRANSPORT_Handle *h;
978 GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_TASK);
983 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
984 "Failed to transmit `%s' request for `%4s' to service.\n",
986 GNUNET_i2s(&th->target));
988 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
990 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
991 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
993 th->notify (th->notify_cls, 0, NULL);
998 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
999 "Transmitting `%s' message for `%4s'.\n",
1000 "TRY_CONNECT", GNUNET_i2s (&th->target));
1002 GNUNET_assert (size >= sizeof (struct TryConnectMessage));
1004 tcm->header.size = htons (sizeof (struct TryConnectMessage));
1005 tcm->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TRY_CONNECT);
1006 tcm->reserved = htonl (0);
1007 memcpy (&tcm->peer, &th->target, sizeof (struct GNUNET_PeerIdentity));
1008 th->notify_delay_task
1009 = GNUNET_SCHEDULER_add_delayed (h->sched,
1010 GNUNET_TIME_absolute_get_remaining
1012 &peer_transmit_timeout, th);
1013 insert_transmit_handle (&h->connect_wait_head, th);
1014 return sizeof (struct TryConnectMessage);
1019 * Schedule a request to connect to the given
1020 * neighbour (and if successful, add the specified
1021 * handle to the wait list).
1023 * @param th handle for a request to transmit once we
1027 try_connect (struct GNUNET_TRANSPORT_TransmitHandle *th)
1029 GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_TASK);
1030 schedule_control_transmit (th->handle,
1031 sizeof (struct TryConnectMessage),
1033 GNUNET_TIME_absolute_get_remaining (th->timeout),
1034 &request_connect, th);
1039 * Task for delayed attempts to reconnect to a peer.
1041 * @param cls must be a transmit handle that determines the peer
1042 * to which we will try to connect
1043 * @param tc scheduler information about why we were triggered (not used)
1046 try_connect_task (void *cls,
1047 const struct GNUNET_SCHEDULER_TaskContext *tc)
1049 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
1051 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1057 * Remove neighbour from our list. Will automatically
1058 * trigger a re-connect attempt if we have messages pending
1061 * @param h our state
1062 * @param peer the peer to remove
1065 remove_neighbour (struct GNUNET_TRANSPORT_Handle *h,
1066 const struct GNUNET_PeerIdentity *peer)
1068 struct NeighbourList *prev;
1069 struct NeighbourList *pos;
1070 struct GNUNET_TRANSPORT_TransmitHandle *th;
1073 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1074 "Removing neighbour `%s' from list of connected peers.\n",
1078 pos = h->neighbours;
1079 while ((pos != NULL) &&
1082 sizeof (struct GNUNET_PeerIdentity))))
1093 h->neighbours = pos->next;
1095 prev->next = pos->next;
1096 if (NULL != (th = pos->transmit_handle))
1098 pos->transmit_handle = NULL;
1099 th->neighbour = NULL;
1100 remove_from_any_list (th);
1101 if (GNUNET_TIME_absolute_get_remaining (th->timeout).value <= CONNECT_RETRY_TIMEOUT.value)
1104 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == th->notify_delay_task);
1105 peer_transmit_timeout (th, NULL);
1109 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1110 _("Connection with `%4s' failed, will keep trying for %llu ms to deliver message\n"),
1112 GNUNET_TIME_absolute_get_remaining (th->timeout).value);
1113 /* try again in a bit */
1114 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == th->notify_delay_task);
1115 th->notify_delay_task
1116 = GNUNET_SCHEDULER_add_delayed (h->sched,
1117 CONNECT_RETRY_TIMEOUT,
1122 if (h->nc_cb != NULL)
1123 h->nd_cb (h->cls, peer);
1129 * Try again to connect to transport service.
1132 reconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1134 struct GNUNET_TRANSPORT_Handle *h = cls;
1135 struct GNUNET_TRANSPORT_TransmitHandle *pos;
1136 struct NeighbourList *n;
1138 /* Forget about all neighbours that we used to be connected
1140 while (NULL != (n = h->neighbours))
1141 remove_neighbour (h, &n->id);
1143 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to transport service.\n");
1145 GNUNET_assert (h->client == NULL);
1146 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1147 h->client = GNUNET_CLIENT_connect (h->sched, "transport", h->cfg);
1148 GNUNET_assert (h->client != NULL);
1149 /* make sure we don't send "START" twice,
1150 remove existing entry from queue (if present) */
1151 pos = h->connect_ready_head;
1154 if (pos->notify == &send_start)
1156 if (pos->prev == NULL)
1157 h->connect_ready_head = pos->next;
1159 pos->prev->next = pos->next;
1160 if (pos->next != NULL)
1161 pos->next->prev = pos->prev;
1162 GNUNET_assert (pos->neighbour == NULL);
1163 if (GNUNET_SCHEDULER_NO_TASK != pos->notify_delay_task)
1165 GNUNET_SCHEDULER_cancel (h->sched,
1166 pos->notify_delay_task);
1167 pos->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1174 schedule_control_transmit (h,
1175 sizeof (struct GNUNET_MessageHeader),
1177 GNUNET_TIME_UNIT_FOREVER_REL,
1179 GNUNET_CLIENT_receive (h->client,
1180 &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1185 * Function that will schedule the job that will try
1186 * to connect us again to the client.
1189 schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
1192 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1193 "Scheduling task to reconnect to transport service in %llu ms.\n",
1194 h->reconnect_delay.value);
1196 GNUNET_assert (h->client == NULL);
1197 GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
1199 = GNUNET_SCHEDULER_add_delayed (h->sched,
1200 h->reconnect_delay, &reconnect, h);
1201 h->reconnect_delay = GNUNET_TIME_UNIT_SECONDS;
1206 * We are connected to the respective peer, check the
1207 * bandwidth limits and schedule the transmission.
1209 static void schedule_request (struct GNUNET_TRANSPORT_TransmitHandle *th);
1213 * Function called by the scheduler when the timeout
1214 * for bandwidth availablility for the target
1215 * neighbour is reached.
1218 transmit_ready (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1220 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
1222 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1223 schedule_request (th);
1228 * Remove the given transmit handle from the wait list. Does NOT free
1232 remove_from_wait_list (struct GNUNET_TRANSPORT_TransmitHandle *th)
1234 if (th->prev == NULL)
1235 th->handle->connect_wait_head = th->next;
1237 th->prev->next = th->next;
1238 if (th->next != NULL)
1239 th->next->prev = th->prev;
1244 * We are connected to the respective peer, check the
1245 * bandwidth limits and schedule the transmission.
1248 schedule_request (struct GNUNET_TRANSPORT_TransmitHandle *th)
1250 struct GNUNET_TRANSPORT_Handle *h;
1251 struct GNUNET_TIME_Relative duration;
1252 struct NeighbourList *n;
1257 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1259 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
1260 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1262 /* check outgoing quota */
1263 duration = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
1264 if (duration.value > MIN_QUOTA_REFRESH_TIME)
1267 duration = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
1269 available = duration.value * n->quota_out;
1270 if (available < n->last_sent + th->notify_size)
1272 /* calculate how much bandwidth we'd still need to
1273 accumulate and based on that how long we'll have
1275 available = n->last_sent + th->notify_size - available;
1276 duration = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
1277 available / n->quota_out);
1278 if (th->timeout.value <
1279 GNUNET_TIME_relative_to_absolute (duration).value)
1281 /* signal timeout! */
1283 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1284 "Would need %llu ms before bandwidth is available for delivery to `%4s', that is too long. Signaling timeout.\n",
1286 GNUNET_i2s(&th->target));
1288 remove_from_wait_list (th);
1289 th->notify (th->notify_cls, 0, NULL);
1294 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1295 "Need more bandwidth, delaying delivery to `%4s' by %llu ms\n",
1296 GNUNET_i2s(&th->target),
1299 th->notify_delay_task
1300 = GNUNET_SCHEDULER_add_delayed (h->sched,
1301 duration, &transmit_ready, th);
1305 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1306 "Bandwidth available for transmission to `%4s'\n",
1307 GNUNET_i2s (&n->id));
1309 if (GNUNET_NO == n->transmit_ok)
1311 /* we may be ready, but transport service is not;
1312 wait for SendOkMessage or timeout */
1314 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1315 "Need to wait for transport service `%s' message\n",
1318 th->notify_delay_task
1319 = GNUNET_SCHEDULER_add_delayed (h->sched,
1320 GNUNET_TIME_absolute_get_remaining
1321 (th->timeout), &peer_transmit_timeout, th);
1324 n->transmit_ok = GNUNET_NO;
1325 remove_from_wait_list (th);
1327 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Moving message for `%4s' to ready list\n",
1328 GNUNET_i2s(&n->id));
1330 insert_transmit_handle (&h->connect_ready_head, th);
1331 if (GNUNET_NO == h->transmission_scheduled)
1332 schedule_transmission (h);
1337 * Add neighbour to our list
1340 add_neighbour (struct GNUNET_TRANSPORT_Handle *h,
1342 struct GNUNET_TIME_Relative latency,
1343 const struct GNUNET_PeerIdentity *pid)
1345 struct NeighbourList *n;
1346 struct GNUNET_TRANSPORT_TransmitHandle *prev;
1347 struct GNUNET_TRANSPORT_TransmitHandle *pos;
1348 struct GNUNET_TRANSPORT_TransmitHandle *next;
1350 /* check for duplicates */
1351 if (NULL != find_neighbour (h, pid))
1357 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1358 "Creating entry for new neighbour `%4s'.\n", GNUNET_i2s (pid));
1360 n = GNUNET_malloc (sizeof (struct NeighbourList));
1362 n->last_quota_update = GNUNET_TIME_absolute_get ();
1363 n->quota_out = quota_out;
1364 n->next = h->neighbours;
1365 n->transmit_ok = GNUNET_YES;
1367 if (h->nc_cb != NULL)
1368 h->nc_cb (h->cls, &n->id, latency);
1370 pos = h->connect_wait_head;
1374 if (0 == memcmp (pid,
1375 &pos->target, sizeof (struct GNUNET_PeerIdentity)))
1378 GNUNET_assert (NULL == n->transmit_handle);
1379 n->transmit_handle = pos;
1381 h->connect_wait_head = next;
1384 if (GNUNET_YES == n->received_ack)
1387 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1388 "Found pending request for `%4s' will trigger it now.\n",
1389 GNUNET_i2s (&pos->target));
1391 if (pos->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1393 GNUNET_SCHEDULER_cancel (h->sched, pos->notify_delay_task);
1394 pos->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1396 schedule_request (pos);
1401 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1402 "Found pending request for `%4s' but still need `%s' before proceeding.\n",
1403 GNUNET_i2s (&pos->target),
1416 * Connect to the transport service. Note that the connection may
1417 * complete (or fail) asynchronously.
1420 * @param sched scheduler to use
1421 * @param cfg configuration to use
1422 * @param cls closure for the callbacks
1423 * @param rec receive function to call
1424 * @param nc function to call on connect events
1425 * @param nd function to call on disconnect events
1427 struct GNUNET_TRANSPORT_Handle *
1428 GNUNET_TRANSPORT_connect (struct GNUNET_SCHEDULER_Handle *sched,
1429 const struct GNUNET_CONFIGURATION_Handle *cfg,
1431 GNUNET_TRANSPORT_ReceiveCallback rec,
1432 GNUNET_TRANSPORT_NotifyConnect nc,
1433 GNUNET_TRANSPORT_NotifyDisconnect nd)
1435 struct GNUNET_TRANSPORT_Handle *ret;
1437 GNUNET_ARM_start_services (cfg, sched, "peerinfo", "transport", NULL);
1438 ret = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_Handle));
1445 ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
1446 schedule_reconnect (ret);
1452 * Disconnect from the transport service.
1455 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
1457 struct GNUNET_TRANSPORT_TransmitHandle *th;
1458 struct NeighbourList *n;
1459 struct HelloWaitList *hwl;
1460 struct GNUNET_CLIENT_Connection *client;
1463 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1464 "Transport disconnect called!\n");
1466 while (NULL != (th = handle->connect_ready_head))
1468 handle->connect_ready_head = th->next;
1469 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1471 GNUNET_SCHEDULER_cancel (handle->sched, th->notify_delay_task);
1472 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1474 th->notify (th->notify_cls, 0, NULL);
1477 while (NULL != (th = handle->connect_wait_head))
1479 handle->connect_wait_head = th->next;
1480 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1482 GNUNET_SCHEDULER_cancel (handle->sched, th->notify_delay_task);
1483 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1485 th->notify (th->notify_cls, 0, NULL);
1488 while (NULL != (n = handle->neighbours))
1490 handle->neighbours = n->next;
1493 while (NULL != (hwl = handle->hwl_head))
1495 handle->hwl_head = hwl->next;
1496 GNUNET_SCHEDULER_cancel (handle->sched, hwl->task);
1497 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1498 _("Disconnect while trying to obtain `%s' from transport service.\n"),
1500 if (hwl->rec != NULL)
1501 hwl->rec (hwl->rec_cls, GNUNET_TIME_UNIT_ZERO, NULL, NULL);
1504 if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1506 GNUNET_SCHEDULER_cancel (handle->sched, handle->reconnect_task);
1507 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1509 GNUNET_free_non_null (handle->my_hello);
1510 handle->my_hello = NULL;
1511 GNUNET_ARM_stop_services (handle->cfg, handle->sched, "transport", "peerinfo", NULL);
1512 if (NULL != handle->network_handle)
1514 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->network_handle);
1515 handle->network_handle = NULL;
1517 if (NULL != (client = handle->client))
1520 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1521 "Disconnecting from transport service for good.\n");
1523 handle->client = NULL;
1524 GNUNET_CLIENT_disconnect (client);
1526 GNUNET_free (handle);
1531 * Type of a function to call when we receive a message
1534 * @param cls closure
1535 * @param msg message received, NULL on timeout or fatal error
1538 demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
1540 struct GNUNET_TRANSPORT_Handle *h = cls;
1541 const struct DisconnectInfoMessage *dim;
1542 const struct ConnectInfoMessage *cim;
1543 const struct InboundMessage *im;
1544 const struct GNUNET_MessageHeader *imm;
1545 const struct SendOkMessage *okm;
1546 struct HelloWaitList *hwl;
1547 struct NeighbourList *n;
1548 struct GNUNET_PeerIdentity me;
1549 struct GNUNET_TRANSPORT_TransmitHandle *th;
1552 if ((msg == NULL) || (h->client == NULL))
1554 if (h->client != NULL)
1557 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1558 "Error receiving from transport service, disconnecting temporarily.\n");
1560 if (h->network_handle != NULL)
1562 GNUNET_CLIENT_notify_transmit_ready_cancel (h->network_handle);
1563 h->network_handle = NULL;
1564 h->transmission_scheduled = GNUNET_NO;
1565 th = h->connect_ready_head;
1566 /* add timeout again, we cancelled the transmit_ready task! */
1567 GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_TASK);
1568 th->notify_delay_task
1569 = GNUNET_SCHEDULER_add_delayed (h->sched,
1570 GNUNET_TIME_absolute_get_remaining(th->timeout),
1571 &peer_transmit_timeout,
1574 GNUNET_CLIENT_disconnect (h->client);
1576 schedule_reconnect (h);
1580 /* shutdown initiated from 'GNUNET_TRANSPORT_disconnect',
1581 finish clean up work! */
1586 GNUNET_CLIENT_receive (h->client,
1587 &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1588 size = ntohs (msg->size);
1589 switch (ntohs (msg->type))
1591 case GNUNET_MESSAGE_TYPE_HELLO:
1593 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) msg,
1600 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1601 "Receiving (my own) `%s' message, I am `%4s'.\n",
1602 "HELLO", GNUNET_i2s (&me));
1604 GNUNET_free_non_null (h->my_hello);
1606 if (size < sizeof (struct GNUNET_MessageHeader))
1611 h->my_hello = GNUNET_malloc (size);
1612 memcpy (h->my_hello, msg, size);
1613 while (NULL != (hwl = h->hwl_head))
1615 h->hwl_head = hwl->next;
1616 GNUNET_SCHEDULER_cancel (h->sched, hwl->task);
1617 GNUNET_TRANSPORT_get_hello (h,
1618 GNUNET_TIME_UNIT_ZERO,
1619 hwl->rec, hwl->rec_cls);
1623 case GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT:
1624 if (size != sizeof (struct ConnectInfoMessage))
1629 cim = (const struct ConnectInfoMessage *) msg;
1631 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1632 "Receiving `%s' message for `%4s'.\n",
1633 "CONNECT", GNUNET_i2s (&cim->id));
1636 ntohl (cim->quota_out),
1637 GNUNET_TIME_relative_ntoh (cim->latency), &cim->id);
1639 case GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT:
1640 if (size != sizeof (struct DisconnectInfoMessage))
1645 dim = (const struct DisconnectInfoMessage *) msg;
1647 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1648 "Receiving `%s' message for `%4s'.\n",
1649 "DISCONNECT", GNUNET_i2s (&dim->peer));
1651 remove_neighbour (h, &dim->peer);
1653 case GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK:
1654 if (size != sizeof (struct SendOkMessage))
1659 okm = (const struct SendOkMessage *) msg;
1661 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1662 "Receiving `%s' message, transmission %s.\n", "SEND_OK",
1663 ntohl(okm->success) == GNUNET_OK ? "succeeded" : "failed");
1665 n = find_neighbour (h, &okm->peer);
1666 GNUNET_assert (n != NULL);
1667 n->transmit_ok = GNUNET_YES;
1668 if (n->transmit_handle != NULL)
1671 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1672 "Processing pending message for `%4s'\n",
1673 GNUNET_i2s(&n->id));
1675 GNUNET_SCHEDULER_cancel (h->sched,
1676 n->transmit_handle->notify_delay_task);
1677 n->transmit_handle->notify_delay_task =
1678 GNUNET_SCHEDULER_NO_TASK;
1679 GNUNET_assert (GNUNET_YES == n->received_ack);
1680 schedule_request (n->transmit_handle);
1683 case GNUNET_MESSAGE_TYPE_TRANSPORT_RECV:
1685 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1686 "Receiving `%s' message.\n", "RECV");
1689 sizeof (struct InboundMessage) +
1690 sizeof (struct GNUNET_MessageHeader))
1695 im = (const struct InboundMessage *) msg;
1696 imm = (const struct GNUNET_MessageHeader *) &im[1];
1697 if (ntohs (imm->size) + sizeof (struct InboundMessage) != size)
1702 switch (ntohs (imm->type))
1704 case GNUNET_MESSAGE_TYPE_TRANSPORT_ACK:
1706 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1707 "Receiving `%s' message from `%4s'.\n",
1708 "ACK", GNUNET_i2s (&im->peer));
1710 n = find_neighbour (h, &im->peer);
1716 if (n->received_ack == GNUNET_NO)
1718 n->received_ack = GNUNET_YES;
1719 if (NULL != n->transmit_handle)
1722 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1723 "Peer connected, scheduling delayed message for deliverery now.\n");
1725 schedule_request (n->transmit_handle);
1731 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1732 "Received message of type %u from `%4s'.\n",
1733 ntohs (imm->type), GNUNET_i2s (&im->peer));
1737 GNUNET_TIME_relative_ntoh (im->latency), &im->peer, imm);
1742 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1744 ("Received unexpected message of type %u in %s:%u\n"),
1745 ntohs (msg->type), __FILE__, __LINE__);
1752 struct ClientTransmitWrapper
1754 GNUNET_CONNECTION_TransmitReadyNotify notify;
1756 struct GNUNET_TRANSPORT_TransmitHandle *th;
1761 * Transmit message of a client destined for another
1762 * peer to the service.
1765 client_notify_wrapper (void *cls, size_t size, void *buf)
1767 struct ClientTransmitWrapper *ctw = cls;
1768 struct OutboundMessage *obm;
1769 struct GNUNET_MessageHeader *hdr;
1775 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1776 "Transmission request could not be satisfied.\n");
1778 ret = ctw->notify (ctw->notify_cls, 0, NULL);
1779 GNUNET_assert (ret == 0);
1783 GNUNET_assert (size >= sizeof (struct OutboundMessage));
1785 ret = ctw->notify (ctw->notify_cls,
1786 size - sizeof (struct OutboundMessage),
1790 /* Need to reset flag, no SEND means no SEND_OK! */
1791 ctw->th->neighbour->transmit_ok = GNUNET_YES;
1795 GNUNET_assert (ret >= sizeof (struct GNUNET_MessageHeader));
1796 hdr = (struct GNUNET_MessageHeader *) &obm[1];
1797 GNUNET_assert (ntohs (hdr->size) == ret);
1798 GNUNET_assert (ret + sizeof (struct OutboundMessage) <
1799 GNUNET_SERVER_MAX_MESSAGE_SIZE);
1801 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1802 "Transmitting `%s' message with data for `%4s'\n",
1803 "SEND", GNUNET_i2s (&ctw->th->target));
1805 ret += sizeof (struct OutboundMessage);
1806 obm->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND);
1807 obm->header.size = htons (ret);
1808 obm->priority = htonl (ctw->th->priority);
1809 obm->peer = ctw->th->target;
1817 * Check if we could queue a message of the given size for
1818 * transmission. The transport service will take both its
1819 * internal buffers and bandwidth limits imposed by the
1820 * other peer into consideration when answering this query.
1822 * @param handle connection to transport service
1823 * @param target who should receive the message
1824 * @param size how big is the message we want to transmit?
1825 * @param priority how important is the message?
1826 * @param timeout after how long should we give up (and call
1827 * notify with buf NULL and size 0)?
1828 * @param notify function to call when we are ready to
1829 * send such a message
1830 * @param notify_cls closure for notify
1831 * @return NULL if someone else is already waiting to be notified
1832 * non-NULL if the notify callback was queued (can be used to cancel
1833 * using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
1835 struct GNUNET_TRANSPORT_TransmitHandle *
1836 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle
1838 const struct GNUNET_PeerIdentity
1839 *target, size_t size,
1840 unsigned int priority,
1841 struct GNUNET_TIME_Relative timeout,
1842 GNUNET_CONNECTION_TransmitReadyNotify
1843 notify, void *notify_cls)
1845 struct GNUNET_TRANSPORT_TransmitHandle *pos;
1846 struct GNUNET_TRANSPORT_TransmitHandle *th;
1847 struct NeighbourList *n;
1848 struct ClientTransmitWrapper *ctw;
1850 if (size + sizeof (struct OutboundMessage) >=
1851 GNUNET_SERVER_MAX_MESSAGE_SIZE)
1857 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1858 "Asking transport service for transmission of %u bytes to peer `%4s'.\n",
1859 size, GNUNET_i2s (target));
1861 n = find_neighbour (handle, target);
1863 (n->transmit_handle != NULL) )
1864 return NULL; /* already have a request pending for this peer! */
1865 ctw = GNUNET_malloc (sizeof (struct ClientTransmitWrapper));
1866 th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
1867 ctw->notify = notify;
1868 ctw->notify_cls = notify_cls;
1870 th->handle = handle;
1872 th->target = *target;
1873 th->notify = &client_notify_wrapper;
1874 th->notify_cls = ctw;
1875 th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1876 th->notify_size = size + sizeof (struct OutboundMessage);
1877 th->priority = priority;
1880 pos = handle->connect_wait_head;
1883 GNUNET_assert (0 != memcmp (target,
1885 sizeof (struct GNUNET_PeerIdentity)));
1889 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1890 "Will now try to connect to `%4s'.\n", GNUNET_i2s (target));
1897 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1898 "Transmission request queued for transmission to transport service.\n");
1900 GNUNET_assert (NULL == n->transmit_handle);
1901 n->transmit_handle = th;
1902 if (GNUNET_YES != n->received_ack)
1905 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1906 "Connection to `%4s' is not yet confirmed connected, scheduling timeout (%llu ms) only.\n",
1907 GNUNET_i2s (target), timeout.value);
1909 th->notify_delay_task
1910 = GNUNET_SCHEDULER_add_delayed (handle->sched,
1911 timeout, &peer_transmit_timeout, th);
1916 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1917 "Peer `%4s' is ready to receive, scheduling message for delivery now.\n",
1918 GNUNET_i2s (target));
1920 schedule_request (th);
1926 * Cancel the specified transmission-ready notification.
1929 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
1930 GNUNET_TRANSPORT_TransmitHandle
1933 struct GNUNET_TRANSPORT_Handle *h;
1936 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1937 "Transmission request of %u bytes to `%4s' was cancelled.\n",
1938 th->notify_size - sizeof(struct OutboundMessage),
1939 GNUNET_i2s (&th->target));
1941 GNUNET_assert (th->notify == &client_notify_wrapper);
1942 remove_from_any_list (th);
1944 if ((h->connect_ready_head == NULL) && (h->network_handle != NULL))
1946 GNUNET_CLIENT_notify_transmit_ready_cancel (h->network_handle);
1947 h->network_handle = NULL;
1948 h->transmission_scheduled = GNUNET_NO;
1950 GNUNET_free (th->notify_cls);
1951 GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_TASK);
1956 /* end of transport_api.c */