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_NETWORK_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_NETWORK_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 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_WARNING,
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 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
398 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
399 "Ready to transmit %u bytes to transport service\n", size);
403 h->network_handle = NULL;
404 h->transmission_scheduled = GNUNET_NO;
407 th = h->connect_ready_head;
408 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK)
410 /* remove existing time out task (only applies if
411 this is not the first iteration of the loop) */
412 GNUNET_SCHEDULER_cancel (h->sched,
413 th->notify_delay_task);
414 th->notify_delay_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
416 GNUNET_assert (th->notify_size <= size);
417 if (th->next != NULL)
418 th->next->prev = NULL;
419 h->connect_ready_head = th->next;
420 if (NULL != (n = th->neighbour))
422 GNUNET_assert (n->transmit_handle == th);
423 n->transmit_handle = NULL;
425 ret += th->notify (th->notify_cls, size, &cbuf[ret]);
431 while ((h->connect_ready_head != NULL) &&
432 (h->connect_ready_head->notify_size <= size));
433 if (h->connect_ready_head != NULL)
434 schedule_transmission (h);
436 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
437 "Transmitting %u bytes to transport service\n", ret);
444 * Schedule the task to send one message from the
445 * connect_ready list to the service.
448 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
450 struct GNUNET_TRANSPORT_TransmitHandle *th;
452 GNUNET_assert (NULL == h->network_handle);
453 if (h->client == NULL)
455 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
456 "Could not yet schedule transmission: we are not yet connected to the transport service!\n");
457 return; /* not yet connected */
459 th = h->connect_ready_head;
461 return; /* no request pending */
462 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK)
464 /* remove existing time out task, will be integrated
465 with transmit_ready notification! */
466 GNUNET_SCHEDULER_cancel (h->sched,
467 th->notify_delay_task);
468 th->notify_delay_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
470 h->transmission_scheduled = GNUNET_YES;
471 h->network_handle = GNUNET_CLIENT_notify_transmit_ready (h->client,
473 GNUNET_TIME_absolute_get_remaining
475 &transport_notify_ready,
477 GNUNET_assert (NULL != h->network_handle);
482 * Insert the given transmit handle in the given sorted
483 * doubly linked list based on timeout.
485 * @param head pointer to the head of the linked list
486 * @param th element to insert into the list
489 insert_transmit_handle (struct GNUNET_TRANSPORT_TransmitHandle **head,
490 struct GNUNET_TRANSPORT_TransmitHandle *th)
492 struct GNUNET_TRANSPORT_TransmitHandle *pos;
493 struct GNUNET_TRANSPORT_TransmitHandle *prev;
497 while ((pos != NULL) && (pos->timeout.value < th->timeout.value))
505 if (th->next != NULL)
521 * Cancel a pending notify delay task (if pending) and also remove the
522 * given transmit handle from whatever list is on.
524 * @param th handle for the transmission request to manipulate
527 remove_from_any_list (struct GNUNET_TRANSPORT_TransmitHandle *th)
529 struct GNUNET_TRANSPORT_Handle *h;
532 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK)
534 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
535 th->notify_delay_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
537 if (th->prev == NULL)
539 if (th == h->connect_wait_head)
540 h->connect_wait_head = th->next;
542 h->connect_ready_head = th->next;
546 th->prev->next = th->next;
548 if (th->next != NULL)
549 th->next->prev = th->prev;
554 * Schedule a request to connect to the given
555 * neighbour (and if successful, add the specified
556 * handle to the wait list).
558 * @param th handle for a request to transmit once we
562 try_connect (struct GNUNET_TRANSPORT_TransmitHandle *th);
566 * Called when our transmit request timed out before any transport
567 * reported success connecting to the desired peer or before the
568 * transport was ready to receive. Signal error and free
572 transmit_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
574 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
576 th->notify_delay_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
577 if (th->neighbour != NULL)
578 th->neighbour->transmit_handle = NULL;
580 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
581 "Request for transmission to peer `%s' timed out.\n",
582 GNUNET_i2s(&th->target));
584 remove_from_any_list (th);
585 th->notify (th->notify_cls, 0, NULL);
593 * Queue control request for transmission to the transport
596 * @param size number of bytes to be transmitted
597 * @param at_head request must be added to the head of the queue
598 * (otherwise request will be appended)
599 * @param timeout how long this transmission can wait (at most)
600 * @param notify function to call to get the content
601 * @param notify_cls closure for notify
604 schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h,
607 struct GNUNET_TIME_Relative timeout,
608 GNUNET_NETWORK_TransmitReadyNotify notify,
611 struct GNUNET_TRANSPORT_TransmitHandle *th;
613 th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
616 th->notify_cls = notify_cls;
617 th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
618 th->notify_size = size;
619 th->notify_delay_task
620 = GNUNET_SCHEDULER_add_delayed (h->sched,
622 GNUNET_SCHEDULER_PRIORITY_KEEP,
623 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
625 &transmit_timeout, th);
628 th->next = h->connect_ready_head;
629 h->connect_ready_head = th;
630 if (th->next != NULL)
635 insert_transmit_handle (&h->connect_ready_head, th);
637 if (GNUNET_NO == h->transmission_scheduled)
638 schedule_transmission (h);
643 * Update the quota values for the given neighbour now.
646 update_quota (struct NeighbourList *n)
648 struct GNUNET_TIME_Relative delta;
652 delta = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
653 allowed = delta.value * n->quota_out;
654 if (n->last_sent < allowed)
656 remaining = allowed - n->last_sent;
657 if (n->quota_out > 0)
658 remaining /= n->quota_out;
661 if (remaining > MAX_BANDWIDTH_CARRY)
662 remaining = MAX_BANDWIDTH_CARRY;
664 n->last_quota_update = GNUNET_TIME_absolute_get ();
665 n->last_quota_update.value -= remaining;
669 n->last_sent -= allowed;
670 n->last_quota_update = GNUNET_TIME_absolute_get ();
675 struct SetQuotaContext
677 struct GNUNET_TRANSPORT_Handle *handle;
679 struct GNUNET_PeerIdentity target;
681 GNUNET_SCHEDULER_Task cont;
685 struct GNUNET_TIME_Absolute timeout;
692 send_set_quota (void *cls, size_t size, void *buf)
694 struct SetQuotaContext *sqc = cls;
695 struct QuotaSetMessage *msg;
699 GNUNET_SCHEDULER_add_continuation (sqc->handle->sched,
703 GNUNET_SCHEDULER_REASON_TIMEOUT);
708 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
709 "Transmitting `%s' request with respect to `%4s'.\n",
710 "SET_QUOTA", GNUNET_i2s (&sqc->target));
712 GNUNET_assert (size >= sizeof (struct QuotaSetMessage));
714 msg->header.size = htons (sizeof (struct QuotaSetMessage));
715 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
716 msg->quota_in = htonl (sqc->quota_in);
717 memcpy (&msg->peer, &sqc->target, sizeof (struct GNUNET_PeerIdentity));
718 if (sqc->cont != NULL)
719 GNUNET_SCHEDULER_add_continuation (sqc->handle->sched,
723 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
725 return sizeof (struct QuotaSetMessage);
730 * Set the share of incoming bandwidth for the given
731 * peer to the specified amount.
733 * @param handle connection to transport service
734 * @param target who's bandwidth quota is being changed
735 * @param quota_in incoming bandwidth quota in bytes per ms; 0 can
736 * be used to force all traffic to be discarded
737 * @param quota_out outgoing bandwidth quota in bytes per ms; 0 can
738 * be used to force all traffic to be discarded
739 * @param timeout how long to wait until signaling failure if
740 * we can not communicate the quota change
741 * @param cont continuation to call when done, will be called
742 * either with reason "TIMEOUT" or with reason "PREREQ_DONE"
743 * @param cont_cls closure for continuation
746 GNUNET_TRANSPORT_set_quota (struct GNUNET_TRANSPORT_Handle *handle,
747 const struct GNUNET_PeerIdentity *target,
750 struct GNUNET_TIME_Relative timeout,
751 GNUNET_SCHEDULER_Task cont, void *cont_cls)
753 struct NeighbourList *n;
754 struct SetQuotaContext *sqc;
756 n = find_neighbour (handle, target);
760 if (n->quota_out < quota_out)
761 n->last_quota_update = GNUNET_TIME_absolute_get ();
762 n->quota_out = quota_out;
764 sqc = GNUNET_malloc (sizeof (struct SetQuotaContext));
765 sqc->handle = handle;
766 sqc->target = *target;
768 sqc->cont_cls = cont_cls;
769 sqc->timeout = GNUNET_TIME_relative_to_absolute (timeout);
770 sqc->quota_in = quota_in;
771 schedule_control_transmit (handle,
772 sizeof (struct QuotaSetMessage),
773 GNUNET_NO, timeout, &send_set_quota, sqc);
778 * A "get_hello" request has timed out. Signal the client
782 hello_wait_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
784 struct HelloWaitList *hwl = cls;
785 struct HelloWaitList *pos;
786 struct HelloWaitList *prev;
789 pos = hwl->handle->hwl_head;
792 GNUNET_assert (pos != NULL);
797 hwl->handle->hwl_head = hwl->next;
799 prev->next = hwl->next;
800 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
801 _("Timeout trying to obtain `%s' from transport service.\n"),
804 if (hwl->rec != NULL)
805 hwl->rec (hwl->rec_cls, GNUNET_TIME_UNIT_ZERO, NULL, NULL);
811 * Obtain the HELLO message for this peer.
813 * @param handle connection to transport service
814 * @param timeout how long to wait for the HELLO
815 * @param rec function to call with the HELLO, sender will be our peer
816 * identity; message and sender will be NULL on timeout
817 * (handshake with transport service pending/failed).
818 * cost estimate will be 0.
819 * @param rec_cls closure for rec
822 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
823 struct GNUNET_TIME_Relative timeout,
824 GNUNET_TRANSPORT_ReceiveCallback rec,
827 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pk;
828 struct GNUNET_PeerIdentity me;
829 struct HelloWaitList *hwl;
831 if (handle->my_hello == NULL)
833 hwl = GNUNET_malloc (sizeof (struct HelloWaitList));
834 hwl->next = handle->hwl_head;
835 handle->hwl_head = hwl;
836 hwl->handle = handle;
838 hwl->rec_cls = rec_cls;
839 hwl->timeout = GNUNET_TIME_relative_to_absolute (timeout);
840 hwl->task = GNUNET_SCHEDULER_add_delayed (handle->sched,
842 GNUNET_SCHEDULER_PRIORITY_KEEP,
843 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
845 &hello_wait_timeout, hwl);
848 GNUNET_assert (GNUNET_OK == GNUNET_HELLO_get_key (handle->my_hello, &pk));
849 GNUNET_CRYPTO_hash (&pk,
850 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
854 GNUNET_TIME_UNIT_ZERO,
855 &me, (const struct GNUNET_MessageHeader *) handle->my_hello);
860 send_hello (void *cls, size_t size, void *buf)
862 struct GNUNET_MessageHeader *hello = cls;
868 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
869 "Timeout while trying to transmit `%s' request.\n",
876 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
877 "Transmitting `%s' request.\n", "HELLO");
879 msize = ntohs (hello->size);
880 GNUNET_assert (size >= msize);
881 memcpy (buf, hello, msize);
888 * Offer the transport service the HELLO of another peer. Note that
889 * the transport service may just ignore this message if the HELLO is
890 * malformed or useless due to our local configuration.
892 * @param handle connection to transport service
893 * @param hello the hello message
896 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
897 const struct GNUNET_MessageHeader *hello)
899 struct GNUNET_MessageHeader *hc;
902 if (handle->client == NULL)
905 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
906 "Not connected to transport service, dropping offered HELLO\n");
910 GNUNET_break (ntohs (hello->type) == GNUNET_MESSAGE_TYPE_HELLO);
911 size = ntohs (hello->size);
912 GNUNET_break (size >= sizeof (struct GNUNET_MessageHeader));
913 hc = GNUNET_malloc (size);
914 memcpy (hc, hello, size);
915 schedule_control_transmit (handle,
917 GNUNET_NO, OFFER_HELLO_TIMEOUT, &send_hello, hc);
922 * Function we use for handling incoming messages.
924 static void demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg);
928 send_start (void *cls, size_t size, void *buf)
930 struct GNUNET_MessageHeader *s = buf;
935 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
936 "Timeout while trying to transmit `%s' request.\n",
942 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
943 "Transmitting `%s' request.\n", "START");
945 GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
946 s->size = htons (sizeof (struct GNUNET_MessageHeader));
947 s->type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_START);
948 return sizeof (struct GNUNET_MessageHeader);
953 * We're ready to transmit the request that the transport service
954 * should connect to a new peer. In addition to sending the
955 * request, schedule the next phase for the transmission processing
956 * that caused the connect request in the first place.
959 request_connect (void *cls, size_t size, void *buf)
961 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
962 struct TryConnectMessage *tcm;
963 struct GNUNET_TRANSPORT_Handle *h;
965 GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_PREREQUISITE_TASK);
970 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
971 "Failed to transmit `%s' request for `%4s' to service.\n",
973 GNUNET_i2s(&th->target));
975 th->notify (th->notify_cls, 0, NULL);
980 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
981 "Transmitting `%s' message for `%4s'.\n",
982 "TRY_CONNECT", GNUNET_i2s (&th->target));
984 GNUNET_assert (size >= sizeof (struct TryConnectMessage));
986 tcm->header.size = htons (sizeof (struct TryConnectMessage));
987 tcm->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TRY_CONNECT);
988 tcm->reserved = htonl (0);
989 memcpy (&tcm->peer, &th->target, sizeof (struct GNUNET_PeerIdentity));
990 th->notify_delay_task
991 = GNUNET_SCHEDULER_add_delayed (h->sched,
993 GNUNET_SCHEDULER_PRIORITY_KEEP,
994 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
995 GNUNET_TIME_absolute_get_remaining
997 &transmit_timeout, th);
998 insert_transmit_handle (&h->connect_wait_head, th);
999 return sizeof (struct TryConnectMessage);
1004 * Schedule a request to connect to the given
1005 * neighbour (and if successful, add the specified
1006 * handle to the wait list).
1008 * @param th handle for a request to transmit once we
1012 try_connect (struct GNUNET_TRANSPORT_TransmitHandle *th)
1014 GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_PREREQUISITE_TASK);
1015 schedule_control_transmit (th->handle,
1016 sizeof (struct TryConnectMessage),
1018 GNUNET_TIME_absolute_get_remaining (th->timeout),
1019 &request_connect, th);
1024 * Task for delayed attempts to reconnect to a peer.
1026 * @param cls must be a transmit handle that determines the peer
1027 * to which we will try to connect
1028 * @param tc scheduler information about why we were triggered (not used)
1031 try_connect_task (void *cls,
1032 const struct GNUNET_SCHEDULER_TaskContext *tc)
1034 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
1036 th->notify_delay_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
1042 * Remove neighbour from our list. Will automatically
1043 * trigger a re-connect attempt if we have messages pending
1046 * @param h our state
1047 * @param peer the peer to remove
1050 remove_neighbour (struct GNUNET_TRANSPORT_Handle *h,
1051 const struct GNUNET_PeerIdentity *peer)
1053 struct NeighbourList *prev;
1054 struct NeighbourList *pos;
1055 struct GNUNET_TRANSPORT_TransmitHandle *th;
1058 pos = h->neighbours;
1059 while ((pos != NULL) &&
1062 sizeof (struct GNUNET_PeerIdentity))))
1073 h->neighbours = pos->next;
1075 prev->next = pos->next;
1076 if (NULL != (th = pos->transmit_handle))
1078 pos->transmit_handle = NULL;
1079 th->neighbour = NULL;
1080 remove_from_any_list (th);
1081 if (GNUNET_TIME_absolute_get_remaining (th->timeout).value <= CONNECT_RETRY_TIMEOUT.value)
1084 GNUNET_assert (GNUNET_SCHEDULER_NO_PREREQUISITE_TASK == th->notify_delay_task);
1085 transmit_timeout (th, NULL);
1089 /* try again in a bit */
1090 GNUNET_assert (GNUNET_SCHEDULER_NO_PREREQUISITE_TASK == th->notify_delay_task);
1091 th->notify_delay_task
1092 = GNUNET_SCHEDULER_add_delayed (h->sched,
1094 GNUNET_SCHEDULER_PRIORITY_KEEP,
1095 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
1096 CONNECT_RETRY_TIMEOUT,
1101 if (h->nc_cb != NULL)
1102 h->nd_cb (h->cls, peer);
1108 * Try again to connect to transport service.
1111 reconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1113 struct GNUNET_TRANSPORT_Handle *h = cls;
1114 struct GNUNET_TRANSPORT_TransmitHandle *pos;
1115 struct NeighbourList *n;
1117 /* Forget about all neighbours that we used to be connected
1119 while (NULL != (n = h->neighbours))
1120 remove_neighbour (h, &n->id);
1122 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to transport service.\n");
1124 GNUNET_assert (h->client == NULL);
1125 h->reconnect_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
1126 h->client = GNUNET_CLIENT_connect (h->sched, "transport", h->cfg);
1127 GNUNET_assert (h->client != NULL);
1128 /* make sure we don't send "START" twice,
1129 remove existing entry from queue (if present) */
1130 pos = h->connect_ready_head;
1133 if (pos->notify == &send_start)
1135 if (pos->prev == NULL)
1136 h->connect_ready_head = pos->next;
1138 pos->prev->next = pos->next;
1139 if (pos->next != NULL)
1140 pos->next->prev = pos->prev;
1141 GNUNET_assert (pos->neighbour == NULL);
1147 schedule_control_transmit (h,
1148 sizeof (struct GNUNET_MessageHeader),
1150 GNUNET_TIME_UNIT_FOREVER_REL, &send_start, NULL);
1151 GNUNET_CLIENT_receive (h->client,
1152 &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1157 * Function that will schedule the job that will try
1158 * to connect us again to the client.
1161 schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
1164 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1165 "Scheduling task to reconnect to transport service in %llu ms.\n",
1166 h->reconnect_delay.value);
1168 GNUNET_assert (h->client == NULL);
1169 GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_PREREQUISITE_TASK);
1171 = GNUNET_SCHEDULER_add_delayed (h->sched,
1173 GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1174 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
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_PREREQUISITE_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_PREREQUISITE_TASK)
1234 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
1235 th->notify_delay_task = GNUNET_SCHEDULER_NO_PREREQUISITE_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",
1261 GNUNET_i2s(&th->target));
1263 remove_from_wait_list (th);
1264 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),
1274 th->notify_delay_task
1275 = GNUNET_SCHEDULER_add_delayed (h->sched,
1277 GNUNET_SCHEDULER_PRIORITY_KEEP,
1278 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
1279 duration, &transmit_ready, th);
1283 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1284 "Bandwidth available for transmission to `%4s'\n",
1285 GNUNET_i2s (&n->id));
1287 if (GNUNET_NO == n->transmit_ok)
1289 /* we may be ready, but transport service is not;
1290 wait for SendOkMessage or timeout */
1292 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1293 "Need to wait for transport service `%s' message\n",
1296 th->notify_delay_task
1297 = GNUNET_SCHEDULER_add_delayed (h->sched,
1299 GNUNET_SCHEDULER_PRIORITY_KEEP,
1300 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
1301 GNUNET_TIME_absolute_get_remaining
1302 (th->timeout), &transmit_timeout, th);
1305 n->transmit_ok = GNUNET_NO;
1306 remove_from_wait_list (th);
1308 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Moving message for `%4s' to ready list\n",
1309 GNUNET_i2s(&n->id));
1311 insert_transmit_handle (&h->connect_ready_head, th);
1312 if (GNUNET_NO == h->transmission_scheduled)
1313 schedule_transmission (h);
1318 * Add neighbour to our list
1321 add_neighbour (struct GNUNET_TRANSPORT_Handle *h,
1323 struct GNUNET_TIME_Relative latency,
1324 const struct GNUNET_PeerIdentity *pid)
1326 struct NeighbourList *n;
1327 struct GNUNET_TRANSPORT_TransmitHandle *prev;
1328 struct GNUNET_TRANSPORT_TransmitHandle *pos;
1329 struct GNUNET_TRANSPORT_TransmitHandle *next;
1331 /* check for duplicates */
1332 if (NULL != find_neighbour (h, pid))
1338 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1339 "Creating entry for new neighbour `%4s'.\n", GNUNET_i2s (pid));
1341 n = GNUNET_malloc (sizeof (struct NeighbourList));
1343 n->last_quota_update = GNUNET_TIME_absolute_get ();
1344 n->quota_out = quota_out;
1345 n->next = h->neighbours;
1346 n->transmit_ok = GNUNET_YES;
1348 if (h->nc_cb != NULL)
1349 h->nc_cb (h->cls, &n->id, latency);
1351 pos = h->connect_wait_head;
1355 if (0 == memcmp (pid,
1356 &pos->target, sizeof (struct GNUNET_PeerIdentity)))
1359 GNUNET_assert (NULL == n->transmit_handle);
1360 n->transmit_handle = pos;
1362 h->connect_wait_head = next;
1365 if (GNUNET_YES == n->received_ack)
1368 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1369 "Found pending request for `%4s' will trigger it now.\n",
1370 GNUNET_i2s (&pos->target));
1372 if (pos->notify_delay_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK)
1374 GNUNET_SCHEDULER_cancel (h->sched, pos->notify_delay_task);
1375 pos->notify_delay_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
1377 schedule_request (pos);
1382 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1383 "Found pending request for `%4s' but still need `%s' before proceeding.\n",
1384 GNUNET_i2s (&pos->target),
1397 * Connect to the transport service. Note that the connection may
1398 * complete (or fail) asynchronously.
1401 * @param sched scheduler to use
1402 * @param cfg configuration to use
1403 * @param cls closure for the callbacks
1404 * @param rec receive function to call
1405 * @param nc function to call on connect events
1406 * @param dc function to call on disconnect events
1408 struct GNUNET_TRANSPORT_Handle *
1409 GNUNET_TRANSPORT_connect (struct GNUNET_SCHEDULER_Handle *sched,
1410 struct GNUNET_CONFIGURATION_Handle *cfg,
1412 GNUNET_TRANSPORT_ReceiveCallback rec,
1413 GNUNET_TRANSPORT_NotifyConnect nc,
1414 GNUNET_TRANSPORT_NotifyDisconnect nd)
1416 struct GNUNET_TRANSPORT_Handle *ret;
1418 GNUNET_ARM_start_service ("peerinfo",
1419 cfg, sched, START_SERVICE_TIMEOUT, NULL, NULL);
1420 GNUNET_ARM_start_service ("transport",
1421 cfg, sched, START_SERVICE_TIMEOUT, NULL, NULL);
1422 ret = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_Handle));
1429 ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
1430 schedule_reconnect (ret);
1436 * These stop activities must be run in a fresh
1437 * scheduler that is NOT in shutdown mode.
1440 stop_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1442 struct GNUNET_TRANSPORT_Handle *handle = cls;
1443 GNUNET_ARM_stop_service ("transport",
1445 tc->sched, STOP_SERVICE_TIMEOUT, NULL, NULL);
1446 GNUNET_ARM_stop_service ("peerinfo",
1448 tc->sched, STOP_SERVICE_TIMEOUT, NULL, NULL);
1453 * Disconnect from the transport service.
1456 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
1458 struct GNUNET_TRANSPORT_TransmitHandle *th;
1459 struct NeighbourList *n;
1460 struct HelloWaitList *hwl;
1461 struct GNUNET_CLIENT_Connection *client;
1464 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transport disconnect called!\n");
1466 while (NULL != (th = handle->connect_ready_head))
1468 handle->connect_ready_head = th->next;
1469 th->notify (th->notify_cls, 0, NULL);
1472 while (NULL != (th = handle->connect_wait_head))
1474 handle->connect_wait_head = th->next;
1475 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK)
1477 GNUNET_SCHEDULER_cancel (handle->sched, th->notify_delay_task);
1478 th->notify_delay_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
1480 th->notify (th->notify_cls, 0, NULL);
1483 while (NULL != (n = handle->neighbours))
1485 handle->neighbours = n->next;
1488 while (NULL != (hwl = handle->hwl_head))
1490 handle->hwl_head = hwl->next;
1491 GNUNET_SCHEDULER_cancel (handle->sched, hwl->task);
1492 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1493 _("Disconnect while trying to obtain `%s' from transport service.\n"),
1495 if (hwl->rec != NULL)
1496 hwl->rec (hwl->rec_cls, GNUNET_TIME_UNIT_ZERO, NULL, NULL);
1499 if (handle->reconnect_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK)
1501 GNUNET_SCHEDULER_cancel (handle->sched, handle->reconnect_task);
1502 handle->reconnect_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
1504 GNUNET_free_non_null (handle->my_hello);
1505 handle->my_hello = NULL;
1506 GNUNET_SCHEDULER_run (&stop_task, handle);
1507 if (NULL != (client = handle->client))
1510 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1511 "Disconnecting from transport service for good.\n");
1513 handle->client = NULL;
1514 GNUNET_CLIENT_disconnect (client);
1517 GNUNET_free (handle);
1522 * Type of a function to call when we receive a message
1525 * @param cls closure
1526 * @param msg message received, NULL on timeout or fatal error
1529 demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
1531 struct GNUNET_TRANSPORT_Handle *h = cls;
1532 const struct DisconnectInfoMessage *dim;
1533 const struct ConnectInfoMessage *cim;
1534 const struct InboundMessage *im;
1535 const struct GNUNET_MessageHeader *imm;
1536 const struct SendOkMessage *okm;
1537 struct HelloWaitList *hwl;
1538 struct NeighbourList *n;
1539 struct GNUNET_PeerIdentity me;
1540 struct GNUNET_TRANSPORT_TransmitHandle *th;
1543 if ((msg == NULL) || (h->client == NULL))
1545 if (h->client != NULL)
1548 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1549 "Error receiving from transport service, disconnecting temporarily.\n");
1551 if (h->network_handle != NULL)
1553 GNUNET_NETWORK_notify_transmit_ready_cancel (h->network_handle);
1554 h->network_handle = NULL;
1555 h->transmission_scheduled = GNUNET_NO;
1556 th = h->connect_ready_head;
1557 /* add timeout again, we cancelled the transmit_ready task! */
1558 GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_PREREQUISITE_TASK);
1559 th->notify_delay_task
1560 = GNUNET_SCHEDULER_add_delayed (h->sched,
1562 GNUNET_SCHEDULER_PRIORITY_KEEP,
1563 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
1564 GNUNET_TIME_absolute_get_remaining(th->timeout),
1568 GNUNET_CLIENT_disconnect (h->client);
1570 schedule_reconnect (h);
1574 /* shutdown initiated from 'GNUNET_TRANSPORT_disconnect',
1575 finish clean up work! */
1580 GNUNET_CLIENT_receive (h->client,
1581 &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1582 size = ntohs (msg->size);
1583 switch (ntohs (msg->type))
1585 case GNUNET_MESSAGE_TYPE_HELLO:
1587 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) msg,
1594 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1595 "Receiving (my own) `%s' message, I am `%4s'.\n",
1596 "HELLO", GNUNET_i2s (&me));
1598 GNUNET_free_non_null (h->my_hello);
1600 if (size < sizeof (struct GNUNET_MessageHeader))
1605 h->my_hello = GNUNET_malloc (size);
1606 memcpy (h->my_hello, msg, size);
1607 while (NULL != (hwl = h->hwl_head))
1609 h->hwl_head = hwl->next;
1610 GNUNET_SCHEDULER_cancel (h->sched, hwl->task);
1611 GNUNET_TRANSPORT_get_hello (h,
1612 GNUNET_TIME_UNIT_ZERO,
1613 hwl->rec, hwl->rec_cls);
1617 case GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT:
1618 if (size != sizeof (struct ConnectInfoMessage))
1623 cim = (const struct ConnectInfoMessage *) msg;
1625 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1626 "Receiving `%s' message for `%4s'.\n",
1627 "CONNECT", GNUNET_i2s (&cim->id));
1630 ntohl (cim->quota_out),
1631 GNUNET_TIME_relative_ntoh (cim->latency), &cim->id);
1633 case GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT:
1634 if (size != sizeof (struct DisconnectInfoMessage))
1639 dim = (const struct DisconnectInfoMessage *) msg;
1641 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1642 "Receiving `%s' message for `%4s'.\n",
1643 "DISCONNECT", GNUNET_i2s (&dim->peer));
1645 remove_neighbour (h, &dim->peer);
1647 case GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK:
1648 if (size != sizeof (struct SendOkMessage))
1653 okm = (const struct SendOkMessage *) msg;
1655 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1656 "Receiving `%s' message, transmission %s.\n", "SEND_OK",
1657 ntohl(okm->success) == GNUNET_OK ? "succeeded" : "failed");
1659 n = find_neighbour (h, &okm->peer);
1660 GNUNET_assert (n != NULL);
1661 n->transmit_ok = GNUNET_YES;
1662 if (n->transmit_handle != NULL)
1665 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1666 "Processing pending message for `%4s'\n",
1667 GNUNET_i2s(&n->id));
1669 GNUNET_SCHEDULER_cancel (h->sched,
1670 n->transmit_handle->notify_delay_task);
1671 n->transmit_handle->notify_delay_task =
1672 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
1673 GNUNET_assert (GNUNET_YES == n->received_ack);
1674 schedule_request (n->transmit_handle);
1677 case GNUNET_MESSAGE_TYPE_TRANSPORT_RECV:
1679 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1680 "Receiving `%s' message.\n", "RECV");
1683 sizeof (struct InboundMessage) +
1684 sizeof (struct GNUNET_MessageHeader))
1689 im = (const struct InboundMessage *) msg;
1690 imm = (const struct GNUNET_MessageHeader *) &im[1];
1691 if (ntohs (imm->size) + sizeof (struct InboundMessage) != size)
1696 switch (ntohs (imm->type))
1698 case GNUNET_MESSAGE_TYPE_TRANSPORT_ACK:
1700 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1701 "Receiving `%s' message from `%4s'.\n",
1702 "ACK", GNUNET_i2s (&im->peer));
1704 n = find_neighbour (h, &im->peer);
1710 if (n->received_ack == GNUNET_NO)
1712 n->received_ack = GNUNET_YES;
1713 if (NULL != n->transmit_handle)
1716 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1717 "Peer connected, scheduling delayed message for deliverery now.\n");
1719 schedule_request (n->transmit_handle);
1725 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1726 "Received message of type %u from `%4s'.\n",
1727 ntohs (imm->type), GNUNET_i2s (&im->peer));
1731 GNUNET_TIME_relative_ntoh (im->latency), &im->peer, imm);
1736 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1738 ("Received unexpected message of type %u in %s:%u\n"),
1739 ntohs (msg->type), __FILE__, __LINE__);
1746 struct ClientTransmitWrapper
1748 GNUNET_NETWORK_TransmitReadyNotify notify;
1750 struct GNUNET_TRANSPORT_TransmitHandle *th;
1755 * Transmit message of a client destined for another
1756 * peer to the service.
1759 client_notify_wrapper (void *cls, size_t size, void *buf)
1761 struct ClientTransmitWrapper *ctw = cls;
1762 struct OutboundMessage *obm;
1763 struct GNUNET_MessageHeader *hdr;
1769 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1770 "Transmission request could not be satisfied.\n");
1772 ret = ctw->notify (ctw->notify_cls, 0, NULL);
1773 GNUNET_assert (ret == 0);
1777 GNUNET_assert (size >= sizeof (struct OutboundMessage));
1779 ret = ctw->notify (ctw->notify_cls,
1780 size - sizeof (struct OutboundMessage),
1784 /* Need to reset flag, no SEND means no SEND_OK! */
1785 ctw->th->neighbour->transmit_ok = GNUNET_YES;
1789 GNUNET_assert (ret >= sizeof (struct GNUNET_MessageHeader));
1790 hdr = (struct GNUNET_MessageHeader *) &obm[1];
1791 GNUNET_assert (ntohs (hdr->size) == ret);
1792 GNUNET_assert (ret + sizeof (struct OutboundMessage) <
1793 GNUNET_SERVER_MAX_MESSAGE_SIZE);
1795 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1796 "Transmitting `%s' message with data for `%4s'\n",
1797 "SEND", GNUNET_i2s (&ctw->th->target));
1799 ret += sizeof (struct OutboundMessage);
1800 obm->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND);
1801 obm->header.size = htons (ret);
1802 obm->priority = htonl (ctw->th->priority);
1803 obm->peer = ctw->th->target;
1811 * Check if we could queue a message of the given size for
1812 * transmission. The transport service will take both its
1813 * internal buffers and bandwidth limits imposed by the
1814 * other peer into consideration when answering this query.
1816 * @param handle connection to transport service
1817 * @param target who should receive the message
1818 * @param size how big is the message we want to transmit?
1819 * @param priority how important is the message?
1820 * @param timeout after how long should we give up (and call
1821 * notify with buf NULL and size 0)?
1822 * @param notify function to call when we are ready to
1823 * send such a message
1824 * @param notify_cls closure for notify
1825 * @return NULL if someone else is already waiting to be notified
1826 * non-NULL if the notify callback was queued (can be used to cancel
1827 * using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
1829 struct GNUNET_TRANSPORT_TransmitHandle *
1830 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle
1832 const struct GNUNET_PeerIdentity
1833 *target, size_t size,
1834 unsigned int priority,
1835 struct GNUNET_TIME_Relative timeout,
1836 GNUNET_NETWORK_TransmitReadyNotify
1837 notify, void *notify_cls)
1839 struct GNUNET_TRANSPORT_TransmitHandle *pos;
1840 struct GNUNET_TRANSPORT_TransmitHandle *th;
1841 struct NeighbourList *n;
1842 struct ClientTransmitWrapper *ctw;
1844 if (size + sizeof (struct OutboundMessage) >=
1845 GNUNET_SERVER_MAX_MESSAGE_SIZE)
1851 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1852 "Asking transport service for transmission of %u bytes to peer `%4s'.\n",
1853 size, GNUNET_i2s (target));
1855 n = find_neighbour (handle, target);
1857 (n->transmit_handle != NULL) )
1858 return NULL; /* already have a request pending for this peer! */
1859 ctw = GNUNET_malloc (sizeof (struct ClientTransmitWrapper));
1860 th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
1861 ctw->notify = notify;
1862 ctw->notify_cls = notify_cls;
1864 th->handle = handle;
1866 th->target = *target;
1867 th->notify = &client_notify_wrapper;
1868 th->notify_cls = ctw;
1869 th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1870 th->notify_size = size + sizeof (struct OutboundMessage);
1871 th->priority = priority;
1874 pos = handle->connect_wait_head;
1877 GNUNET_assert (0 != memcmp (target,
1879 sizeof (struct GNUNET_PeerIdentity)));
1883 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1884 "Will now try to connect to `%4s'.\n", GNUNET_i2s (target));
1891 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1892 "Transmission request queued for transmission to transport service.\n");
1894 GNUNET_assert (NULL == n->transmit_handle);
1895 n->transmit_handle = th;
1896 if (GNUNET_YES != n->received_ack)
1899 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1900 "Connection to `%4s' is not yet confirmed connected, scheduling timeout (%llu ms) only.\n",
1901 GNUNET_i2s (target), timeout.value);
1903 th->notify_delay_task
1904 = GNUNET_SCHEDULER_add_delayed (handle->sched,
1906 GNUNET_SCHEDULER_PRIORITY_KEEP,
1907 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
1908 timeout, &transmit_timeout, th);
1913 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1914 "Peer `%4s' is ready to receive, scheduling message for delivery now.\n",
1915 GNUNET_i2s (target));
1917 schedule_request (th);
1923 * Cancel the specified transmission-ready
1927 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
1928 GNUNET_TRANSPORT_TransmitHandle
1931 struct GNUNET_TRANSPORT_Handle *h;
1934 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1935 "Transmission request of %u bytes to `%4s' was cancelled.\n",
1936 th->notify_size - sizeof(struct OutboundMessage),
1937 GNUNET_i2s (&th->target));
1939 GNUNET_assert (th->notify == &client_notify_wrapper);
1940 remove_from_any_list (th);
1942 if ((h->connect_ready_head == NULL) && (h->network_handle != NULL))
1944 GNUNET_NETWORK_notify_transmit_ready_cancel (h->network_handle);
1945 h->network_handle = NULL;
1946 h->transmission_scheduled = GNUNET_NO;
1948 GNUNET_free (th->notify_cls);
1953 /* end of transport_api.c */