2 This file is part of GNUnet.
3 (C) 2009, 2010 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 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 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_bandwidth_lib.h"
28 #include "gnunet_client_lib.h"
29 #include "gnunet_constants.h"
30 #include "gnunet_container_lib.h"
31 #include "gnunet_arm_service.h"
32 #include "gnunet_hello_lib.h"
33 #include "gnunet_protocols.h"
34 #include "gnunet_server_lib.h"
35 #include "gnunet_time_lib.h"
36 #include "gnunet_transport_service.h"
37 #include "transport.h"
40 * After how long do we give up on transmitting a HELLO
43 #define OFFER_HELLO_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
46 * After how long do we automatically retry an unsuccessful
49 #define CONNECT_RETRY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 750)
52 * How long should ARM wait when starting up the
53 * transport service before reporting back?
55 #define START_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
58 * How long should ARM wait when stopping the
59 * transport service before reporting back?
61 #define STOP_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
64 * How large to start with for the hashmap of neighbours.
66 #define STARTING_NEIGHBOURS_SIZE 10
70 * What stage are we in for transmission processing?
80 * Message in local queue, not given to service.
85 * Message given to service, not confirmed (no SEND_OK).
90 * One message was given to service and before it was confirmed,
91 * another one was already queued (waiting for SEND_OK to pass on
94 TS_TRANSMITTED_QUEUED = 3
99 * Handle for a transmission-ready request.
101 struct GNUNET_TRANSPORT_TransmitHandle
105 * Neighbour for this handle, NULL for control-traffic.
107 struct NeighbourList *neighbour;
110 * Function to call when notify_size bytes are available
113 GNUNET_CONNECTION_TransmitReadyNotify notify;
116 * Closure for notify.
121 * transmit_ready task Id. The task is used to introduce the
122 * artificial delay that may be required to maintain the bandwidth
123 * limits. Later, this will be the ID of the "transmit_timeout"
124 * task which is used to signal a timeout if the transmission could
125 * not be done in a timely fashion.
127 GNUNET_SCHEDULER_TaskIdentifier notify_delay_task;
130 * Timeout for this request.
132 struct GNUNET_TIME_Absolute timeout;
135 * How many bytes is our notify callback waiting for?
140 * How important is this message?
148 * Handle for a control message queue entry.
150 struct ControlMessage
154 * This is a doubly-linked list.
156 struct ControlMessage *next;
159 * This is a doubly-linked list.
161 struct ControlMessage *prev;
164 * Overall transport handle.
166 struct GNUNET_TRANSPORT_Handle *h;
169 * Function to call when notify_size bytes are available
172 GNUNET_CONNECTION_TransmitReadyNotify notify;
175 * Closure for notify.
180 * transmit_ready task Id. The task is used to introduce the
181 * artificial delay that may be required to maintain the bandwidth
182 * limits. Later, this will be the ID of the "transmit_timeout"
183 * task which is used to signal a timeout if the transmission could
184 * not be done in a timely fashion.
186 GNUNET_SCHEDULER_TaskIdentifier notify_delay_task;
189 * How many bytes is our notify callback waiting for?
196 * Context for storing information about attempted next transmission.
198 struct TryTransmitContext
202 * Main transport handle.
204 struct GNUNET_TRANSPORT_Handle *h;
207 * Returned transmission handle.
209 struct GNUNET_TRANSPORT_TransmitHandle *ret;
212 * Time to retry the send task.
214 struct GNUNET_TIME_Relative retry_time;
218 * Entry in hash table of all of our current neighbours.
223 * Overall transport handle.
225 struct GNUNET_TRANSPORT_Handle *h;
228 * Active transmit handle; available if 'transmit_forbidden'
231 struct GNUNET_TRANSPORT_TransmitHandle transmit_handle;
234 * Identity of this neighbour.
236 struct GNUNET_PeerIdentity id;
239 * Outbound bandwidh tracker.
241 struct GNUNET_BANDWIDTH_Tracker out_tracker;
244 * Set to GNUNET_NO if we are currently allowed to accept a
245 * message to the transport service for this peer, GNUNET_YES
246 * if we have one and are waiting for transmission, GNUNET_SYSERR
247 * if we are waiting for confirmation AND have already accepted
248 * yet another message.
250 enum TransmitStage transmit_stage;
253 * Have we received a notification that this peer is connected
259 * Are we in the middle of disconnecting the peer already?
261 unsigned int in_disconnect;
267 * Linked list of requests from clients for our HELLO that were
274 * This is a linked list.
276 struct HelloWaitList *next;
279 * Reference back to our transport handle.
281 struct GNUNET_TRANSPORT_Handle *handle;
284 * Callback to call once we got our HELLO.
286 GNUNET_TRANSPORT_HelloUpdateCallback rec;
297 * Handle for the transport service (includes all of the
298 * state for the transport service).
300 struct GNUNET_TRANSPORT_Handle
304 * Closure for the callbacks.
309 * Function to call for received data.
311 GNUNET_TRANSPORT_ReceiveCallback rec;
314 * function to call on connect events
316 GNUNET_TRANSPORT_NotifyConnect nc_cb;
319 * function to call on disconnect events
321 GNUNET_TRANSPORT_NotifyDisconnect nd_cb;
324 * Head of DLL of control messages.
326 struct ControlMessage *control_head;
329 * Tail of DLL of control messages.
331 struct ControlMessage *control_tail;
334 * The current HELLO message for this peer. Updated
335 * whenever transports change their addresses.
337 struct GNUNET_HELLO_Message *my_hello;
340 * My client connection to the transport service.
342 struct GNUNET_CLIENT_Connection *client;
345 * Handle to our registration with the client for notification.
347 struct GNUNET_CLIENT_TransmitHandle *network_handle;
350 * Linked list of pending requests for our HELLO.
352 struct HelloWaitList *hwl_head;
357 const struct GNUNET_CONFIGURATION_Handle *cfg;
360 * Linked list of the current neighbours of this peer.
362 struct GNUNET_CONTAINER_MultiHashMap *neighbours;
365 * Peer identity as assumed by this process, or all zeros.
367 struct GNUNET_PeerIdentity self;
370 * ID of the task trying to reconnect to the service.
372 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
375 * ID of the task trying to trigger transmission for a peer
376 * while maintaining bandwidth quotas.
378 GNUNET_SCHEDULER_TaskIdentifier quota_task;
381 * Delay until we try to reconnect.
383 struct GNUNET_TIME_Relative reconnect_delay;
386 * Set once we are in the process of disconnecting from the
392 * Should we check that 'self' matches what the service thinks?
393 * (if GNUNET_NO, then 'self' is all zeros!).
402 * Size of the HELLO copied to end of struct.
407 * Continuation to call once HELLO sent.
409 GNUNET_SCHEDULER_Task cont;
412 * Closure to call with the continuation.
421 * Get the neighbour list entry for the given peer
423 * @param h our context
424 * @param peer peer to look up
425 * @return NULL if no such peer entry exists
427 static struct NeighbourList *
428 neighbour_find (struct GNUNET_TRANSPORT_Handle *h,
429 const struct GNUNET_PeerIdentity *peer)
431 return GNUNET_CONTAINER_multihashmap_get(h->neighbours, &peer->hashPubKey);
436 * Schedule the task to send one message, either from the control
437 * list or the peer message queues to the service.
439 static void schedule_transmission (struct GNUNET_TRANSPORT_Handle *h);
443 * Function called by the scheduler when the timeout for bandwidth
444 * availablility for the target neighbour is reached.
446 * @param cls the 'struct GNUNET_TRANSPORT_Handle*'
447 * @param tc scheduler context
450 quota_transmit_ready (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
452 struct GNUNET_TRANSPORT_Handle *h = cls;
454 h->quota_task = GNUNET_SCHEDULER_NO_TASK;
455 schedule_transmission (h);
460 * Iterator over hash map entries, attempt to schedule
461 * a transmission to entries in the neighbour hashmap.
463 * @param cls closure a TryTransmitContext
464 * @param key current key code
465 * @param value value in the hash map, the neighbour entry to consider
466 * @return GNUNET_YES if we should continue to
471 try_schedule_transmission (void *cls,
472 const GNUNET_HashCode * key,
475 struct NeighbourList *n = value;
476 struct TryTransmitContext *try_transmit_ctx = cls;
477 struct GNUNET_TIME_Relative duration;
478 GNUNET_CONNECTION_TransmitReadyNotify notify;
479 struct GNUNET_TRANSPORT_TransmitHandle *th;
480 struct GNUNET_TIME_Absolute duration_abs;
482 if (n->transmit_stage != TS_QUEUED)
483 return GNUNET_YES; /* not eligible, keep iterating */
484 if (n->is_connected != GNUNET_YES)
485 return GNUNET_YES; /* keep iterating */
487 th = &n->transmit_handle;
488 GNUNET_break (n == th->neighbour);
489 /* check outgoing quota */
490 duration = GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker,
491 th->notify_size - sizeof (struct OutboundMessage));
492 duration_abs = GNUNET_TIME_relative_to_absolute (duration);
493 if (th->timeout.abs_value < duration_abs.abs_value)
495 /* signal timeout! */
497 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
498 "Would need %llu ms before bandwidth is available for delivery to `%4s', that is too long. Signaling timeout.\n",
500 GNUNET_i2s (&n->id));
502 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
504 GNUNET_SCHEDULER_cancel (th->notify_delay_task);
505 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
507 n->transmit_stage = TS_NEW;
508 if (NULL != (notify = th->notify))
511 GNUNET_assert (0 == notify (th->notify_cls, 0, NULL));
513 return GNUNET_YES; /* keep iterating */
515 if (duration.rel_value > 0)
518 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
519 "Need more bandwidth (%u b/s allowed, %u b needed), delaying delivery to `%4s' by %llu ms\n",
520 (unsigned int) n->out_tracker.available_bytes_per_s__,
521 (unsigned int) th->notify_size - sizeof (struct OutboundMessage),
523 (unsigned long long) duration.rel_value);
525 try_transmit_ctx->retry_time = GNUNET_TIME_relative_min (try_transmit_ctx->retry_time,
527 return GNUNET_YES; /* keep iterating */
530 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
531 "Have %u bytes of bandwidth available for transmission to `%4s' right now\n",
532 th->notify_size - sizeof (struct OutboundMessage),
533 GNUNET_i2s (&n->id));
536 if ( (try_transmit_ctx->ret == NULL) ||
537 (try_transmit_ctx->ret->priority < th->priority) )
538 try_transmit_ctx->ret = th;
544 * Figure out which transmission to a peer can be done right now.
545 * If none can, schedule a task to call 'schedule_transmission'
546 * whenever a peer transmission can be done in the future and
547 * return NULL. Otherwise return the next transmission to be
550 * @param h handle to transport
551 * @return NULL to wait longer before doing any peer transmissions
553 static struct GNUNET_TRANSPORT_TransmitHandle *
554 schedule_peer_transmission (struct GNUNET_TRANSPORT_Handle *h)
556 struct TryTransmitContext try_transmit_ctx;
558 if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
560 GNUNET_SCHEDULER_cancel (h->quota_task);
561 h->quota_task = GNUNET_SCHEDULER_NO_TASK;
563 try_transmit_ctx.h = h;
564 try_transmit_ctx.ret = NULL;
565 try_transmit_ctx.retry_time = GNUNET_TIME_UNIT_FOREVER_REL;
566 GNUNET_CONTAINER_multihashmap_iterate(h->neighbours,
567 &try_schedule_transmission,
569 if (try_transmit_ctx.ret == NULL)
570 h->quota_task = GNUNET_SCHEDULER_add_delayed (try_transmit_ctx.retry_time,
571 "a_transmit_ready,
573 return try_transmit_ctx.ret;
578 * Transmit message(s) to service.
580 * @param cls handle to transport
581 * @param size number of bytes available in buf
582 * @param buf where to copy the message
583 * @return number of bytes copied to buf
586 transport_notify_ready (void *cls, size_t size, void *buf)
588 struct GNUNET_TRANSPORT_Handle *h = cls;
589 struct ControlMessage *cm;
590 struct GNUNET_TRANSPORT_TransmitHandle *th;
591 struct NeighbourList *n;
592 struct OutboundMessage obm;
593 GNUNET_CONNECTION_TransmitReadyNotify notify;
599 h->network_handle = NULL;
602 schedule_transmission (h);
606 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
607 "Ready to transmit %u bytes to transport service\n", size);
611 while ( (NULL != (cm = h->control_head)) &&
612 (cm->notify_size <= size) )
614 if (cm->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
616 GNUNET_SCHEDULER_cancel (cm->notify_delay_task);
617 cm->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
619 GNUNET_CONTAINER_DLL_remove (h->control_head,
622 nret = cm->notify (cm->notify_cls, size, &cbuf[ret]);
624 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
625 "Added %u bytes of control message at %u\n",
633 while ( (NULL != (th = schedule_peer_transmission (h))) &&
634 (th->notify_size <= size) )
636 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
638 GNUNET_SCHEDULER_cancel (th->notify_delay_task);
639 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
642 switch (n->transmit_stage)
648 n->transmit_stage = TS_TRANSMITTED;
653 case TS_TRANSMITTED_QUEUED:
659 GNUNET_assert (size >= sizeof (struct OutboundMessage));
662 mret = notify (th->notify_cls,
663 size - sizeof (struct OutboundMessage),
664 &cbuf[ret + sizeof (struct OutboundMessage)]);
665 GNUNET_assert (mret <= size - sizeof (struct OutboundMessage));
667 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
668 "Message of %u bytes with timeout %llums constructed for `%4s'\n",
670 (unsigned long long) GNUNET_TIME_absolute_get_remaining (th->timeout).rel_value,
671 GNUNET_i2s (&n->id));
675 GNUNET_assert (mret + sizeof (struct OutboundMessage) < GNUNET_SERVER_MAX_MESSAGE_SIZE);
676 obm.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND);
677 obm.header.size = htons (mret + sizeof (struct OutboundMessage));
678 obm.priority = htonl (th->priority);
679 obm.timeout = GNUNET_TIME_relative_hton (GNUNET_TIME_absolute_get_remaining (th->timeout));
681 memcpy (&cbuf[ret], &obm, sizeof (struct OutboundMessage));
682 ret += (mret + sizeof (struct OutboundMessage));
683 size -= (mret + sizeof (struct OutboundMessage));
684 GNUNET_BANDWIDTH_tracker_consume (&n->out_tracker, mret);
688 switch (n->transmit_stage)
697 n->transmit_stage = TS_NEW;
699 case TS_TRANSMITTED_QUEUED:
700 n->transmit_stage = TS_QUEUED;
707 schedule_transmission (h);
709 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
710 "Transmitting %u bytes to transport service\n", ret);
717 * Schedule the task to send one message, either from the control
718 * list or the peer message queues to the service.
721 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
724 struct GNUNET_TIME_Relative timeout;
725 struct GNUNET_TRANSPORT_TransmitHandle *th;
727 if (NULL != h->network_handle)
729 if (h->client == NULL)
731 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
732 _("Could not yet schedule transmission: we are not yet connected to the transport service!\n"));
733 return; /* not yet connected */
735 if (NULL != h->control_head)
737 size = h->control_head->notify_size;
738 timeout = GNUNET_TIME_UNIT_FOREVER_REL;
742 th = schedule_peer_transmission (h);
745 /* no transmission ready right now */
747 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
748 "Could not yet schedule transmission: none ready\n");
752 size = th->notify_size;
753 timeout = GNUNET_TIME_absolute_get_remaining (th->timeout);
756 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
757 "Calling notify_transmit_ready\n");
760 GNUNET_CLIENT_notify_transmit_ready (h->client,
764 &transport_notify_ready,
766 GNUNET_assert (NULL != h->network_handle);
771 * Called when our transmit request timed out before any transport
772 * reported success connecting to the desired peer or before the
773 * transport was ready to receive. Signal error and free
777 control_transmit_timeout (void *cls,
778 const struct GNUNET_SCHEDULER_TaskContext *tc)
780 struct ControlMessage *th = cls;
782 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
783 if (NULL != th->notify)
784 th->notify (th->notify_cls, 0, NULL);
785 GNUNET_CONTAINER_DLL_remove (th->h->control_head,
793 * Queue control request for transmission to the transport
796 * @param h handle to the transport service
797 * @param size number of bytes to be transmitted
798 * @param at_head request must be added to the head of the queue
799 * (otherwise request will be appended)
800 * @param timeout how long this transmission can wait (at most)
801 * @param notify function to call to get the content
802 * @param notify_cls closure for notify
805 schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h,
808 struct GNUNET_TIME_Relative timeout,
809 GNUNET_CONNECTION_TransmitReadyNotify notify,
812 struct ControlMessage *cm;
815 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
816 "Control transmit of %u bytes within %llums requested\n",
817 size, (unsigned long long) timeout.rel_value);
819 cm = GNUNET_malloc (sizeof (struct ControlMessage));
822 cm->notify_cls = notify_cls;
823 cm->notify_size = size;
824 cm->notify_delay_task
825 = GNUNET_SCHEDULER_add_delayed (timeout, &control_transmit_timeout, cm);
827 GNUNET_CONTAINER_DLL_insert (h->control_head,
831 GNUNET_CONTAINER_DLL_insert_after (h->control_head,
835 schedule_transmission (h);
842 struct SetQuotaContext
847 struct GNUNET_TRANSPORT_Handle *handle;
852 struct GNUNET_PeerIdentity target;
857 GNUNET_SCHEDULER_Task cont;
860 * Closure for 'cont'.
867 struct GNUNET_TIME_Absolute timeout;
872 struct GNUNET_BANDWIDTH_Value32NBO quota_in;
877 * Send SET_QUOTA message to the service.
879 * @param cls the 'struct SetQuotaContext'
880 * @param size number of bytes available in buf
881 * @param buf where to copy the message
882 * @return number of bytes copied to buf
885 send_set_quota (void *cls, size_t size, void *buf)
887 struct SetQuotaContext *sqc = cls;
888 struct QuotaSetMessage *msg;
892 if (sqc->cont != NULL)
893 GNUNET_SCHEDULER_add_continuation (sqc->cont,
895 GNUNET_SCHEDULER_REASON_TIMEOUT);
900 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
901 "Transmitting `%s' request with respect to `%4s'.\n",
903 GNUNET_i2s (&sqc->target));
905 GNUNET_assert (size >= sizeof (struct QuotaSetMessage));
907 msg->header.size = htons (sizeof (struct QuotaSetMessage));
908 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
909 msg->quota = sqc->quota_in;
910 memcpy (&msg->peer, &sqc->target, sizeof (struct GNUNET_PeerIdentity));
911 if (sqc->cont != NULL)
912 GNUNET_SCHEDULER_add_continuation (sqc->cont,
914 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
916 return sizeof (struct QuotaSetMessage);
921 * Set the share of incoming bandwidth for the given
922 * peer to the specified amount.
924 * @param handle connection to transport service
925 * @param target who's bandwidth quota is being changed
926 * @param quota_in incoming bandwidth quota in bytes per ms
927 * @param quota_out outgoing bandwidth quota in bytes per ms
930 GNUNET_TRANSPORT_set_quota (struct GNUNET_TRANSPORT_Handle *handle,
931 const struct GNUNET_PeerIdentity *target,
932 struct GNUNET_BANDWIDTH_Value32NBO quota_in,
933 struct GNUNET_BANDWIDTH_Value32NBO quota_out)
935 struct NeighbourList *n;
936 struct SetQuotaContext *sqc;
938 n = neighbour_find (handle, target);
942 if (ntohl (quota_out.value__) != n->out_tracker.available_bytes_per_s__)
943 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
944 "Quota changed from %u to %u for peer `%s'\n",
945 (unsigned int) n->out_tracker.available_bytes_per_s__,
946 (unsigned int) ntohl (quota_out.value__),
947 GNUNET_i2s (target));
949 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
950 "Quota remains at %u for peer `%s'\n",
951 (unsigned int) n->out_tracker.available_bytes_per_s__,
952 GNUNET_i2s (target));
954 GNUNET_BANDWIDTH_tracker_update_quota (&n->out_tracker,
960 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
961 "Quota changed to %u for peer `%s', but I have no such neighbour!\n",
962 (unsigned int) ntohl (quota_out.value__),
963 GNUNET_i2s (target));
966 sqc = GNUNET_malloc (sizeof (struct SetQuotaContext));
967 sqc->handle = handle;
968 sqc->target = *target;
970 sqc->cont_cls = NULL;
971 sqc->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_TIME_UNIT_FOREVER_REL);
972 sqc->quota_in = quota_in;
973 schedule_control_transmit (handle,
974 sizeof (struct QuotaSetMessage),
976 GNUNET_TIME_UNIT_FOREVER_REL, &send_set_quota, sqc);
981 * Ask the transport service to establish a connection to
984 * @param handle connection to transport service
985 * @param target who we should try to connect to
988 GNUNET_TRANSPORT_try_connect (struct GNUNET_TRANSPORT_Handle *handle,
989 const struct GNUNET_PeerIdentity *target)
991 /* old API does nothing */
998 * Obtain the HELLO message for this peer.
1000 * @param handle connection to transport service
1001 * @param rec function to call with the HELLO, sender will be our peer
1002 * identity; message and sender will be NULL on timeout
1003 * (handshake with transport service pending/failed).
1004 * cost estimate will be 0.
1005 * @param rec_cls closure for rec
1008 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
1009 GNUNET_TRANSPORT_HelloUpdateCallback rec,
1012 struct HelloWaitList *hwl;
1014 hwl = GNUNET_malloc (sizeof (struct HelloWaitList));
1015 hwl->next = handle->hwl_head;
1016 handle->hwl_head = hwl;
1017 hwl->handle = handle;
1019 hwl->rec_cls = rec_cls;
1020 if (handle->my_hello == NULL)
1022 rec (rec_cls, (const struct GNUNET_MessageHeader *) handle->my_hello);
1028 * Stop receiving updates about changes to our HELLO message.
1030 * @param handle connection to transport service
1031 * @param rec function previously registered to be called with the HELLOs
1032 * @param rec_cls closure for rec
1035 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_Handle *handle,
1036 GNUNET_TRANSPORT_HelloUpdateCallback rec,
1039 struct HelloWaitList *pos;
1040 struct HelloWaitList *prev;
1043 pos = handle->hwl_head;
1046 if ( (pos->rec == rec) &&
1047 (pos->rec_cls == rec_cls) )
1052 GNUNET_break (pos != NULL);
1056 handle->hwl_head = pos->next;
1058 prev->next = pos->next;
1064 * Send HELLO message to the service.
1066 * @param cls the HELLO message to send
1067 * @param size number of bytes available in buf
1068 * @param buf where to copy the message
1069 * @return number of bytes copied to buf
1072 send_hello (void *cls, size_t size, void *buf)
1074 struct HelloContext *hc = cls;
1078 #if DEBUG_TRANSPORT_TIMEOUT
1079 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1080 "Timeout while trying to transmit `%s' request.\n",
1083 GNUNET_SCHEDULER_add_now(hc->cont, hc->cont_cls);
1088 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1089 "Transmitting `%s' request.\n", "HELLO");
1091 GNUNET_assert (size >= hc->size);
1092 memcpy (buf, &hc[1], hc->size);
1094 if (hc->cont != NULL)
1096 GNUNET_SCHEDULER_add_continuation(hc->cont, hc->cont_cls, GNUNET_SCHEDULER_REASON_PREREQ_DONE);
1105 * Offer the transport service the HELLO of another peer. Note that
1106 * the transport service may just ignore this message if the HELLO is
1107 * malformed or useless due to our local configuration.
1109 * @param handle connection to transport service
1110 * @param hello the hello message
1111 * @param cont continuation to call when HELLO has been sent
1112 * @param cls closure for continuation
1116 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
1117 const struct GNUNET_MessageHeader *hello,
1118 GNUNET_SCHEDULER_Task cont,
1122 struct GNUNET_PeerIdentity peer;
1123 struct HelloContext *hc;
1125 GNUNET_break (ntohs (hello->type) == GNUNET_MESSAGE_TYPE_HELLO);
1126 size = ntohs (hello->size);
1127 GNUNET_break (size >= sizeof (struct GNUNET_MessageHeader));
1128 if (GNUNET_OK != GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message*) hello,
1134 hc = GNUNET_malloc(sizeof(struct HelloContext) + size);
1138 memcpy (&hc[1], hello, size);
1141 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1142 "Offering `%s' message of `%4s' to transport for validation.\n",
1144 GNUNET_i2s (&peer));
1147 schedule_control_transmit (handle,
1149 GNUNET_NO, OFFER_HELLO_TIMEOUT, &send_hello, hc);
1154 * Transmit START message to service.
1157 * @param size number of bytes available in buf
1158 * @param buf where to copy the message
1159 * @return number of bytes copied to buf
1162 send_start (void *cls, size_t size, void *buf)
1164 struct GNUNET_TRANSPORT_Handle *h = cls;
1165 struct StartMessage s;
1169 /* Can only be shutdown, just give up */
1171 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1172 "Shutdown while trying to transmit `%s' request.\n",
1178 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1179 "Transmitting `%s' request.\n", "START");
1181 GNUNET_assert (size >= sizeof (struct StartMessage));
1182 s.header.size = htons (sizeof (struct StartMessage));
1183 s.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_START);
1184 s.do_check = htonl (h->check_self);
1186 memcpy (buf, &s, sizeof (struct StartMessage));
1187 return sizeof (struct StartMessage);
1194 * @param n the entry to free
1197 neighbour_free (struct NeighbourList *n)
1199 struct GNUNET_TRANSPORT_Handle *h;
1201 /* Added so task gets canceled when a disconnect is received! */
1203 if (n->transmit_handle.notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1205 GNUNET_SCHEDULER_cancel(n->transmit_handle.notify_delay_task);
1206 n->transmit_handle.notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1207 n->transmit_handle.notify = NULL;
1210 /* NATE: if the above is not needed, then clearly this assertion
1211 should hold (I've checked the code and I'm pretty sure this is
1213 FIXME: remove above comments once we've seen tests pass with the assert... */
1214 GNUNET_assert (n->transmit_handle.notify_delay_task == GNUNET_SCHEDULER_NO_TASK);
1215 GNUNET_assert (n->transmit_handle.notify == NULL);
1218 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1219 "Removing neighbour `%s' from list of connected peers.\n",
1220 GNUNET_i2s (&n->id));
1222 GNUNET_break (n->is_connected == GNUNET_NO);
1223 GNUNET_break (n->transmit_stage == TS_NEW);
1225 GNUNET_assert(GNUNET_YES ==
1226 GNUNET_CONTAINER_multihashmap_remove(h->neighbours,
1234 * Mark neighbour as disconnected.
1236 * @param n the entry to mark as disconnected
1239 neighbour_disconnect (struct NeighbourList *n)
1241 struct GNUNET_TRANSPORT_Handle *h = n->h;
1243 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1244 "Removing neighbour `%s' from list of connected peers.\n",
1245 GNUNET_i2s (&n->id));
1247 GNUNET_break (n->is_connected == GNUNET_YES);
1248 n->is_connected = GNUNET_NO;
1249 /* FIXME: this 'in_disconnect' flag is dubious; we should define
1250 clearly what disconnect means for pending 'notify_transmit_ready'
1251 requests; maybe a good approach is to REQUIRE clients to
1252 call 'notify_transmit_ready_cancel' on pending requests on disconnect
1253 and otherwise FAIL HARD with an assertion failure before
1254 'neighbour_free' right here (transmit_stage would be forced
1256 n->in_disconnect = GNUNET_YES;
1257 if (h->nd_cb != NULL)
1258 h->nd_cb (h->cls, &n->id);
1259 if (n->transmit_stage == TS_NEW)
1265 * Function we use for handling incoming messages.
1267 * @param cls closure (struct GNUNET_TRANSPORT_Handle *)
1268 * @param msg message received, NULL on timeout or fatal error
1270 static void demultiplexer (void *cls,
1271 const struct GNUNET_MessageHeader *msg);
1275 * Iterator over hash map entries, for getting rid of a neighbor
1276 * upon a reconnect call.
1278 * @param cls closure (NULL)
1279 * @param key current key code
1280 * @param value value in the hash map, the neighbour entry to forget
1281 * @return GNUNET_YES if we should continue to
1286 forget_neighbours (void *cls,
1287 const GNUNET_HashCode * key,
1290 struct NeighbourList *n = value;
1292 #if DEBUG_TRANSPORT_DISCONNECT
1293 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1294 "Disconnecting due to reconnect being called\n");
1296 if (n->is_connected)
1297 neighbour_disconnect (n);
1304 * Try again to connect to transport service.
1306 * @param cls the handle to the transport service
1307 * @param tc scheduler context
1310 reconnect (void *cls,
1311 const struct GNUNET_SCHEDULER_TaskContext *tc)
1313 struct GNUNET_TRANSPORT_Handle *h = cls;
1314 struct ControlMessage *pos;
1316 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1317 if ( (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
1319 /* shutdown, just give up */
1322 /* Forget about all neighbours that we used to be connected to */
1323 GNUNET_CONTAINER_multihashmap_iterate(h->neighbours,
1328 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1329 "Connecting to transport service.\n");
1331 GNUNET_assert (h->client == NULL);
1332 h->client = GNUNET_CLIENT_connect ("transport", h->cfg);
1333 GNUNET_assert (h->client != NULL);
1334 /* make sure we don't send "START" twice, remove existing entry from
1335 queue (if present) */
1336 pos = h->control_head;
1339 if (pos->notify == &send_start)
1341 GNUNET_CONTAINER_DLL_remove (h->control_head,
1344 if (GNUNET_SCHEDULER_NO_TASK != pos->notify_delay_task)
1346 GNUNET_SCHEDULER_cancel (pos->notify_delay_task);
1347 pos->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1354 schedule_control_transmit (h,
1355 sizeof (struct StartMessage),
1357 GNUNET_TIME_UNIT_FOREVER_REL, &send_start, h);
1358 GNUNET_CLIENT_receive (h->client,
1359 &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1364 * Function that will schedule the job that will try
1365 * to connect us again to the client.
1367 * @param h transport service to reconnect
1370 schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
1373 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1374 "Scheduling task to reconnect to transport service in %llu ms.\n",
1375 h->reconnect_delay.rel_value);
1377 GNUNET_assert (h->client == NULL);
1378 GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
1380 = GNUNET_SCHEDULER_add_delayed (h->reconnect_delay, &reconnect, h);
1381 if (h->reconnect_delay.rel_value == 0)
1383 h->reconnect_delay = GNUNET_TIME_UNIT_MILLISECONDS;
1387 h->reconnect_delay = GNUNET_TIME_relative_multiply (h->reconnect_delay, 2);
1388 h->reconnect_delay = GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
1389 h->reconnect_delay);
1395 * Send request connect message to the service.
1397 * @param cls the TransportRequestConnectMessage
1398 * @param size number of bytes available in buf
1399 * @param buf where to copy the message
1400 * @return number of bytes copied to buf
1403 send_transport_request_connect (void *cls, size_t size, void *buf)
1405 struct TransportRequestConnectMessage *trcm = cls;
1410 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1411 "Buffer null for %s\n",
1418 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1419 "Transmitting `%s' request for `%4s'.\n",
1421 GNUNET_i2s (&trcm->peer));
1423 GNUNET_assert (size >= sizeof (struct TransportRequestConnectMessage));
1424 memcpy(buf, trcm, sizeof(struct TransportRequestConnectMessage));
1426 return sizeof(struct TransportRequestConnectMessage);
1430 * Create and send a request connect message to
1431 * the transport service for a particular peer.
1433 * @param h handle to the transport service
1434 * @param n the neighbor to send the request connect message about
1438 send_request_connect_message(struct GNUNET_TRANSPORT_Handle *h, struct NeighbourList *n)
1440 struct TransportRequestConnectMessage *trcm;
1442 trcm = GNUNET_malloc(sizeof(struct TransportRequestConnectMessage));
1443 trcm->header.type = htons(GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT);
1444 trcm->header.size = htons(sizeof(struct TransportRequestConnectMessage));
1445 memcpy(&trcm->peer, &n->id, sizeof(struct GNUNET_PeerIdentity));
1446 schedule_control_transmit (h,
1447 sizeof (struct TransportRequestConnectMessage),
1449 GNUNET_TIME_UNIT_FOREVER_REL, &send_transport_request_connect, trcm);
1454 * Add neighbour to our list
1456 * @return NULL if this API is currently disconnecting from the service
1458 static struct NeighbourList *
1459 neighbour_add (struct GNUNET_TRANSPORT_Handle *h,
1460 const struct GNUNET_PeerIdentity *pid)
1462 struct NeighbourList *n;
1464 if (GNUNET_YES == h->in_disconnect)
1466 /* check for duplicates */
1467 if (NULL != (n = neighbour_find (h, pid)))
1473 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1474 "Creating entry for neighbour `%4s'.\n",
1477 n = GNUNET_malloc (sizeof (struct NeighbourList));
1480 GNUNET_BANDWIDTH_tracker_init (&n->out_tracker,
1481 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
1482 MAX_BANDWIDTH_CARRY_S);
1483 GNUNET_CONTAINER_multihashmap_put (h->neighbours,
1486 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
1493 * Iterator over hash map entries, for deleting state of a neighbor.
1495 * @param cls closure (NULL)
1496 * @param key current key code
1497 * @param value value in the hash map, the neighbour entry to delete
1498 * @return GNUNET_YES if we should continue to
1503 delete_neighbours (void *cls,
1504 const GNUNET_HashCode * key,
1507 struct NeighbourList *n = value;
1508 struct GNUNET_TRANSPORT_TransmitHandle *th;
1510 switch (n->transmit_stage)
1513 case TS_TRANSMITTED:
1517 case TS_TRANSMITTED_QUEUED:
1518 th = &n->transmit_handle;
1519 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1521 GNUNET_SCHEDULER_cancel (th->notify_delay_task);
1522 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1524 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
1535 * Connect to the transport service. Note that the connection may
1536 * complete (or fail) asynchronously.
1538 * @param cfg configuration to use
1539 * @param self our own identity (API should check that it matches
1540 * the identity found by transport), or NULL (no check)
1541 * @param cls closure for the callbacks
1542 * @param rec receive function to call
1543 * @param nc function to call on connect events
1544 * @param nd function to call on disconnect events
1546 struct GNUNET_TRANSPORT_Handle *
1547 GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1548 const struct GNUNET_PeerIdentity *self,
1550 GNUNET_TRANSPORT_ReceiveCallback rec,
1551 GNUNET_TRANSPORT_NotifyConnect nc,
1552 GNUNET_TRANSPORT_NotifyDisconnect nd)
1554 struct GNUNET_TRANSPORT_Handle *ret;
1556 ret = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_Handle));
1560 ret->check_self = GNUNET_YES;
1567 ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
1568 ret->neighbours = GNUNET_CONTAINER_multihashmap_create(STARTING_NEIGHBOURS_SIZE);
1569 schedule_reconnect (ret);
1575 * Disconnect from the transport service.
1578 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
1580 struct HelloWaitList *hwl;
1581 struct GNUNET_CLIENT_Connection *client;
1582 struct ControlMessage *cm;
1585 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transport disconnect called!\n");
1587 /* FIXME: this flag is dubious, we should be able to do this
1588 more cleanly; also, we should probably do 'disconnect'
1589 callbacks for every connected peer here, i.e. by calling
1590 the iterator with 'forget_neighbours' instead of 'delete_neighbours'.
1593 handle->in_disconnect = GNUNET_YES;
1595 GNUNET_assert (GNUNET_SYSERR !=
1596 GNUNET_CONTAINER_multihashmap_iterate(handle->neighbours,
1599 GNUNET_CONTAINER_multihashmap_destroy (handle->neighbours);
1601 while (NULL != (hwl = handle->hwl_head))
1603 handle->hwl_head = hwl->next;
1604 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1606 ("Disconnect while notification for `%s' still registered.\n"),
1608 if (hwl->rec != NULL)
1609 hwl->rec (hwl->rec_cls, NULL);
1613 /* Check for still scheduled control messages, cancel delay tasks if so */
1614 /* Added because somehow a notify_delay_task is remaining scheduled and is ever so annoying */
1615 while ( (NULL != (cm = handle->control_head)))
1618 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1619 "Disconnect before control message sent!\n");
1621 if (cm->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1623 GNUNET_SCHEDULER_cancel (cm->notify_delay_task);
1624 cm->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1626 GNUNET_CONTAINER_DLL_remove (handle->control_head,
1627 handle->control_tail,
1633 if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1635 GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1636 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1638 if (handle->quota_task != GNUNET_SCHEDULER_NO_TASK)
1640 GNUNET_SCHEDULER_cancel (handle->quota_task);
1641 handle->quota_task = GNUNET_SCHEDULER_NO_TASK;
1643 GNUNET_free_non_null (handle->my_hello);
1644 handle->my_hello = NULL;
1646 if (NULL != handle->network_handle)
1648 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->network_handle);
1649 handle->network_handle = NULL;
1651 if (NULL != (client = handle->client))
1654 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1655 "Disconnecting from transport service for good.\n");
1657 handle->client = NULL;
1658 GNUNET_CLIENT_disconnect (client, GNUNET_YES);
1660 GNUNET_free (handle);
1665 * Function we use for handling incoming messages.
1667 * @param cls closure (struct GNUNET_TRANSPORT_Handle *)
1668 * @param msg message received, NULL on timeout or fatal error
1671 demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
1673 struct GNUNET_TRANSPORT_Handle *h = cls;
1674 const struct DisconnectInfoMessage *dim;
1675 const struct ConnectInfoMessage *cim;
1676 const struct InboundMessage *im;
1677 const struct GNUNET_MessageHeader *imm;
1678 const struct SendOkMessage *okm;
1679 struct HelloWaitList *hwl;
1680 struct HelloWaitList *next_hwl;
1681 struct NeighbourList *n;
1682 struct GNUNET_PeerIdentity me;
1686 if (h->client == NULL)
1688 /* shutdown initiated from 'GNUNET_TRANSPORT_disconnect',
1689 finish clean up work! */
1696 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1697 "Error receiving from transport service, disconnecting temporarily.\n");
1699 if (h->network_handle != NULL)
1701 GNUNET_CLIENT_notify_transmit_ready_cancel (h->network_handle);
1702 h->network_handle = NULL;
1704 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
1706 schedule_reconnect (h);
1709 GNUNET_CLIENT_receive (h->client,
1710 &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1711 size = ntohs (msg->size);
1712 switch (ntohs (msg->type))
1714 case GNUNET_MESSAGE_TYPE_HELLO:
1716 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) msg,
1723 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1724 "Receiving (my own) `%s' message, I am `%4s'.\n",
1725 "HELLO", GNUNET_i2s (&me));
1727 GNUNET_free_non_null (h->my_hello);
1729 if (size < sizeof (struct GNUNET_MessageHeader))
1734 h->my_hello = GNUNET_malloc (size);
1735 memcpy (h->my_hello, msg, size);
1739 next_hwl = hwl->next;
1740 hwl->rec (hwl->rec_cls,
1741 (const struct GNUNET_MessageHeader *) h->my_hello);
1745 case GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT:
1746 if (size < sizeof (struct ConnectInfoMessage))
1751 cim = (const struct ConnectInfoMessage *) msg;
1752 ats_count = ntohl (cim->ats_count);
1753 if (size != sizeof (struct ConnectInfoMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information))
1758 if (0 == memcmp (&cim->id,
1760 sizeof (struct GNUNET_PeerIdentity)))
1762 /* connect to self!? */
1767 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1768 "Receiving `%s' message for `%4s'.\n",
1769 "CONNECT", GNUNET_i2s (&cim->id));
1771 n = neighbour_find (h, &cim->id);
1773 n = neighbour_add (h, &cim->id);
1776 GNUNET_break (n->is_connected == GNUNET_NO);
1777 n->is_connected = GNUNET_YES;
1779 if (h->nc_cb != NULL)
1780 h->nc_cb (h->cls, &n->id,
1781 &cim->ats,ats_count);
1784 case GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT:
1785 if (size != sizeof (struct DisconnectInfoMessage))
1790 dim = (const struct DisconnectInfoMessage *) msg;
1791 GNUNET_break (ntohl (dim->reserved) == 0);
1792 if (0 == memcmp (&dim->peer,
1794 sizeof (struct GNUNET_PeerIdentity)))
1796 /* discconnect from self!? */
1800 #if DEBUG_TRANSPORT_DISCONNECT
1801 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1802 "Receiving `%s' message for `%4s'.\n",
1804 GNUNET_i2s (&dim->peer));
1806 n = neighbour_find (h, &dim->peer);
1807 GNUNET_break (n != NULL);
1809 neighbour_disconnect (n);
1811 case GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK:
1812 if (size != sizeof (struct SendOkMessage))
1817 okm = (const struct SendOkMessage *) msg;
1819 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1820 "Receiving `%s' message, transmission %s.\n", "SEND_OK",
1821 ntohl (okm->success) == GNUNET_OK ? "succeeded" : "failed");
1823 n = neighbour_find (h, &okm->peer);
1824 GNUNET_assert (n != NULL);
1825 switch (n->transmit_stage)
1833 case TS_TRANSMITTED:
1834 n->transmit_stage = TS_NEW;
1836 case TS_TRANSMITTED_QUEUED:
1837 n->transmit_stage = TS_QUEUED;
1838 schedule_transmission (h);
1844 case GNUNET_MESSAGE_TYPE_TRANSPORT_RECV:
1846 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1847 "Receiving `%s' message.\n", "RECV");
1850 sizeof (struct InboundMessage) +
1851 sizeof (struct GNUNET_MessageHeader))
1856 im = (const struct InboundMessage *) msg;
1857 GNUNET_break (0 == ntohl (im->reserved));
1858 ats_count = ntohl(im->ats_count);
1859 //imm = (const struct GNUNET_MessageHeader *) &im[1];
1860 imm = (const struct GNUNET_MessageHeader *) &((&(im->ats))[ats_count+1]);
1862 if (ntohs (imm->size) + sizeof (struct InboundMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information) != size)
1868 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1869 "Received message of type %u from `%4s'.\n",
1870 ntohs (imm->type), GNUNET_i2s (&im->peer));
1872 n = neighbour_find (h, &im->peer);
1878 if (n->is_connected != GNUNET_YES)
1885 h->rec (h->cls, &im->peer, imm,
1886 &im->ats, ats_count);
1890 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1892 ("Received unexpected message of type %u in %s:%u\n"),
1893 ntohs (msg->type), __FILE__, __LINE__);
1901 * Called when our transmit request timed out before any transport
1902 * reported success connecting to the desired peer or before the
1903 * transport was ready to receive. Signal error and free
1906 * @param cls the 'struct GNUNET_TRANSPORT_TransmitHandle*' that is timing out
1907 * @param tc scheduler context
1910 peer_transmit_timeout (void *cls,
1911 const struct GNUNET_SCHEDULER_TaskContext *tc)
1913 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
1914 struct NeighbourList *n;
1915 GNUNET_CONNECTION_TransmitReadyNotify notify;
1918 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1921 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1922 "Triggering timeout for request to transmit to `%4s' (%d)\n",
1923 GNUNET_i2s (&n->id),
1926 notify = th->notify;
1928 notify_cls = th->notify_cls;
1929 switch (n->transmit_stage)
1935 n->transmit_stage = TS_NEW;
1936 if (n->is_connected == GNUNET_NO)
1939 case TS_TRANSMITTED:
1942 case TS_TRANSMITTED_QUEUED:
1943 n->transmit_stage = TS_TRANSMITTED;
1949 notify (notify_cls, 0, NULL);
1954 * Check if we could queue a message of the given size for
1955 * transmission. The transport service will take both its
1956 * internal buffers and bandwidth limits imposed by the
1957 * other peer into consideration when answering this query.
1959 * @param handle connection to transport service
1960 * @param target who should receive the message
1961 * @param size how big is the message we want to transmit?
1962 * @param priority how important is the message?
1963 * @param timeout after how long should we give up (and call
1964 * notify with buf NULL and size 0)?
1965 * @param notify function to call when we are ready to
1966 * send such a message
1967 * @param notify_cls closure for notify
1968 * @return NULL if someone else is already waiting to be notified
1969 * non-NULL if the notify callback was queued (can be used to cancel
1970 * using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
1972 struct GNUNET_TRANSPORT_TransmitHandle *
1973 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle
1975 const struct GNUNET_PeerIdentity
1976 *target, size_t size,
1978 struct GNUNET_TIME_Relative timeout,
1979 GNUNET_CONNECTION_TransmitReadyNotify
1980 notify, void *notify_cls)
1982 struct GNUNET_TRANSPORT_TransmitHandle *th;
1983 struct NeighbourList *n;
1985 if (size + sizeof (struct OutboundMessage) >=
1986 GNUNET_SERVER_MAX_MESSAGE_SIZE)
1989 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1990 "Message size is %d, max allowed is %d.\n",
1991 size + sizeof (struct OutboundMessage), GNUNET_SERVER_MAX_MESSAGE_SIZE - 1);
1997 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1998 "Asking transport service for transmission of %u bytes to peer `%4s' within %llu ms.\n",
1999 size, GNUNET_i2s (target),
2000 (unsigned long long) timeout.rel_value);
2002 n = neighbour_find (handle, target);
2005 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2006 "Created neighbour entry for peer `%s'\n",
2007 GNUNET_i2s (target));
2008 n = neighbour_add (handle, target);
2012 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2013 "Could not create neighbour entry for peer `%s'\n",
2014 GNUNET_i2s (target));
2019 * Send a request connect message if not connected,
2020 * otherwise we will never send anything to
2023 if (n->is_connected == GNUNET_NO)
2025 send_request_connect_message(handle, n);
2028 switch (n->transmit_stage)
2031 n->transmit_stage = TS_QUEUED;
2036 case TS_TRANSMITTED:
2037 n->transmit_stage = TS_TRANSMITTED_QUEUED;
2039 case TS_TRANSMITTED_QUEUED:
2046 th = &n->transmit_handle;
2048 th->notify = notify;
2049 th->notify_cls = notify_cls;
2050 th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
2051 th->notify_size = size + sizeof (struct OutboundMessage);
2052 th->priority = priority;
2053 th->notify_delay_task
2054 = GNUNET_SCHEDULER_add_delayed (timeout,
2055 &peer_transmit_timeout, th);
2056 schedule_transmission (handle);
2062 * Cancel the specified transmission-ready notification.
2065 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
2066 GNUNET_TRANSPORT_TransmitHandle
2069 struct NeighbourList *n;
2074 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2075 "Transmission request of %u bytes to `%4s' was canceled.\n",
2076 th->notify_size - sizeof (struct OutboundMessage),
2077 GNUNET_i2s (&n->id));
2079 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
2081 GNUNET_SCHEDULER_cancel (th->notify_delay_task);
2082 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
2084 switch (n->transmit_stage)
2090 n->transmit_stage = TS_NEW;
2091 if ( (n->in_disconnect == GNUNET_NO) &&
2092 (n->is_connected == GNUNET_NO) )
2095 case TS_TRANSMITTED:
2098 case TS_TRANSMITTED_QUEUED:
2099 n->transmit_stage = TS_TRANSMITTED;
2107 /* end of transport_api.c */