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 #include "gnunet_client_lib.h"
28 #include "gnunet_arm_service.h"
29 #include "gnunet_hello_lib.h"
30 #include "gnunet_protocols.h"
31 #include "gnunet_server_lib.h"
32 #include "gnunet_time_lib.h"
33 #include "gnunet_transport_service.h"
34 #include "transport.h"
37 * After how long do we give up on transmitting a HELLO
40 #define OFFER_HELLO_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
43 * After how long do we automatically retry an unsuccessful
46 #define CONNECT_RETRY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 750)
49 * How long should ARM wait when starting up the
50 * transport service before reporting back?
52 #define START_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
55 * How long should ARM wait when stopping the
56 * transport service before reporting back?
58 #define STOP_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
61 * Entry in linked list of all of our current neighbours.
67 * This is a linked list.
69 struct NeighbourList *next;
72 * Active transmit handle, can be NULL. Used to move
73 * from ready to wait list on disconnect and to block
74 * two transmissions to the same peer from being scheduled
77 struct GNUNET_TRANSPORT_TransmitHandle *transmit_handle;
80 * Identity of this neighbour.
82 struct GNUNET_PeerIdentity id;
85 * At what time did we reset last_sent last?
87 struct GNUNET_TIME_Absolute last_quota_update;
90 * How many bytes have we sent since the "last_quota_update"
96 * Quota for outbound traffic to the neighbour in bytes/ms.
101 * Set to GNUNET_YES if we are currently allowed to
102 * transmit a message to the transport service for this
103 * peer, GNUNET_NO otherwise.
109 * Set to GNUNET_YES if we have received an ACK for the
110 * given peer. Peers that receive our HELLO always respond
111 * with an ACK to let us know that we are successfully
112 * communicating. Note that a PING can not be used for this
113 * since PINGs are only send if a HELLO address requires
114 * confirmation (and also, PINGs are not passed to the
115 * transport API itself).
123 * Linked list of requests from clients for our HELLO
124 * that were deferred.
130 * This is a linked list.
132 struct HelloWaitList *next;
135 * Reference back to our transport handle.
137 struct GNUNET_TRANSPORT_Handle *handle;
140 * Callback to call once we got our HELLO.
142 GNUNET_TRANSPORT_HelloUpdateCallback rec;
150 * When to time out (call rec with NULL).
152 struct GNUNET_TIME_Absolute timeout;
155 * Timeout task (used to trigger timeout,
156 * cancel if we get the HELLO in time).
158 GNUNET_SCHEDULER_TaskIdentifier task;
165 * Opaque handle for a transmission-ready request.
167 struct GNUNET_TRANSPORT_TransmitHandle
171 * We keep the transmit handles that are waiting for
172 * a transport-level connection in a doubly linked list.
174 struct GNUNET_TRANSPORT_TransmitHandle *next;
177 * We keep the transmit handles that are waiting for
178 * a transport-level connection in a doubly linked list.
180 struct GNUNET_TRANSPORT_TransmitHandle *prev;
183 * Handle of the main transport data structure.
185 struct GNUNET_TRANSPORT_Handle *handle;
188 * Neighbour for this handle, can be NULL if the service
189 * is not yet connected to the target.
191 struct NeighbourList *neighbour;
194 * Which peer is this transmission going to be for? All
195 * zeros if it is control-traffic to the service.
197 struct GNUNET_PeerIdentity target;
200 * Function to call when notify_size bytes are available
203 GNUNET_CONNECTION_TransmitReadyNotify notify;
206 * Closure for notify.
211 * transmit_ready task Id. The task is used to introduce the
212 * artificial delay that may be required to maintain the bandwidth
213 * limits. Later, this will be the ID of the "transmit_timeout"
214 * task which is used to signal a timeout if the transmission could
215 * not be done in a timely fashion.
217 GNUNET_SCHEDULER_TaskIdentifier notify_delay_task;
220 * Timeout for this request.
222 struct GNUNET_TIME_Absolute timeout;
225 * How many bytes is our notify callback waiting for?
230 * How important is this message?
232 unsigned int priority;
238 * Handle for the transport service (includes all of the
239 * state for the transport service).
241 struct GNUNET_TRANSPORT_Handle
245 * Closure for the callbacks.
250 * Function to call for received data.
252 GNUNET_TRANSPORT_ReceiveCallback rec;
255 * function to call on connect events
257 GNUNET_TRANSPORT_NotifyConnect nc_cb;
260 * function to call on disconnect events
262 GNUNET_TRANSPORT_NotifyDisconnect nd_cb;
265 * The current HELLO message for this peer. Updated
266 * whenever transports change their addresses.
268 struct GNUNET_HELLO_Message *my_hello;
271 * My client connection to the transport service.
273 struct GNUNET_CLIENT_Connection *client;
276 * Handle to our registration with the client for notification.
278 struct GNUNET_CLIENT_TransmitHandle *network_handle;
281 * Linked list of transmit handles that are waiting for the
282 * transport to connect to the respective peer. When we
283 * receive notification that the transport connected to a
284 * peer, we go over this list and check if someone has already
285 * requested a transmission to the new peer; if so, we trigger
288 struct GNUNET_TRANSPORT_TransmitHandle *connect_wait_head;
291 * Linked list of transmit handles that are waiting for the
292 * transport to be ready for transmission to the respective
294 * receive notification that the transport disconnected from
295 * a peer, we go over this list and move the entry back to
296 * the connect_wait list.
298 struct GNUNET_TRANSPORT_TransmitHandle *connect_ready_head;
301 * Linked list of pending requests for our HELLO.
303 struct HelloWaitList *hwl_head;
308 struct GNUNET_SCHEDULER_Handle *sched;
313 const struct GNUNET_CONFIGURATION_Handle *cfg;
316 * Linked list of the current neighbours of this peer.
318 struct NeighbourList *neighbours;
321 * ID of the task trying to reconnect to the
324 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
327 * Delay until we try to reconnect.
329 struct GNUNET_TIME_Relative reconnect_delay;
332 * Do we currently have a transmission pending?
333 * (schedule transmission was called but has not
336 int transmission_scheduled;
340 static struct NeighbourList *
341 find_neighbour (struct GNUNET_TRANSPORT_Handle *h,
342 const struct GNUNET_PeerIdentity *peer)
344 struct NeighbourList *pos;
347 while ((pos != NULL) &&
348 (0 != memcmp (peer, &pos->id, sizeof (struct GNUNET_PeerIdentity))))
355 * Schedule the task to send one message from the
356 * connect_ready list to the service.
358 static void schedule_transmission (struct GNUNET_TRANSPORT_Handle *h);
362 * Transmit message to client...
365 transport_notify_ready (void *cls, size_t size, void *buf)
367 struct GNUNET_TRANSPORT_Handle *h = cls;
368 struct GNUNET_TRANSPORT_TransmitHandle *th;
369 struct NeighbourList *n;
373 h->network_handle = NULL;
374 h->transmission_scheduled = GNUNET_NO;
378 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
379 "Could not transmit to transport service, cancelling pending requests\n");
381 th = h->connect_ready_head;
382 if (th->next != NULL)
383 th->next->prev = NULL;
384 h->connect_ready_head = th->next;
385 if (NULL != (n = th->neighbour))
387 GNUNET_assert (n->transmit_handle == th);
388 n->transmit_handle = NULL;
390 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
392 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
393 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
395 if (NULL != th->notify)
396 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
398 if (h->connect_ready_head != NULL)
399 schedule_transmission (h); /* FIXME: is this ok? */
403 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
404 "Ready to transmit %u bytes to transport service\n", size);
408 h->network_handle = NULL;
409 h->transmission_scheduled = GNUNET_NO;
410 while ((h->connect_ready_head != NULL) &&
411 (h->connect_ready_head->notify_size <= size))
413 th = h->connect_ready_head;
414 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
416 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
417 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
419 GNUNET_assert (th->notify_size <= size);
420 if (th->next != NULL)
421 th->next->prev = NULL;
422 h->connect_ready_head = th->next;
423 if (NULL != (n = th->neighbour))
425 GNUNET_assert (n->transmit_handle == th);
426 n->transmit_handle = NULL;
428 if (NULL != th->notify)
429 ret += th->notify (th->notify_cls, size, &cbuf[ret]);
435 if (h->connect_ready_head != NULL)
436 schedule_transmission (h);
438 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
439 "Transmitting %u bytes to transport service\n", ret);
446 * Schedule the task to send one message from the
447 * connect_ready list to the service.
450 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
452 struct GNUNET_TRANSPORT_TransmitHandle *th;
454 GNUNET_assert (NULL == h->network_handle);
455 if (h->client == NULL)
457 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
458 "Could not yet schedule transmission: we are not yet connected to the transport service!\n");
459 return; /* not yet connected */
461 th = h->connect_ready_head;
463 return; /* no request pending */
464 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
466 /* remove existing time out task, will be integrated
467 with transmit_ready notification! */
468 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
469 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
471 h->transmission_scheduled = GNUNET_YES;
472 h->network_handle = GNUNET_CLIENT_notify_transmit_ready (h->client,
474 GNUNET_TIME_absolute_get_remaining
477 &transport_notify_ready,
479 GNUNET_assert (NULL != h->network_handle);
484 * Insert the given transmit handle in the given sorted
485 * doubly linked list based on timeout.
487 * @param head pointer to the head of the linked list
488 * @param th element to insert into the list
491 insert_transmit_handle (struct GNUNET_TRANSPORT_TransmitHandle **head,
492 struct GNUNET_TRANSPORT_TransmitHandle *th)
494 struct GNUNET_TRANSPORT_TransmitHandle *pos;
495 struct GNUNET_TRANSPORT_TransmitHandle *prev;
499 while ((pos != NULL) && (pos->timeout.value < th->timeout.value))
507 if (th->next != NULL)
523 * Cancel a pending notify delay task (if pending) and also remove the
524 * given transmit handle from whatever list is on.
526 * @param th handle for the transmission request to manipulate
529 remove_from_any_list (struct GNUNET_TRANSPORT_TransmitHandle *th)
531 struct GNUNET_TRANSPORT_Handle *h;
534 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
536 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
537 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
539 if (th->prev == NULL)
541 if (th == h->connect_wait_head)
542 h->connect_wait_head = th->next;
544 h->connect_ready_head = th->next;
548 th->prev->next = th->next;
550 if (th->next != NULL)
551 th->next->prev = th->prev;
556 * Schedule a request to connect to the given
557 * neighbour (and if successful, add the specified
558 * handle to the wait list).
560 * @param th handle for a request to transmit once we
563 static void try_connect (struct GNUNET_TRANSPORT_TransmitHandle *th);
567 * Called when our transmit request timed out before any transport
568 * reported success connecting to the desired peer or before the
569 * transport was ready to receive. Signal error and free
573 peer_transmit_timeout (void *cls,
574 const struct GNUNET_SCHEDULER_TaskContext *tc)
576 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
578 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
579 if (th->neighbour != NULL)
580 th->neighbour->transmit_handle = NULL;
582 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
583 "Request for transmission to peer `%s' timed out.\n",
584 GNUNET_i2s (&th->target));
586 remove_from_any_list (th);
587 if (NULL != th->notify)
588 th->notify (th->notify_cls, 0, NULL);
596 * Queue control request for transmission to the transport
599 * @param h handle to the transport service
600 * @param size number of bytes to be transmitted
601 * @param at_head request must be added to the head of the queue
602 * (otherwise request will be appended)
603 * @param timeout how long this transmission can wait (at most)
604 * @param notify function to call to get the content
605 * @param notify_cls closure for notify
608 schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h,
611 struct GNUNET_TIME_Relative timeout,
612 GNUNET_CONNECTION_TransmitReadyNotify notify,
615 struct GNUNET_TRANSPORT_TransmitHandle *th;
618 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
619 "Control transmit of %u bytes within %llums requested\n",
620 size, (unsigned long long) timeout.value);
622 th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
625 th->notify_cls = notify_cls;
626 th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
627 th->notify_size = size;
628 th->notify_delay_task
629 = GNUNET_SCHEDULER_add_delayed (h->sched,
630 timeout, &peer_transmit_timeout, th);
633 th->next = h->connect_ready_head;
634 h->connect_ready_head = th;
635 if (th->next != NULL)
640 insert_transmit_handle (&h->connect_ready_head, th);
642 if (GNUNET_NO == h->transmission_scheduled)
643 schedule_transmission (h);
648 * Update the quota values for the given neighbour now.
651 update_quota (struct NeighbourList *n)
653 struct GNUNET_TIME_Relative delta;
657 delta = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
658 allowed = delta.value * n->quota_out;
659 if (n->last_sent < allowed)
661 remaining = allowed - n->last_sent;
662 if (n->quota_out > 0)
663 remaining /= n->quota_out;
666 if (remaining > MAX_BANDWIDTH_CARRY)
667 remaining = MAX_BANDWIDTH_CARRY;
669 n->last_quota_update = GNUNET_TIME_absolute_get ();
670 n->last_quota_update.value -= remaining;
674 n->last_sent -= allowed;
675 n->last_quota_update = GNUNET_TIME_absolute_get ();
680 struct SetQuotaContext
682 struct GNUNET_TRANSPORT_Handle *handle;
684 struct GNUNET_PeerIdentity target;
686 GNUNET_SCHEDULER_Task cont;
690 struct GNUNET_TIME_Absolute timeout;
697 send_set_quota (void *cls, size_t size, void *buf)
699 struct SetQuotaContext *sqc = cls;
700 struct QuotaSetMessage *msg;
704 GNUNET_SCHEDULER_add_continuation (sqc->handle->sched,
707 GNUNET_SCHEDULER_REASON_TIMEOUT);
712 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
713 "Transmitting `%s' request with respect to `%4s'.\n",
714 "SET_QUOTA", GNUNET_i2s (&sqc->target));
716 GNUNET_assert (size >= sizeof (struct QuotaSetMessage));
718 msg->header.size = htons (sizeof (struct QuotaSetMessage));
719 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
720 msg->quota_in = htonl (sqc->quota_in);
721 memcpy (&msg->peer, &sqc->target, sizeof (struct GNUNET_PeerIdentity));
722 if (sqc->cont != NULL)
723 GNUNET_SCHEDULER_add_continuation (sqc->handle->sched,
726 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
728 return sizeof (struct QuotaSetMessage);
733 * Set the share of incoming bandwidth for the given
734 * peer to the specified amount.
736 * @param handle connection to transport service
737 * @param target who's bandwidth quota is being changed
738 * @param quota_in incoming bandwidth quota in bytes per ms
739 * @param quota_out outgoing bandwidth quota in bytes per ms
740 * @param timeout how long to wait until signaling failure if
741 * we can not communicate the quota change
742 * @param cont continuation to call when done, will be called
743 * either with reason "TIMEOUT" or with reason "PREREQ_DONE"
744 * @param cont_cls closure for continuation
747 GNUNET_TRANSPORT_set_quota (struct GNUNET_TRANSPORT_Handle *handle,
748 const struct GNUNET_PeerIdentity *target,
751 struct GNUNET_TIME_Relative timeout,
752 GNUNET_SCHEDULER_Task cont, void *cont_cls)
754 struct NeighbourList *n;
755 struct SetQuotaContext *sqc;
757 n = find_neighbour (handle, target);
761 if (n->quota_out < quota_out)
762 n->last_quota_update = GNUNET_TIME_absolute_get ();
763 n->quota_out = quota_out;
765 sqc = GNUNET_malloc (sizeof (struct SetQuotaContext));
766 sqc->handle = handle;
767 sqc->target = *target;
769 sqc->cont_cls = cont_cls;
770 sqc->timeout = GNUNET_TIME_relative_to_absolute (timeout);
771 sqc->quota_in = quota_in;
772 schedule_control_transmit (handle,
773 sizeof (struct QuotaSetMessage),
774 GNUNET_NO, timeout, &send_set_quota, sqc);
779 * Obtain the HELLO message for this peer.
781 * @param handle connection to transport service
782 * @param timeout how long to wait for the HELLO
783 * @param rec function to call with the HELLO, sender will be our peer
784 * identity; message and sender will be NULL on timeout
785 * (handshake with transport service pending/failed).
786 * cost estimate will be 0.
787 * @param rec_cls closure for rec
790 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
791 GNUNET_TRANSPORT_HelloUpdateCallback rec,
794 struct HelloWaitList *hwl;
796 hwl = GNUNET_malloc (sizeof (struct HelloWaitList));
797 hwl->next = handle->hwl_head;
798 handle->hwl_head = hwl;
799 hwl->handle = handle;
801 hwl->rec_cls = rec_cls;
802 if (handle->my_hello == NULL)
804 rec (rec_cls, (const struct GNUNET_MessageHeader *) handle->my_hello);
810 * Stop receiving updates about changes to our HELLO message.
812 * @param handle connection to transport service
813 * @param rec function previously registered to be called with the HELLOs
814 * @param rec_cls closure for rec
817 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_Handle *handle,
818 GNUNET_TRANSPORT_HelloUpdateCallback rec,
821 struct HelloWaitList *pos;
822 struct HelloWaitList *prev;
825 pos = handle->hwl_head;
828 if ( (pos->rec == rec) &&
829 (pos->rec_cls == rec_cls) )
834 GNUNET_break (pos != NULL);
838 handle->hwl_head = pos->next;
840 prev->next = pos->next;
846 send_hello (void *cls, size_t size, void *buf)
848 struct GNUNET_MessageHeader *hello = cls;
854 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
855 "Timeout while trying to transmit `%s' request.\n",
862 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
863 "Transmitting `%s' request.\n", "HELLO");
865 msize = ntohs (hello->size);
866 GNUNET_assert (size >= msize);
867 memcpy (buf, hello, msize);
874 * Offer the transport service the HELLO of another peer. Note that
875 * the transport service may just ignore this message if the HELLO is
876 * malformed or useless due to our local configuration.
878 * @param handle connection to transport service
879 * @param hello the hello message
882 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
883 const struct GNUNET_MessageHeader *hello)
885 struct GNUNET_MessageHeader *hc;
888 if (handle->client == NULL)
891 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
892 "Not connected to transport service, dropping offered HELLO\n");
896 GNUNET_break (ntohs (hello->type) == GNUNET_MESSAGE_TYPE_HELLO);
897 size = ntohs (hello->size);
898 GNUNET_break (size >= sizeof (struct GNUNET_MessageHeader));
899 hc = GNUNET_malloc (size);
900 memcpy (hc, hello, size);
901 schedule_control_transmit (handle,
903 GNUNET_NO, OFFER_HELLO_TIMEOUT, &send_hello, hc);
908 * Function we use for handling incoming messages.
910 static void demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg);
914 send_start (void *cls, size_t size, void *buf)
916 struct GNUNET_MessageHeader *s = buf;
921 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
922 "Timeout while trying to transmit `%s' request.\n",
928 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
929 "Transmitting `%s' request.\n", "START");
931 GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
932 s->size = htons (sizeof (struct GNUNET_MessageHeader));
933 s->type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_START);
934 return sizeof (struct GNUNET_MessageHeader);
939 * We're ready to transmit the request that the transport service
940 * should connect to a new peer. In addition to sending the
941 * request, schedule the next phase for the transmission processing
942 * that caused the connect request in the first place.
945 request_connect (void *cls, size_t size, void *buf)
947 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
948 struct TryConnectMessage *tcm;
949 struct GNUNET_TRANSPORT_Handle *h;
951 GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_TASK);
957 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
958 "Failed to transmit `%s' request for `%4s' to service.\n",
959 "TRY_CONNECT", GNUNET_i2s (&th->target));
961 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
963 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
964 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
966 if (NULL != th->notify)
967 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
972 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
973 "Transmitting `%s' message for `%4s' (need connection in %llu ms).\n",
974 "TRY_CONNECT", GNUNET_i2s (&th->target),
975 GNUNET_TIME_absolute_get_remaining (th->timeout).value);
977 GNUNET_assert (size >= sizeof (struct TryConnectMessage));
979 tcm->header.size = htons (sizeof (struct TryConnectMessage));
980 tcm->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TRY_CONNECT);
981 tcm->reserved = htonl (0);
982 memcpy (&tcm->peer, &th->target, sizeof (struct GNUNET_PeerIdentity));
983 th->notify_delay_task
984 = GNUNET_SCHEDULER_add_delayed (h->sched,
985 GNUNET_TIME_absolute_get_remaining
987 &peer_transmit_timeout, th);
988 insert_transmit_handle (&h->connect_wait_head, th);
989 return sizeof (struct TryConnectMessage);
994 * Schedule a request to connect to the given
995 * neighbour (and if successful, add the specified
996 * handle to the wait list).
998 * @param th handle for a request to transmit once we
1002 try_connect (struct GNUNET_TRANSPORT_TransmitHandle *th)
1004 GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_TASK);
1005 schedule_control_transmit (th->handle,
1006 sizeof (struct TryConnectMessage),
1008 GNUNET_TIME_absolute_get_remaining (th->timeout),
1009 &request_connect, th);
1014 * Task for delayed attempts to reconnect to a peer.
1016 * @param cls must be a transmit handle that determines the peer
1017 * to which we will try to connect
1018 * @param tc scheduler information about why we were triggered (not used)
1021 try_connect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1023 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
1025 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1031 * Remove neighbour from our list. Will automatically
1032 * trigger a re-connect attempt if we have messages pending
1035 * @param h our state
1036 * @param peer the peer to remove
1039 remove_neighbour (struct GNUNET_TRANSPORT_Handle *h,
1040 const struct GNUNET_PeerIdentity *peer)
1042 struct NeighbourList *prev;
1043 struct NeighbourList *pos;
1044 struct GNUNET_TRANSPORT_TransmitHandle *th;
1047 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1048 "Removing neighbour `%s' from list of connected peers.\n",
1052 pos = h->neighbours;
1053 while ((pos != NULL) &&
1054 (0 != memcmp (peer, &pos->id, sizeof (struct GNUNET_PeerIdentity))))
1065 h->neighbours = pos->next;
1067 prev->next = pos->next;
1068 if (NULL != (th = pos->transmit_handle))
1070 pos->transmit_handle = NULL;
1071 th->neighbour = NULL;
1072 remove_from_any_list (th);
1073 if (GNUNET_TIME_absolute_get_remaining (th->timeout).value <=
1074 CONNECT_RETRY_TIMEOUT.value)
1077 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1079 ("Connection with `%4s' failed and timeout was in the past, giving up on message delivery.\n"),
1081 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == th->notify_delay_task);
1082 peer_transmit_timeout (th, NULL);
1086 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1088 ("Connection with `%4s' failed, will keep trying for %llu ms to deliver message\n"),
1090 GNUNET_TIME_absolute_get_remaining (th->timeout).value);
1091 /* try again in a bit */
1092 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == th->notify_delay_task);
1093 th->notify_delay_task
1094 = GNUNET_SCHEDULER_add_delayed (h->sched,
1095 CONNECT_RETRY_TIMEOUT,
1096 &try_connect_task, th);
1099 if (h->nc_cb != NULL)
1100 h->nd_cb (h->cls, peer);
1106 * Try again to connect to transport service.
1109 reconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1111 struct GNUNET_TRANSPORT_Handle *h = cls;
1112 struct GNUNET_TRANSPORT_TransmitHandle *pos;
1113 struct NeighbourList *n;
1115 /* Forget about all neighbours that we used to be connected
1117 while (NULL != (n = h->neighbours))
1118 remove_neighbour (h, &n->id);
1120 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to transport service.\n");
1122 GNUNET_assert (h->client == NULL);
1123 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1124 h->client = GNUNET_CLIENT_connect (h->sched, "transport", h->cfg);
1125 GNUNET_assert (h->client != NULL);
1126 /* make sure we don't send "START" twice,
1127 remove existing entry from queue (if present) */
1128 pos = h->connect_ready_head;
1131 if (pos->notify == &send_start)
1133 if (pos->prev == NULL)
1134 h->connect_ready_head = pos->next;
1136 pos->prev->next = pos->next;
1137 if (pos->next != NULL)
1138 pos->next->prev = pos->prev;
1139 GNUNET_assert (pos->neighbour == NULL);
1140 if (GNUNET_SCHEDULER_NO_TASK != pos->notify_delay_task)
1142 GNUNET_SCHEDULER_cancel (h->sched, pos->notify_delay_task);
1143 pos->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1150 schedule_control_transmit (h,
1151 sizeof (struct GNUNET_MessageHeader),
1153 GNUNET_TIME_UNIT_FOREVER_REL, &send_start, NULL);
1154 GNUNET_CLIENT_receive (h->client,
1155 &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1160 * Function that will schedule the job that will try
1161 * to connect us again to the client.
1164 schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
1167 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1168 "Scheduling task to reconnect to transport service in %llu ms.\n",
1169 h->reconnect_delay.value);
1171 GNUNET_assert (h->client == NULL);
1172 GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
1174 = GNUNET_SCHEDULER_add_delayed (h->sched,
1175 h->reconnect_delay, &reconnect, h);
1176 h->reconnect_delay = GNUNET_TIME_UNIT_SECONDS;
1181 * We are connected to the respective peer, check the
1182 * bandwidth limits and schedule the transmission.
1184 static void schedule_request (struct GNUNET_TRANSPORT_TransmitHandle *th);
1188 * Function called by the scheduler when the timeout
1189 * for bandwidth availablility for the target
1190 * neighbour is reached.
1193 transmit_ready (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1195 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
1197 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1198 schedule_request (th);
1203 * Remove the given transmit handle from the wait list. Does NOT free
1207 remove_from_wait_list (struct GNUNET_TRANSPORT_TransmitHandle *th)
1209 if (th->prev == NULL)
1210 th->handle->connect_wait_head = th->next;
1212 th->prev->next = th->next;
1213 if (th->next != NULL)
1214 th->next->prev = th->prev;
1219 * We are connected to the respective peer, check the
1220 * bandwidth limits and schedule the transmission.
1223 schedule_request (struct GNUNET_TRANSPORT_TransmitHandle *th)
1225 struct GNUNET_TRANSPORT_Handle *h;
1226 struct GNUNET_TIME_Relative duration;
1227 struct NeighbourList *n;
1232 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1234 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
1235 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1237 /* check outgoing quota */
1238 duration = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
1239 if (duration.value > MIN_QUOTA_REFRESH_TIME)
1242 duration = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
1244 available = duration.value * n->quota_out;
1245 if (available < n->last_sent + th->notify_size)
1247 /* calculate how much bandwidth we'd still need to
1248 accumulate and based on that how long we'll have
1250 available = n->last_sent + th->notify_size - available;
1251 duration = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
1252 available / n->quota_out);
1253 if (th->timeout.value <
1254 GNUNET_TIME_relative_to_absolute (duration).value)
1256 /* signal timeout! */
1258 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1259 "Would need %llu ms before bandwidth is available for delivery to `%4s', that is too long. Signaling timeout.\n",
1260 duration.value, GNUNET_i2s (&th->target));
1262 remove_from_wait_list (th);
1263 if (NULL != th->notify)
1264 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
1269 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1270 "Need more bandwidth, delaying delivery to `%4s' by %llu ms\n",
1271 GNUNET_i2s (&th->target), duration.value);
1273 th->notify_delay_task
1274 = GNUNET_SCHEDULER_add_delayed (h->sched,
1275 duration, &transmit_ready, th);
1279 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1280 "Bandwidth available for transmission to `%4s'\n",
1281 GNUNET_i2s (&n->id));
1283 if (GNUNET_NO == n->transmit_ok)
1285 /* we may be ready, but transport service is not;
1286 wait for SendOkMessage or timeout */
1288 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1289 "Need to wait for transport service `%s' message\n",
1292 th->notify_delay_task
1293 = GNUNET_SCHEDULER_add_delayed (h->sched,
1294 GNUNET_TIME_absolute_get_remaining
1295 (th->timeout), &peer_transmit_timeout,
1299 n->transmit_ok = GNUNET_NO;
1300 remove_from_wait_list (th);
1302 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1303 "Moving message for `%4s' to ready list\n",
1304 GNUNET_i2s (&n->id));
1306 insert_transmit_handle (&h->connect_ready_head, th);
1307 if (GNUNET_NO == h->transmission_scheduled)
1308 schedule_transmission (h);
1313 * Add neighbour to our list
1316 add_neighbour (struct GNUNET_TRANSPORT_Handle *h,
1318 struct GNUNET_TIME_Relative latency,
1320 const struct GNUNET_PeerIdentity *pid)
1322 struct NeighbourList *n;
1323 struct GNUNET_TRANSPORT_TransmitHandle *prev;
1324 struct GNUNET_TRANSPORT_TransmitHandle *pos;
1325 struct GNUNET_TRANSPORT_TransmitHandle *next;
1327 /* check for duplicates */
1328 if (NULL != find_neighbour (h, pid))
1334 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1335 "Creating entry for new neighbour `%4s'.\n", GNUNET_i2s (pid));
1337 n = GNUNET_malloc (sizeof (struct NeighbourList));
1339 n->last_quota_update = GNUNET_TIME_absolute_get ();
1340 n->quota_out = quota_out;
1341 n->next = h->neighbours;
1342 n->transmit_ok = GNUNET_YES;
1344 if (h->nc_cb != NULL)
1345 h->nc_cb (h->cls, &n->id, latency, distance);
1347 pos = h->connect_wait_head;
1351 if (0 == memcmp (pid,
1352 &pos->target, sizeof (struct GNUNET_PeerIdentity)))
1355 GNUNET_assert (NULL == n->transmit_handle);
1356 n->transmit_handle = pos;
1358 h->connect_wait_head = next;
1362 if (GNUNET_YES == n->received_ack)
1366 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1367 "Found pending request for `%4s' will trigger it now.\n",
1368 GNUNET_i2s (&pos->target));
1370 if (pos->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1372 GNUNET_SCHEDULER_cancel (h->sched, pos->notify_delay_task);
1373 pos->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1375 schedule_request (pos);
1389 * Connect to the transport service. Note that the connection may
1390 * complete (or fail) asynchronously.
1393 * @param sched scheduler to use
1394 * @param cfg configuration to use
1395 * @param cls closure for the callbacks
1396 * @param rec receive function to call
1397 * @param nc function to call on connect events
1398 * @param nd function to call on disconnect events
1400 struct GNUNET_TRANSPORT_Handle *
1401 GNUNET_TRANSPORT_connect (struct GNUNET_SCHEDULER_Handle *sched,
1402 const struct GNUNET_CONFIGURATION_Handle *cfg,
1404 GNUNET_TRANSPORT_ReceiveCallback rec,
1405 GNUNET_TRANSPORT_NotifyConnect nc,
1406 GNUNET_TRANSPORT_NotifyDisconnect nd)
1408 struct GNUNET_TRANSPORT_Handle *ret;
1410 GNUNET_ARM_start_services (cfg, sched, "peerinfo", "transport", NULL);
1411 ret = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_Handle));
1418 ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
1419 schedule_reconnect (ret);
1425 * Disconnect from the transport service.
1428 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
1430 struct GNUNET_TRANSPORT_TransmitHandle *th;
1431 struct NeighbourList *n;
1432 struct HelloWaitList *hwl;
1433 struct GNUNET_CLIENT_Connection *client;
1436 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transport disconnect called!\n");
1438 while (NULL != (th = handle->connect_ready_head))
1440 handle->connect_ready_head = th->next;
1441 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1443 GNUNET_SCHEDULER_cancel (handle->sched, th->notify_delay_task);
1444 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1446 if (NULL != th->notify)
1447 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
1450 while (NULL != (th = handle->connect_wait_head))
1452 handle->connect_wait_head = th->next;
1453 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1455 GNUNET_SCHEDULER_cancel (handle->sched, th->notify_delay_task);
1456 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1458 if (NULL != th->notify)
1459 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
1462 while (NULL != (n = handle->neighbours))
1464 handle->neighbours = n->next;
1465 if (NULL != (th = n->transmit_handle))
1467 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1469 GNUNET_SCHEDULER_cancel (handle->sched, th->notify_delay_task);
1470 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1472 if (NULL != th->notify)
1473 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
1478 while (NULL != (hwl = handle->hwl_head))
1480 handle->hwl_head = hwl->next;
1481 GNUNET_SCHEDULER_cancel (handle->sched, hwl->task);
1482 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1484 ("Disconnect while notification for `%s' still registered.\n"),
1486 if (hwl->rec != NULL)
1487 hwl->rec (hwl->rec_cls, NULL);
1490 if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1492 GNUNET_SCHEDULER_cancel (handle->sched, handle->reconnect_task);
1493 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1495 GNUNET_free_non_null (handle->my_hello);
1496 handle->my_hello = NULL;
1497 GNUNET_ARM_stop_services (handle->cfg, handle->sched, "transport",
1499 if (NULL != handle->network_handle)
1501 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->network_handle);
1502 handle->network_handle = NULL;
1504 if (NULL != (client = handle->client))
1507 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1508 "Disconnecting from transport service for good.\n");
1510 handle->client = NULL;
1511 GNUNET_CLIENT_disconnect (client);
1513 GNUNET_free (handle);
1518 * Type of a function to call when we receive a message
1521 * @param cls closure
1522 * @param msg message received, NULL on timeout or fatal error
1525 demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
1527 struct GNUNET_TRANSPORT_Handle *h = cls;
1528 const struct DisconnectInfoMessage *dim;
1529 const struct ConnectInfoMessage *cim;
1530 const struct InboundMessage *im;
1531 const struct GNUNET_MessageHeader *imm;
1532 const struct SendOkMessage *okm;
1533 struct HelloWaitList *hwl;
1534 struct HelloWaitList *next_hwl;
1535 struct NeighbourList *n;
1536 struct GNUNET_PeerIdentity me;
1537 struct GNUNET_TRANSPORT_TransmitHandle *th;
1539 struct GNUNET_TRANSPORT_TransmitHandle *prev;
1540 struct GNUNET_TRANSPORT_TransmitHandle *pos;
1541 struct GNUNET_TRANSPORT_TransmitHandle *next;
1544 if ((msg == NULL) || (h->client == NULL))
1546 if (h->client != NULL)
1549 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1550 "Error receiving from transport service, disconnecting temporarily.\n");
1552 if (h->network_handle != NULL)
1554 GNUNET_CLIENT_notify_transmit_ready_cancel (h->network_handle);
1555 h->network_handle = NULL;
1556 h->transmission_scheduled = GNUNET_NO;
1557 th = h->connect_ready_head;
1558 /* add timeout again, we canceled the transmit_ready task! */
1560 /*GNUNET_assert (th->notify_delay_task ==
1561 GNUNET_SCHEDULER_NO_TASK);*/
1563 /* START - somehow we are getting here when th->notify_delay_task is already
1564 * set. Not sure why, so just checking and canceling instead of asserting and
1565 * dying. Probably not a *fix*. */
1566 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1568 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
1569 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1572 GNUNET_assert (th->notify_delay_task ==
1573 GNUNET_SCHEDULER_NO_TASK);
1574 th->notify_delay_task =
1575 GNUNET_SCHEDULER_add_delayed (h->sched,
1576 GNUNET_TIME_absolute_get_remaining
1578 &peer_transmit_timeout, th);
1580 GNUNET_CLIENT_disconnect (h->client);
1582 schedule_reconnect (h);
1586 /* shutdown initiated from 'GNUNET_TRANSPORT_disconnect',
1587 finish clean up work! */
1592 GNUNET_CLIENT_receive (h->client,
1593 &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1594 size = ntohs (msg->size);
1595 switch (ntohs (msg->type))
1597 case GNUNET_MESSAGE_TYPE_HELLO:
1599 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) msg,
1606 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1607 "Receiving (my own) `%s' message, I am `%4s'.\n",
1608 "HELLO", GNUNET_i2s (&me));
1610 GNUNET_free_non_null (h->my_hello);
1612 if (size < sizeof (struct GNUNET_MessageHeader))
1617 h->my_hello = GNUNET_malloc (size);
1618 memcpy (h->my_hello, msg, size);
1622 next_hwl = hwl->next;
1623 hwl->rec (hwl->rec_cls,
1624 (const struct GNUNET_MessageHeader *) h->my_hello);
1628 case GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT:
1629 if (size != sizeof (struct ConnectInfoMessage))
1634 cim = (const struct ConnectInfoMessage *) msg;
1636 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1637 "Receiving `%s' message for `%4s'.\n",
1638 "CONNECT", GNUNET_i2s (&cim->id));
1640 if (NULL == (n = find_neighbour(h, &cim->id)))
1643 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1644 "Don't know neighbor, adding!\n");
1647 ntohl (cim->quota_out),
1648 GNUNET_TIME_relative_ntoh (cim->latency), ntohs(cim->distance), &cim->id);
1653 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1654 "Do know neighbor, scheduling transmission!\n");
1657 n->received_ack = GNUNET_YES;
1659 if (NULL != n->transmit_handle)
1662 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1663 "Peer connected, scheduling delayed message for delivery now.\n");
1665 schedule_request (n->transmit_handle);
1670 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1671 "Transmit handle is null... Checking for pending stuff(?)\n");
1674 pos = h->connect_wait_head;
1678 if (0 == memcmp (&cim->id,
1679 &pos->target, sizeof (struct GNUNET_PeerIdentity)))
1682 GNUNET_assert (NULL == n->transmit_handle);
1683 n->transmit_handle = pos;
1685 h->connect_wait_head = next;
1689 if (GNUNET_YES == n->received_ack)
1693 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1694 "Found pending request for `%4s' will trigger it now.\n",
1695 GNUNET_i2s (&pos->target));
1697 if (pos->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1699 GNUNET_SCHEDULER_cancel (h->sched, pos->notify_delay_task);
1700 pos->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1702 schedule_request (pos);
1716 case GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT:
1717 if (size != sizeof (struct DisconnectInfoMessage))
1722 dim = (const struct DisconnectInfoMessage *) msg;
1724 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1725 "Receiving `%s' message for `%4s'.\n",
1726 "DISCONNECT", GNUNET_i2s (&dim->peer));
1728 remove_neighbour (h, &dim->peer);
1730 case GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK:
1731 if (size != sizeof (struct SendOkMessage))
1736 okm = (const struct SendOkMessage *) msg;
1738 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1739 "Receiving `%s' message, transmission %s.\n", "SEND_OK",
1740 ntohl (okm->success) == GNUNET_OK ? "succeeded" : "failed");
1742 n = find_neighbour (h, &okm->peer);
1743 GNUNET_assert (n != NULL);
1744 n->transmit_ok = GNUNET_YES;
1745 if (n->transmit_handle != NULL)
1748 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1749 "Processing pending message for `%4s'\n",
1750 GNUNET_i2s (&n->id));
1752 GNUNET_SCHEDULER_cancel (h->sched,
1753 n->transmit_handle->notify_delay_task);
1754 n->transmit_handle->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1755 schedule_request (n->transmit_handle);
1758 case GNUNET_MESSAGE_TYPE_TRANSPORT_RECV:
1760 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1761 "Receiving `%s' message.\n", "RECV");
1764 sizeof (struct InboundMessage) +
1765 sizeof (struct GNUNET_MessageHeader))
1770 im = (const struct InboundMessage *) msg;
1771 imm = (const struct GNUNET_MessageHeader *) &im[1];
1772 if (ntohs (imm->size) + sizeof (struct InboundMessage) != size)
1777 switch (ntohs (imm->type))
1779 case GNUNET_MESSAGE_TYPE_TRANSPORT_ACK:
1781 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1782 "Receiving `%s' message from `%4s'.\n",
1783 "ACK", GNUNET_i2s (&im->peer));
1788 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1789 "Received message of type %u from `%4s'.\n",
1790 ntohs (imm->type), GNUNET_i2s (&im->peer));
1793 n = find_neighbour (h, &im->peer);
1800 if (NULL != n->transmit_handle)
1803 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1804 "Peer connected, scheduling delayed message for delivery now.\n");
1806 schedule_request (n->transmit_handle);
1809 h->rec (h->cls, &im->peer, imm,
1810 GNUNET_TIME_relative_ntoh (im->latency), ntohs(im->distance));
1815 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1817 ("Received unexpected message of type %u in %s:%u\n"),
1818 ntohs (msg->type), __FILE__, __LINE__);
1825 struct ClientTransmitWrapper
1827 GNUNET_CONNECTION_TransmitReadyNotify notify;
1829 struct GNUNET_TRANSPORT_TransmitHandle *th;
1834 * Transmit message of a client destined for another
1835 * peer to the service.
1838 client_notify_wrapper (void *cls, size_t size, void *buf)
1840 struct ClientTransmitWrapper *ctw = cls;
1841 struct OutboundMessage *obm;
1842 struct GNUNET_MessageHeader *hdr;
1848 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1849 "Transmission request could not be satisfied.\n");
1851 if (NULL != ctw->notify)
1852 GNUNET_assert (0 == ctw->notify (ctw->notify_cls, 0, NULL));
1856 GNUNET_assert (size >= sizeof (struct OutboundMessage));
1858 if (ctw->notify != NULL)
1859 ret = ctw->notify (ctw->notify_cls,
1860 size - sizeof (struct OutboundMessage),
1866 /* Need to reset flag, no SEND means no SEND_OK! */
1867 ctw->th->neighbour->transmit_ok = GNUNET_YES;
1871 GNUNET_assert (ret >= sizeof (struct GNUNET_MessageHeader));
1872 hdr = (struct GNUNET_MessageHeader *) &obm[1];
1873 GNUNET_assert (ntohs (hdr->size) == ret);
1874 GNUNET_assert (ret + sizeof (struct OutboundMessage) <
1875 GNUNET_SERVER_MAX_MESSAGE_SIZE);
1877 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1878 "Transmitting `%s' message with data for `%4s'\n",
1879 "SEND", GNUNET_i2s (&ctw->th->target));
1881 ret += sizeof (struct OutboundMessage);
1882 obm->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND);
1883 obm->header.size = htons (ret);
1884 obm->priority = htonl (ctw->th->priority);
1885 obm->peer = ctw->th->target;
1893 * Check if we could queue a message of the given size for
1894 * transmission. The transport service will take both its
1895 * internal buffers and bandwidth limits imposed by the
1896 * other peer into consideration when answering this query.
1898 * @param handle connection to transport service
1899 * @param target who should receive the message
1900 * @param size how big is the message we want to transmit?
1901 * @param priority how important is the message?
1902 * @param timeout after how long should we give up (and call
1903 * notify with buf NULL and size 0)?
1904 * @param notify function to call when we are ready to
1905 * send such a message
1906 * @param notify_cls closure for notify
1907 * @return NULL if someone else is already waiting to be notified
1908 * non-NULL if the notify callback was queued (can be used to cancel
1909 * using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
1911 struct GNUNET_TRANSPORT_TransmitHandle *
1912 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle
1914 const struct GNUNET_PeerIdentity
1915 *target, size_t size,
1916 unsigned int priority,
1917 struct GNUNET_TIME_Relative timeout,
1918 GNUNET_CONNECTION_TransmitReadyNotify
1919 notify, void *notify_cls)
1921 struct GNUNET_TRANSPORT_TransmitHandle *pos;
1922 struct GNUNET_TRANSPORT_TransmitHandle *th;
1923 struct NeighbourList *n;
1924 struct ClientTransmitWrapper *ctw;
1926 if (size + sizeof (struct OutboundMessage) >=
1927 GNUNET_SERVER_MAX_MESSAGE_SIZE)
1933 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1934 "Asking transport service for transmission of %u bytes to peer `%4s'.\n",
1935 size, GNUNET_i2s (target));
1937 n = find_neighbour (handle, target);
1938 if ((n != NULL) && (n->transmit_handle != NULL))
1939 return NULL; /* already have a request pending for this peer! */
1940 ctw = GNUNET_malloc (sizeof (struct ClientTransmitWrapper));
1941 th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
1942 ctw->notify = notify;
1943 ctw->notify_cls = notify_cls;
1945 th->handle = handle;
1947 th->target = *target;
1948 th->notify = &client_notify_wrapper;
1949 th->notify_cls = ctw;
1950 th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1951 th->notify_size = size + sizeof (struct OutboundMessage);
1952 th->priority = priority;
1955 pos = handle->connect_wait_head;
1958 GNUNET_assert (0 != memcmp (target,
1960 sizeof (struct GNUNET_PeerIdentity)));
1964 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1965 "Will now try to connect to `%4s'.\n", GNUNET_i2s (target));
1972 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1973 "Transmission request queued for transmission to transport service.\n");
1975 GNUNET_assert (NULL == n->transmit_handle);
1976 n->transmit_handle = th;
1977 if (GNUNET_YES != n->transmit_ok)
1980 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1981 "Connection to `%4s' is not yet confirmed connected, scheduling timeout (%llu ms) only.\n",
1982 GNUNET_i2s (target), timeout.value);
1984 th->notify_delay_task
1985 = GNUNET_SCHEDULER_add_delayed (handle->sched,
1986 timeout, &peer_transmit_timeout, th);
1991 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1992 "Peer `%4s' is ready to receive, scheduling message for delivery now.\n",
1993 GNUNET_i2s (target));
1995 th->notify_delay_task
1996 = GNUNET_SCHEDULER_add_now (handle->sched, &transmit_ready, th);
2002 * Cancel the specified transmission-ready notification.
2005 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
2006 GNUNET_TRANSPORT_TransmitHandle
2009 struct GNUNET_TRANSPORT_Handle *h;
2012 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2013 "Transmission request of %u bytes to `%4s' was cancelled.\n",
2014 th->notify_size - sizeof (struct OutboundMessage),
2015 GNUNET_i2s (&th->target));
2017 GNUNET_assert (th->notify == &client_notify_wrapper);
2018 remove_from_any_list (th);
2020 if ((h->connect_ready_head == NULL) && (h->network_handle != NULL))
2022 GNUNET_CLIENT_notify_transmit_ready_cancel (h->network_handle);
2023 h->network_handle = NULL;
2024 h->transmission_scheduled = GNUNET_NO;
2026 GNUNET_free (th->notify_cls);
2027 GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_TASK);
2032 /* end of transport_api.c */