src/transport/transport_api.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file transport/transport_api.c
  23  * @brief library to access the low-level P2P IO service
  24  * @author Christian Grothoff
  25  *
  26  * TODO:
  27  * - adjust testcases to use new 'try connect' style (should be easy, breaks API compatibility!)
  28  * - adjust core service to use new 'try connect' style (should be MUCH nicer there as well!)
  29  * - test test test
  30  */
  31 #include "platform.h"
  32 #include "gnunet_constants.h"
  33 #include "gnunet_bandwidth_lib.h"
  34 #include "gnunet_client_lib.h"
  35 #include "gnunet_constants.h"
  36 #include "gnunet_container_lib.h"
  37 #include "gnunet_arm_service.h"
  38 #include "gnunet_hello_lib.h"
  39 #include "gnunet_protocols.h"
  40 #include "gnunet_server_lib.h"
  41 #include "gnunet_time_lib.h"
  42 #include "gnunet_transport_service.h"
  43 #include "transport.h"
  44
  45 #define LOG(kind,...) GNUNET_log_from (kind, "transport-api",__VA_ARGS__)
  46
  47 /**
  48  * How large to start with for the hashmap of neighbours.
  49  */
  50 #define STARTING_NEIGHBOURS_SIZE 16
  51
  52 /**
  53  * Handle for a message that should be transmitted to the service.
  54  * Used for both control messages and normal messages.
  55  */
  56 struct GNUNET_TRANSPORT_TransmitHandle
  57 {
  58
  59   /**
  60    * We keep all requests in a DLL.
  61    */
  62   struct GNUNET_TRANSPORT_TransmitHandle *next;
  63
  64   /**
  65    * We keep all requests in a DLL.
  66    */
  67   struct GNUNET_TRANSPORT_TransmitHandle *prev;
  68
  69   /**
  70    * Neighbour for this handle, NULL for control messages.
  71    */
  72   struct Neighbour *neighbour;
  73
  74   /**
  75    * Function to call when notify_size bytes are available
  76    * for transmission.
  77    */
  78   GNUNET_CONNECTION_TransmitReadyNotify notify;
  79
  80   /**
  81    * Closure for notify.
  82    */
  83   void *notify_cls;
  84
  85   /**
  86    * Timeout for this request, 0 for control messages.
  87    */
  88   struct GNUNET_TIME_Absolute timeout;
  89
  90   /**
  91    * Task to trigger request timeout if the request is stalled due to
  92    * congestion.
  93    */
  94   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
  95
  96   /**
  97    * How many bytes is our notify callback waiting for?
  98    */
  99   size_t notify_size;
 100
 101   /**
 102    * How important is this message? Not used for control messages.
 103    */
 104   uint32_t priority;
 105
 106 };
 107
 108
 109 /**
 110  * Entry in hash table of all of our current neighbours.
 111  */
 112 struct Neighbour
 113 {
 114   /**
 115    * Overall transport handle.
 116    */
 117   struct GNUNET_TRANSPORT_Handle *h;
 118
 119   /**
 120    * Active transmit handle or NULL.
 121    */
 122   struct GNUNET_TRANSPORT_TransmitHandle *th;
 123
 124   /**
 125    * Identity of this neighbour.
 126    */
 127   struct GNUNET_PeerIdentity id;
 128
 129   /**
 130    * Outbound bandwidh tracker.
 131    */
 132   struct GNUNET_BANDWIDTH_Tracker out_tracker;
 133
 134   /**
 135    * Entry in our readyness heap (which is sorted by 'next_ready'
 136    * value).  NULL if there is no pending transmission request for
 137    * this neighbour or if we're waiting for 'is_ready' to become
 138    * true AFTER the 'out_tracker' suggested that this peer's quota
 139    * has been satisfied (so once 'is_ready' goes to GNUNET_YES,
 140    * we should immediately go back into the heap).
 141    */
 142   struct GNUNET_CONTAINER_HeapNode *hn;
 143
 144   /**
 145    * Is this peer currently ready to receive a message?
 146    */
 147   int is_ready;
 148
 149   /**
 150    * Sending consumed more bytes on wire than payload was announced
 151    * This overhead is added to the delay of next sending operation
 152    */
 153   size_t traffic_overhead;
 154 };
 155
 156
 157 /**
 158  * Linked list of functions to call whenever our HELLO is updated.
 159  */
 160 struct GNUNET_TRANSPORT_GetHelloHandle
 161 {
 162
 163   /**
 164    * This is a doubly linked list.
 165    */
 166   struct GNUNET_TRANSPORT_GetHelloHandle *next;
 167
 168   /**
 169    * This is a doubly linked list.
 170    */
 171   struct GNUNET_TRANSPORT_GetHelloHandle *prev;
 172
 173   /**
 174    * Transport handle.
 175    */
 176   struct GNUNET_TRANSPORT_Handle *handle;
 177
 178   /**
 179    * Callback to call once we got our HELLO.
 180    */
 181   GNUNET_TRANSPORT_HelloUpdateCallback rec;
 182
 183   /**
 184    * Closure for rec.
 185    */
 186   void *rec_cls;
 187
 188 };
 189
 190
 191 /**
 192  * Handle for the transport service (includes all of the
 193  * state for the transport service).
 194  */
 195 struct GNUNET_TRANSPORT_Handle
 196 {
 197
 198   /**
 199    * Closure for the callbacks.
 200    */
 201   void *cls;
 202
 203   /**
 204    * Function to call for received data.
 205    */
 206   GNUNET_TRANSPORT_ReceiveCallback rec;
 207
 208   /**
 209    * function to call on connect events
 210    */
 211   GNUNET_TRANSPORT_NotifyConnect nc_cb;
 212
 213   /**
 214    * function to call on disconnect events
 215    */
 216   GNUNET_TRANSPORT_NotifyDisconnect nd_cb;
 217
 218   /**
 219    * Head of DLL of control messages.
 220    */
 221   struct GNUNET_TRANSPORT_TransmitHandle *control_head;
 222
 223   /**
 224    * Tail of DLL of control messages.
 225    */
 226   struct GNUNET_TRANSPORT_TransmitHandle *control_tail;
 227
 228   /**
 229    * The current HELLO message for this peer.  Updated
 230    * whenever transports change their addresses.
 231    */
 232   struct GNUNET_HELLO_Message *my_hello;
 233
 234   /**
 235    * My client connection to the transport service.
 236    */
 237   struct GNUNET_CLIENT_Connection *client;
 238
 239   /**
 240    * Handle to our registration with the client for notification.
 241    */
 242   struct GNUNET_CLIENT_TransmitHandle *cth;
 243
 244   /**
 245    * Linked list of pending requests for our HELLO.
 246    */
 247   struct GNUNET_TRANSPORT_GetHelloHandle *hwl_head;
 248
 249   /**
 250    * Linked list of pending requests for our HELLO.
 251    */
 252   struct GNUNET_TRANSPORT_GetHelloHandle *hwl_tail;
 253
 254   /**
 255    * My configuration.
 256    */
 257   const struct GNUNET_CONFIGURATION_Handle *cfg;
 258
 259   /**
 260    * Hash map of the current connected neighbours of this peer.
 261    * Maps peer identities to 'struct Neighbour' entries.
 262    */
 263   struct GNUNET_CONTAINER_MultiHashMap *neighbours;
 264
 265   /**
 266    * Heap sorting peers with pending messages by the timestamps that
 267    * specify when we could next send a message to the respective peer.
 268    * Excludes control messages (which can always go out immediately).
 269    * Maps time stamps to 'struct Neighbour' entries.
 270    */
 271   struct GNUNET_CONTAINER_Heap *ready_heap;
 272
 273   /**
 274    * Peer identity as assumed by this process, or all zeros.
 275    */
 276   struct GNUNET_PeerIdentity self;
 277
 278   /**
 279    * ID of the task trying to reconnect to the service.
 280    */
 281   GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
 282
 283   /**
 284    * ID of the task trying to trigger transmission for a peer while
 285    * maintaining bandwidth quotas.  In use if there are no control
 286    * messages and the smallest entry in the 'ready_heap' has a time
 287    * stamp in the future.
 288    */
 289   GNUNET_SCHEDULER_TaskIdentifier quota_task;
 290
 291   /**
 292    * Delay until we try to reconnect.
 293    */
 294   struct GNUNET_TIME_Relative reconnect_delay;
 295
 296   /**
 297    * Should we check that 'self' matches what the service thinks?
 298    * (if GNUNET_NO, then 'self' is all zeros!).
 299    */
 300   int check_self;
 301 };
 302
 303
 304 /**
 305  * Schedule the task to send one message, either from the control
 306  * list or the peer message queues  to the service.
 307  *
 308  * @param h transport service to schedule a transmission for
 309  */
 310 static void
 311 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h);
 312
 313
 314 /**
 315  * Function that will schedule the job that will try
 316  * to connect us again to the client.
 317  *
 318  * @param h transport service to reconnect
 319  */
 320 static void
 321 disconnect_and_schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h);
 322
 323
 324 /**
 325  * Get the neighbour list entry for the given peer
 326  *
 327  * @param h our context
 328  * @param peer peer to look up
 329  * @return NULL if no such peer entry exists
 330  */
 331 static struct Neighbour *
 332 neighbour_find (struct GNUNET_TRANSPORT_Handle *h,
 333                 const struct GNUNET_PeerIdentity *peer)
 334 {
 335   return GNUNET_CONTAINER_multihashmap_get (h->neighbours, &peer->hashPubKey);
 336 }
 337
 338
 339 /**
 340  * Add neighbour to our list
 341  *
 342  * @return NULL if this API is currently disconnecting from the service
 343  */
 344 static struct Neighbour *
 345 neighbour_add (struct GNUNET_TRANSPORT_Handle *h,
 346                const struct GNUNET_PeerIdentity *pid)
 347 {
 348   struct Neighbour *n;
 349
 350   LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating entry for neighbour `%4s'.\n",
 351        GNUNET_i2s (pid));
 352   n = GNUNET_malloc (sizeof (struct Neighbour));
 353   n->id = *pid;
 354   n->h = h;
 355   n->is_ready = GNUNET_YES;
 356   n->traffic_overhead = 0;
 357   GNUNET_BANDWIDTH_tracker_init (&n->out_tracker,
 358                                  GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
 359                                  MAX_BANDWIDTH_CARRY_S);
 360   GNUNET_assert (GNUNET_OK ==
 361                  GNUNET_CONTAINER_multihashmap_put (h->neighbours,
 362                                                     &n->id.hashPubKey, n,
 363                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 364   return n;
 365 }
 366
 367
 368 /**
 369  * Iterator over hash map entries, for deleting state of a neighbour.
 370  *
 371  * @param cls the 'struct GNUNET_TRANSPORT_Handle*'
 372  * @param key peer identity
 373  * @param value value in the hash map, the neighbour entry to delete
 374  * @return GNUNET_YES if we should continue to
 375  *         iterate,
 376  *         GNUNET_NO if not.
 377  */
 378 static int
 379 neighbour_delete (void *cls, const struct GNUNET_HashCode * key, void *value)
 380 {
 381   struct GNUNET_TRANSPORT_Handle *handle = cls;
 382   struct Neighbour *n = value;
 383
 384   if (NULL != handle->nd_cb)
 385     handle->nd_cb (handle->cls, &n->id);
 386   GNUNET_assert (NULL == n->th);
 387   GNUNET_assert (NULL == n->hn);
 388   GNUNET_assert (GNUNET_YES ==
 389                  GNUNET_CONTAINER_multihashmap_remove (handle->neighbours, key,
 390                                                        n));
 391   GNUNET_free (n);
 392   return GNUNET_YES;
 393 }
 394
 395
 396 /**
 397  * Function we use for handling incoming messages.
 398  *
 399  * @param cls closure (struct GNUNET_TRANSPORT_Handle *)
 400  * @param msg message received, NULL on timeout or fatal error
 401  */
 402 static void
 403 demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
 404 {
 405   struct GNUNET_TRANSPORT_Handle *h = cls;
 406   const struct DisconnectInfoMessage *dim;
 407   const struct ConnectInfoMessage *cim;
 408   const struct InboundMessage *im;
 409   const struct GNUNET_MessageHeader *imm;
 410   const struct SendOkMessage *okm;
 411   const struct QuotaSetMessage *qm;
 412   const struct GNUNET_ATS_Information *ats;
 413   struct GNUNET_TRANSPORT_GetHelloHandle *hwl;
 414   struct GNUNET_TRANSPORT_GetHelloHandle *next_hwl;
 415   struct Neighbour *n;
 416   struct GNUNET_PeerIdentity me;
 417   uint16_t size;
 418   uint32_t ats_count;
 419   uint32_t bytes_msg;
 420   uint32_t bytes_physical;
 421
 422   GNUNET_assert (h->client != NULL);
 423   if (msg == NULL)
 424   {
 425     LOG (GNUNET_ERROR_TYPE_DEBUG,
 426          "Error receiving from transport service, disconnecting temporarily.\n");
 427     disconnect_and_schedule_reconnect (h);
 428     return;
 429   }
 430   GNUNET_CLIENT_receive (h->client, &demultiplexer, h,
 431                          GNUNET_TIME_UNIT_FOREVER_REL);
 432   size = ntohs (msg->size);
 433   switch (ntohs (msg->type))
 434   {
 435   case GNUNET_MESSAGE_TYPE_HELLO:
 436     if (GNUNET_OK !=
 437         GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) msg, &me))
 438     {
 439       GNUNET_break (0);
 440       break;
 441     }
 442     LOG (GNUNET_ERROR_TYPE_DEBUG,
 443          "Receiving (my own) `%s' message, I am `%4s'.\n", "HELLO",
 444          GNUNET_i2s (&me));
 445     GNUNET_free_non_null (h->my_hello);
 446     h->my_hello = NULL;
 447     if (size < sizeof (struct GNUNET_MessageHeader))
 448     {
 449       GNUNET_break (0);
 450       break;
 451     }
 452     h->my_hello = GNUNET_malloc (size);
 453     memcpy (h->my_hello, msg, size);
 454     hwl = h->hwl_head;
 455     while (NULL != hwl)
 456     {
 457       next_hwl = hwl->next;
 458       hwl->rec (hwl->rec_cls,
 459                 (const struct GNUNET_MessageHeader *) h->my_hello);
 460       hwl = next_hwl;
 461     }
 462     break;
 463   case GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT:
 464     if (size < sizeof (struct ConnectInfoMessage))
 465     {
 466       GNUNET_break (0);
 467       break;
 468     }
 469     cim = (const struct ConnectInfoMessage *) msg;
 470     ats_count = ntohl (cim->ats_count);
 471     if (size !=
 472         sizeof (struct ConnectInfoMessage) +
 473         ats_count * sizeof (struct GNUNET_ATS_Information))
 474     {
 475       GNUNET_break (0);
 476       break;
 477     }
 478     ats = (const struct GNUNET_ATS_Information *) &cim[1];
 479     LOG (GNUNET_ERROR_TYPE_DEBUG, "Receiving `%s' message for `%4s'.\n",
 480          "CONNECT", GNUNET_i2s (&cim->id));
 481     n = neighbour_find (h, &cim->id);
 482     if (n != NULL)
 483     {
 484       GNUNET_break (0);
 485       break;
 486     }
 487     n = neighbour_add (h, &cim->id);
 488     LOG (GNUNET_ERROR_TYPE_DEBUG, "Receiving `%s' message for `%4s' with quota %u\n",
 489          "CONNECT", GNUNET_i2s (&cim->id), ntohl (cim->quota_out.value__));
 490     GNUNET_BANDWIDTH_tracker_update_quota (&n->out_tracker, cim->quota_out);
 491     if (h->nc_cb != NULL)
 492       h->nc_cb (h->cls, &n->id, ats, ats_count);
 493     break;
 494   case GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT:
 495     if (size != sizeof (struct DisconnectInfoMessage))
 496     {
 497       GNUNET_break (0);
 498       break;
 499     }
 500     dim = (const struct DisconnectInfoMessage *) msg;
 501     GNUNET_break (ntohl (dim->reserved) == 0);
 502     LOG (GNUNET_ERROR_TYPE_DEBUG, "Receiving `%s' message for `%4s'.\n",
 503          "DISCONNECT", GNUNET_i2s (&dim->peer));
 504     n = neighbour_find (h, &dim->peer);
 505     if (n == NULL)
 506     {
 507       GNUNET_break (0);
 508       break;
 509     }
 510     neighbour_delete (h, &dim->peer.hashPubKey, n);
 511     break;
 512   case GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK:
 513     if (size != sizeof (struct SendOkMessage))
 514     {
 515       GNUNET_break (0);
 516       break;
 517     }
 518     okm = (const struct SendOkMessage *) msg;
 519     bytes_msg = ntohl (okm->bytes_msg);
 520     bytes_physical = ntohl (okm->bytes_physical);
 521     LOG (GNUNET_ERROR_TYPE_DEBUG, "Receiving `%s' message, transmission %s.\n",
 522          "SEND_OK", ntohl (okm->success) == GNUNET_OK ? "succeeded" : "failed");
 523
 524     n = neighbour_find (h, &okm->peer);
 525     if (n == NULL)
 526       break;
 527
 528     if (bytes_physical >= bytes_msg)
 529     {
 530         LOG (GNUNET_ERROR_TYPE_DEBUG, "Overhead for %u byte message: %u \n",
 531             bytes_msg, bytes_physical - bytes_msg);
 532       n->traffic_overhead += bytes_physical - bytes_msg;
 533     }
 534     GNUNET_break (GNUNET_NO == n->is_ready);
 535     n->is_ready = GNUNET_YES;
 536     if ((n->th != NULL) && (n->hn == NULL))
 537     {
 538       GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != n->th->timeout_task);
 539       GNUNET_SCHEDULER_cancel (n->th->timeout_task);
 540       n->th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 541       /* we've been waiting for this (congestion, not quota,
 542        * caused delayed transmission) */
 543       n->hn = GNUNET_CONTAINER_heap_insert (h->ready_heap, n, 0);
 544       schedule_transmission (h);
 545     }
 546     break;
 547   case GNUNET_MESSAGE_TYPE_TRANSPORT_RECV:
 548     LOG (GNUNET_ERROR_TYPE_DEBUG, "Receiving `%s' message.\n", "RECV");
 549     if (size <
 550         sizeof (struct InboundMessage) + sizeof (struct GNUNET_MessageHeader))
 551     {
 552       GNUNET_break (0);
 553       break;
 554     }
 555     im = (const struct InboundMessage *) msg;
 556     ats_count = ntohl (im->ats_count);
 557     ats = (const struct GNUNET_ATS_Information *) &im[1];
 558     imm = (const struct GNUNET_MessageHeader *) &ats[ats_count];
 559     if (ntohs (imm->size) + sizeof (struct InboundMessage) +
 560         ats_count * sizeof (struct GNUNET_ATS_Information) != size)
 561     {
 562       GNUNET_break (0);
 563       break;
 564     }
 565     LOG (GNUNET_ERROR_TYPE_DEBUG, "Received message of type %u from `%4s'.\n",
 566          ntohs (imm->type), GNUNET_i2s (&im->peer));
 567     n = neighbour_find (h, &im->peer);
 568     if (n == NULL)
 569     {
 570       GNUNET_break (0);
 571       break;
 572     }
 573     if (h->rec != NULL)
 574       h->rec (h->cls, &im->peer, imm, ats, ats_count);
 575     break;
 576   case GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA:
 577     LOG (GNUNET_ERROR_TYPE_DEBUG, "Receiving `%s' message.\n", "SET_QUOTA");
 578     if (size != sizeof (struct QuotaSetMessage))
 579     {
 580       GNUNET_break (0);
 581       break;
 582     }
 583     qm = (const struct QuotaSetMessage *) msg;
 584     n = neighbour_find (h, &qm->peer);
 585     if (n == NULL)
 586       break;
 587     LOG (GNUNET_ERROR_TYPE_DEBUG, "Receiving `%s' message for `%4s' with quota %u\n",
 588          "SET_QUOTA", GNUNET_i2s (&qm->peer), ntohl (qm->quota.value__));
 589     GNUNET_BANDWIDTH_tracker_update_quota (&n->out_tracker, qm->quota);
 590     break;
 591   default:
 592     LOG (GNUNET_ERROR_TYPE_ERROR,
 593          _("Received unexpected message of type %u in %s:%u\n"),
 594          ntohs (msg->type), __FILE__, __LINE__);
 595     GNUNET_break (0);
 596     break;
 597   }
 598 }
 599
 600
 601 /**
 602  * A transmission request could not be satisfied because of
 603  * network congestion.  Notify the initiator and clean up.
 604  *
 605  * @param cls the 'struct GNUNET_TRANSPORT_TransmitHandle'
 606  * @param tc scheduler context
 607  */
 608 static void
 609 timeout_request_due_to_congestion (void *cls,
 610                                    const struct GNUNET_SCHEDULER_TaskContext
 611                                    *tc)
 612 {
 613   struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
 614   struct Neighbour *n = th->neighbour;
 615
 616   n->th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 617   GNUNET_assert (th == n->th);
 618   GNUNET_assert (NULL == n->hn);
 619   n->th = NULL;
 620   th->notify (th->notify_cls, 0, NULL);
 621   GNUNET_free (th);
 622 }
 623
 624
 625 /**
 626  * Transmit message(s) to service.
 627  *
 628  * @param cls handle to transport
 629  * @param size number of bytes available in buf
 630  * @param buf where to copy the message
 631  * @return number of bytes copied to buf
 632  */
 633 static size_t
 634 transport_notify_ready (void *cls, size_t size, void *buf)
 635 {
 636   struct GNUNET_TRANSPORT_Handle *h = cls;
 637   struct GNUNET_TRANSPORT_TransmitHandle *th;
 638   struct Neighbour *n;
 639   char *cbuf;
 640   struct OutboundMessage obm;
 641   size_t ret;
 642   size_t nret;
 643   size_t mret;
 644
 645   GNUNET_assert (NULL != h->client);
 646   h->cth = NULL;
 647   if (NULL == buf)
 648   {
 649     /* transmission failed */
 650     disconnect_and_schedule_reconnect (h);
 651     return 0;
 652   }
 653
 654   cbuf = buf;
 655   ret = 0;
 656   /* first send control messages */
 657   while ((NULL != (th = h->control_head)) && (th->notify_size <= size))
 658   {
 659     GNUNET_CONTAINER_DLL_remove (h->control_head, h->control_tail, th);
 660     nret = th->notify (th->notify_cls, size, &cbuf[ret]);
 661     LOG (GNUNET_ERROR_TYPE_DEBUG, "Added %u bytes of control message at %u\n",
 662          nret, ret);
 663     GNUNET_free (th);
 664     ret += nret;
 665     size -= nret;
 666   }
 667
 668   /* then, if possible and no control messages pending, send data messages */
 669   while ((NULL == h->control_head) &&
 670          (NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap))))
 671   {
 672     if (GNUNET_YES != n->is_ready)
 673     {
 674       /* peer not ready, wait for notification! */
 675       GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
 676       n->hn = NULL;
 677       GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == n->th->timeout_task);
 678       n->th->timeout_task =
 679           GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
 680                                         (n->th->timeout),
 681                                         &timeout_request_due_to_congestion,
 682                                         n->th);
 683       continue;
 684     }
 685     th = n->th;
 686     if (th->notify_size + sizeof (struct OutboundMessage) > size)
 687       break;                    /* does not fit */
 688     if (GNUNET_BANDWIDTH_tracker_get_delay
 689         (&n->out_tracker, th->notify_size).rel_value > 0)
 690       break;                    /* too early */
 691     GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
 692     n->hn = NULL;
 693     n->th = NULL;
 694     n->is_ready = GNUNET_NO;
 695     GNUNET_assert (size >= sizeof (struct OutboundMessage));
 696     mret =
 697         th->notify (th->notify_cls, size - sizeof (struct OutboundMessage),
 698                     &cbuf[ret + sizeof (struct OutboundMessage)]);
 699     GNUNET_assert (mret <= size - sizeof (struct OutboundMessage));
 700     if (mret != 0)
 701     {
 702       GNUNET_assert (mret + sizeof (struct OutboundMessage) <
 703                      GNUNET_SERVER_MAX_MESSAGE_SIZE);
 704       obm.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND);
 705       obm.header.size = htons (mret + sizeof (struct OutboundMessage));
 706       obm.priority = htonl (th->priority);
 707       obm.timeout =
 708           GNUNET_TIME_relative_hton (GNUNET_TIME_absolute_get_remaining
 709                                      (th->timeout));
 710       obm.peer = n->id;
 711       memcpy (&cbuf[ret], &obm, sizeof (struct OutboundMessage));
 712       ret += (mret + sizeof (struct OutboundMessage));
 713       size -= (mret + sizeof (struct OutboundMessage));
 714       GNUNET_BANDWIDTH_tracker_consume (&n->out_tracker, mret);
 715     }
 716     GNUNET_free (th);
 717   }
 718   /* if there are more pending messages, try to schedule those */
 719   schedule_transmission (h);
 720   LOG (GNUNET_ERROR_TYPE_DEBUG, "Transmitting %u bytes to transport service\n",
 721        ret);
 722   return ret;
 723 }
 724
 725
 726 /**
 727  * Schedule the task to send one message, either from the control
 728  * list or the peer message queues  to the service.
 729  *
 730  * @param cls transport service to schedule a transmission for
 731  * @param tc scheduler context
 732  */
 733 static void
 734 schedule_transmission_task (void *cls,
 735                             const struct GNUNET_SCHEDULER_TaskContext *tc)
 736 {
 737   struct GNUNET_TRANSPORT_Handle *h = cls;
 738   size_t size;
 739   struct GNUNET_TRANSPORT_TransmitHandle *th;
 740   struct Neighbour *n;
 741
 742   h->quota_task = GNUNET_SCHEDULER_NO_TASK;
 743   GNUNET_assert (NULL != h->client);
 744   /* destroy all requests that have timed out */
 745   while ((NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap))) &&
 746          (GNUNET_TIME_absolute_get_remaining (n->th->timeout).rel_value == 0))
 747   {
 748     /* notify client that the request could not be satisfied within
 749      * the given time constraints */
 750     th = n->th;
 751     n->th = NULL;
 752     GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
 753     n->hn = NULL;
 754     LOG (GNUNET_ERROR_TYPE_DEBUG,
 755          "Signalling timeout for transmission to peer %s due to congestion\n",
 756          GNUNET_i2s (&n->id));
 757     GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
 758     GNUNET_free (th);
 759   }
 760   if (NULL != h->cth)
 761     return;
 762   if (NULL != h->control_head)
 763   {
 764     size = h->control_head->notify_size;
 765   }
 766   else
 767   {
 768     n = GNUNET_CONTAINER_heap_peek (h->ready_heap);
 769     if (NULL == n)
 770       return;                   /* no pending messages */
 771     size = n->th->notify_size + sizeof (struct OutboundMessage);
 772   }
 773   LOG (GNUNET_ERROR_TYPE_DEBUG, "Calling notify_transmit_ready\n");
 774   h->cth =
 775       GNUNET_CLIENT_notify_transmit_ready (h->client, size,
 776                                            GNUNET_TIME_UNIT_FOREVER_REL,
 777                                            GNUNET_NO, &transport_notify_ready,
 778                                            h);
 779   GNUNET_assert (NULL != h->cth);
 780 }
 781
 782
 783 /**
 784  * Schedule the task to send one message, either from the control
 785  * list or the peer message queues  to the service.
 786  *
 787  * @param h transport service to schedule a transmission for
 788  */
 789 static void
 790 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
 791 {
 792   struct GNUNET_TIME_Relative delay;
 793   struct Neighbour *n;
 794
 795   GNUNET_assert (NULL != h->client);
 796   if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
 797   {
 798     GNUNET_SCHEDULER_cancel (h->quota_task);
 799     h->quota_task = GNUNET_SCHEDULER_NO_TASK;
 800   }
 801   if (NULL != h->control_head)
 802     delay = GNUNET_TIME_UNIT_ZERO;
 803   else if (NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap)))
 804   {
 805     delay =
 806         GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker,
 807                                             n->th->notify_size + n->traffic_overhead);
 808     n->traffic_overhead = 0;
 809   }
 810   else
 811     return;                     /* no work to be done */
 812   LOG (GNUNET_ERROR_TYPE_DEBUG,
 813        "Scheduling next transmission to service in %llu ms\n",
 814        (unsigned long long) delay.rel_value);
 815   h->quota_task =
 816       GNUNET_SCHEDULER_add_delayed (delay, &schedule_transmission_task, h);
 817 }
 818
 819
 820 /**
 821  * Queue control request for transmission to the transport
 822  * service.
 823  *
 824  * @param h handle to the transport service
 825  * @param size number of bytes to be transmitted
 826  * @param notify function to call to get the content
 827  * @param notify_cls closure for notify
 828  */
 829 static void
 830 schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h, size_t size,
 831                            GNUNET_CONNECTION_TransmitReadyNotify notify,
 832                            void *notify_cls)
 833 {
 834   struct GNUNET_TRANSPORT_TransmitHandle *th;
 835
 836   LOG (GNUNET_ERROR_TYPE_DEBUG, "Control transmit of %u bytes requested\n",
 837        size);
 838   th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
 839   th->notify = notify;
 840   th->notify_cls = notify_cls;
 841   th->notify_size = size;
 842   GNUNET_CONTAINER_DLL_insert_tail (h->control_head, h->control_tail, th);
 843   schedule_transmission (h);
 844 }
 845
 846
 847 /**
 848  * Transmit START message to service.
 849  *
 850  * @param cls unused
 851  * @param size number of bytes available in buf
 852  * @param buf where to copy the message
 853  * @return number of bytes copied to buf
 854  */
 855 static size_t
 856 send_start (void *cls, size_t size, void *buf)
 857 {
 858   struct GNUNET_TRANSPORT_Handle *h = cls;
 859   struct StartMessage s;
 860   uint32_t options;
 861
 862   if (buf == NULL)
 863   {
 864     /* Can only be shutdown, just give up */
 865     LOG (GNUNET_ERROR_TYPE_DEBUG,
 866          "Shutdown while trying to transmit `%s' request.\n", "START");
 867     return 0;
 868   }
 869   LOG (GNUNET_ERROR_TYPE_DEBUG, "Transmitting `%s' request.\n", "START");
 870   GNUNET_assert (size >= sizeof (struct StartMessage));
 871   s.header.size = htons (sizeof (struct StartMessage));
 872   s.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_START);
 873   options = 0;
 874   if (h->check_self)
 875     options |= 1;
 876   if (h->rec != NULL)
 877     options |= 2;
 878   s.options = htonl (options);
 879   s.self = h->self;
 880   memcpy (buf, &s, sizeof (struct StartMessage));
 881   GNUNET_CLIENT_receive (h->client, &demultiplexer, h,
 882                          GNUNET_TIME_UNIT_FOREVER_REL);
 883   return sizeof (struct StartMessage);
 884 }
 885
 886
 887 /**
 888  * Try again to connect to transport service.
 889  *
 890  * @param cls the handle to the transport service
 891  * @param tc scheduler context
 892  */
 893 static void
 894 reconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 895 {
 896   struct GNUNET_TRANSPORT_Handle *h = cls;
 897
 898   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
 899   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 900   {
 901     /* shutdown, just give up */
 902     return;
 903   }
 904   LOG (GNUNET_ERROR_TYPE_DEBUG, "Connecting to transport service.\n");
 905   GNUNET_assert (h->client == NULL);
 906   GNUNET_assert (h->control_head == NULL);
 907   GNUNET_assert (h->control_tail == NULL);
 908   h->client = GNUNET_CLIENT_connect ("transport", h->cfg);
 909   GNUNET_assert (h->client != NULL);
 910   schedule_control_transmit (h, sizeof (struct StartMessage), &send_start, h);
 911 }
 912
 913
 914 /**
 915  * Function that will schedule the job that will try
 916  * to connect us again to the client.
 917  *
 918  * @param h transport service to reconnect
 919  */
 920 static void
 921 disconnect_and_schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
 922 {
 923   struct GNUNET_TRANSPORT_TransmitHandle *th;
 924
 925   GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
 926   if (NULL != h->cth)
 927   {
 928     GNUNET_CLIENT_notify_transmit_ready_cancel (h->cth);
 929     h->cth = NULL;
 930   }
 931   if (NULL != h->client)
 932   {
 933     GNUNET_CLIENT_disconnect (h->client);
 934     h->client = NULL;
 935   }
 936   /* Forget about all neighbours that we used to be connected to */
 937   GNUNET_CONTAINER_multihashmap_iterate (h->neighbours, &neighbour_delete, h);
 938   if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
 939   {
 940     GNUNET_SCHEDULER_cancel (h->quota_task);
 941     h->quota_task = GNUNET_SCHEDULER_NO_TASK;
 942   }
 943   while ((NULL != (th = h->control_head)))
 944   {
 945     GNUNET_CONTAINER_DLL_remove (h->control_head, h->control_tail, th);
 946     th->notify (th->notify_cls, 0, NULL);
 947     GNUNET_free (th);
 948   }
 949   LOG (GNUNET_ERROR_TYPE_DEBUG,
 950        "Scheduling task to reconnect to transport service in %llu ms.\n",
 951        h->reconnect_delay.rel_value);
 952   h->reconnect_task =
 953       GNUNET_SCHEDULER_add_delayed (h->reconnect_delay, &reconnect, h);
 954   h->reconnect_delay = GNUNET_TIME_STD_BACKOFF (h->reconnect_delay);
 955 }
 956
 957
 958 /**
 959  * Send REQUEST_CONNECT message to the service.
 960  *
 961  * @param cls the 'struct GNUNET_PeerIdentity'
 962  * @param size number of bytes available in buf
 963  * @param buf where to copy the message
 964  * @return number of bytes copied to buf
 965  */
 966 static size_t
 967 send_try_connect (void *cls, size_t size, void *buf)
 968 {
 969   struct GNUNET_PeerIdentity *pid = cls;
 970   struct TransportRequestConnectMessage msg;
 971
 972   if (buf == NULL)
 973   {
 974     GNUNET_free (pid);
 975     return 0;
 976   }
 977   LOG (GNUNET_ERROR_TYPE_DEBUG,
 978        "Transmitting `%s' request with respect to `%4s'.\n", "REQUEST_CONNECT",
 979        GNUNET_i2s (pid));
 980   GNUNET_assert (size >= sizeof (struct TransportRequestConnectMessage));
 981   msg.header.size = htons (sizeof (struct TransportRequestConnectMessage));
 982   msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT);
 983   msg.reserved = htonl (0);
 984   msg.peer = *pid;
 985   memcpy (buf, &msg, sizeof (msg));
 986   GNUNET_free (pid);
 987   return sizeof (struct TransportRequestConnectMessage);
 988 }
 989
 990
 991 /**
 992  * Ask the transport service to establish a connection to
 993  * the given peer.
 994  *
 995  * @param handle connection to transport service
 996  * @param target who we should try to connect to
 997  */
 998 void
 999 GNUNET_TRANSPORT_try_connect (struct GNUNET_TRANSPORT_Handle *handle,
1000                               const struct GNUNET_PeerIdentity *target)
1001 {
1002   struct GNUNET_PeerIdentity *pid;
1003   if (NULL == handle->client)
1004   {
1005       /* FIXME: handle->client can be NULL when transport api is reconnecting */
1006       GNUNET_break (0);
1007       return;
1008   }
1009
1010   pid = GNUNET_malloc (sizeof (struct GNUNET_PeerIdentity));
1011   *pid = *target;
1012   schedule_control_transmit (handle,
1013                              sizeof (struct TransportRequestConnectMessage),
1014                              &send_try_connect, pid);
1015 }
1016
1017
1018 struct SendHelloContext
1019 {
1020         GNUNET_SCHEDULER_Task cont;
1021
1022         void *cls;
1023
1024         struct GNUNET_MessageHeader *msg;
1025 };
1026
1027 /**
1028  * Send HELLO message to the service.
1029  *
1030  * @param cls the HELLO message to send
1031  * @param size number of bytes available in buf
1032  * @param buf where to copy the message
1033  * @return number of bytes copied to buf
1034  */
1035 static size_t
1036 send_hello (void *cls, size_t size, void *buf)
1037 {
1038   struct SendHelloContext *shc = cls;
1039   struct GNUNET_MessageHeader *msg = shc->msg;
1040   uint16_t ssize;
1041   struct GNUNET_SCHEDULER_TaskContext tc;
1042   tc.read_ready = NULL;
1043   tc.write_ready = NULL;
1044   tc.reason = GNUNET_SCHEDULER_REASON_TIMEOUT;
1045
1046   if (buf == NULL)
1047   {
1048     LOG (GNUNET_ERROR_TYPE_DEBUG,
1049          "Timeout while trying to transmit `%s' request.\n", "HELLO");
1050     if (NULL != shc->cont)
1051       shc->cont (shc->cls, &tc);
1052     GNUNET_free (msg);
1053     GNUNET_free (shc);
1054     return 0;
1055   }
1056   LOG (GNUNET_ERROR_TYPE_DEBUG, "Transmitting `%s' request.\n", "HELLO");
1057   ssize = ntohs (msg->size);
1058   GNUNET_assert (size >= ssize);
1059   memcpy (buf, msg, ssize);
1060   GNUNET_free (msg);
1061   tc.reason = GNUNET_SCHEDULER_REASON_READ_READY;
1062   if (NULL != shc->cont)
1063     shc->cont (shc->cls, &tc);
1064   GNUNET_free (shc);
1065   return ssize;
1066 }
1067
1068
1069 /**
1070  * Offer the transport service the HELLO of another peer.  Note that
1071  * the transport service may just ignore this message if the HELLO is
1072  * malformed or useless due to our local configuration.
1073  *
1074  * @param handle connection to transport service
1075  * @param hello the hello message
1076  * @param cont continuation to call when HELLO has been sent,
1077  *      tc reason GNUNET_SCHEDULER_REASON_TIMEOUT for fail
1078  *      tc reasong GNUNET_SCHEDULER_REASON_READY for success
1079  * @param cls closure for continuation
1080  *
1081  */
1082 void
1083 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
1084                               const struct GNUNET_MessageHeader *hello,
1085                               GNUNET_SCHEDULER_Task cont, void *cls)
1086 {
1087   uint16_t size;
1088   struct GNUNET_PeerIdentity peer;
1089   struct GNUNET_MessageHeader *msg;
1090   struct SendHelloContext * shc;
1091   struct GNUNET_SCHEDULER_TaskContext tc;
1092
1093   tc.read_ready = NULL;
1094   tc.write_ready = NULL;
1095   tc.reason = GNUNET_SCHEDULER_REASON_TIMEOUT;
1096
1097   if (NULL == handle->client)
1098   {
1099     if (NULL != cont)
1100       cont (cls, &tc);
1101     return;
1102   }
1103   GNUNET_break (ntohs (hello->type) == GNUNET_MESSAGE_TYPE_HELLO);
1104   size = ntohs (hello->size);
1105   GNUNET_break (size >= sizeof (struct GNUNET_MessageHeader));
1106   if (GNUNET_OK !=
1107       GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) hello, &peer))
1108   {
1109     GNUNET_break (0);
1110     if (NULL != cont)
1111       if (NULL != cont)
1112         cont (cls, &tc);
1113     return;
1114   }
1115   msg = GNUNET_malloc (size);
1116   memcpy (msg, hello, size);
1117   LOG (GNUNET_ERROR_TYPE_DEBUG,
1118        "Offering `%s' message of `%4s' to transport for validation.\n", "HELLO",
1119        GNUNET_i2s (&peer));
1120   shc = GNUNET_malloc (sizeof (struct SendHelloContext));
1121   shc->msg = msg;
1122   shc->cont = cont;
1123   shc->cls = cls;
1124   schedule_control_transmit (handle, size, &send_hello, shc);
1125 }
1126
1127
1128 /**
1129  * Obtain the HELLO message for this peer.
1130  *
1131  * @param handle connection to transport service
1132  * @param rec function to call with the HELLO, sender will be our peer
1133  *            identity; message and sender will be NULL on timeout
1134  *            (handshake with transport service pending/failed).
1135  *             cost estimate will be 0.
1136  * @param rec_cls closure for rec
1137  * @return handle to cancel the operation
1138  */
1139 struct GNUNET_TRANSPORT_GetHelloHandle *
1140 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
1141                             GNUNET_TRANSPORT_HelloUpdateCallback rec,
1142                             void *rec_cls)
1143 {
1144   struct GNUNET_TRANSPORT_GetHelloHandle *hwl;
1145
1146   hwl = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_GetHelloHandle));
1147   hwl->rec = rec;
1148   hwl->rec_cls = rec_cls;
1149   hwl->handle = handle;
1150   GNUNET_CONTAINER_DLL_insert (handle->hwl_head, handle->hwl_tail, hwl);
1151   if (handle->my_hello != NULL)
1152     rec (rec_cls, (const struct GNUNET_MessageHeader *) handle->my_hello);
1153   return hwl;
1154 }
1155
1156
1157 /**
1158  * Stop receiving updates about changes to our HELLO message.
1159  *
1160  * @param ghh handle to cancel
1161  */
1162 void
1163 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_GetHelloHandle *ghh)
1164 {
1165   struct GNUNET_TRANSPORT_Handle *handle = ghh->handle;
1166
1167   GNUNET_CONTAINER_DLL_remove (handle->hwl_head, handle->hwl_tail, ghh);
1168   GNUNET_free (ghh);
1169 }
1170
1171
1172 /**
1173  * Connect to the transport service.  Note that the connection may
1174  * complete (or fail) asynchronously.
1175  *
1176  * @param cfg configuration to use
1177  * @param self our own identity (API should check that it matches
1178  *             the identity found by transport), or NULL (no check)
1179  * @param cls closure for the callbacks
1180  * @param rec receive function to call
1181  * @param nc function to call on connect events
1182  * @param nd function to call on disconnect events
1183  */
1184 struct GNUNET_TRANSPORT_Handle *
1185 GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1186                           const struct GNUNET_PeerIdentity *self, void *cls,
1187                           GNUNET_TRANSPORT_ReceiveCallback rec,
1188                           GNUNET_TRANSPORT_NotifyConnect nc,
1189                           GNUNET_TRANSPORT_NotifyDisconnect nd)
1190 {
1191   struct GNUNET_TRANSPORT_Handle *ret;
1192
1193   ret = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_Handle));
1194   if (self != NULL)
1195   {
1196     ret->self = *self;
1197     ret->check_self = GNUNET_YES;
1198   }
1199   ret->cfg = cfg;
1200   ret->cls = cls;
1201   ret->rec = rec;
1202   ret->nc_cb = nc;
1203   ret->nd_cb = nd;
1204   ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
1205   ret->neighbours =
1206     GNUNET_CONTAINER_multihashmap_create (STARTING_NEIGHBOURS_SIZE, GNUNET_YES);
1207   ret->ready_heap =
1208       GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1209   LOG (GNUNET_ERROR_TYPE_DEBUG, "Connecting to transport service.\n");
1210   ret->client = GNUNET_CLIENT_connect ("transport", cfg);
1211   if (ret->client == NULL)
1212   {
1213     GNUNET_free (ret);
1214     return NULL;
1215   }
1216   schedule_control_transmit (ret, sizeof (struct StartMessage), &send_start, ret);
1217   return ret;
1218 }
1219
1220
1221 /**
1222  * Disconnect from the transport service.
1223  *
1224  * @param handle handle to the service as returned from GNUNET_TRANSPORT_connect
1225  */
1226 void
1227 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
1228 {
1229   LOG (GNUNET_ERROR_TYPE_DEBUG, "Transport disconnect called!\n");
1230   /* this disconnects all neighbours... */
1231   if (handle->reconnect_task == GNUNET_SCHEDULER_NO_TASK)
1232     disconnect_and_schedule_reconnect (handle);
1233   /* and now we stop trying to connect again... */
1234   if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1235   {
1236     GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1237     handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1238   }
1239   GNUNET_CONTAINER_multihashmap_destroy (handle->neighbours);
1240   handle->neighbours = NULL;
1241   if (handle->quota_task != GNUNET_SCHEDULER_NO_TASK)
1242   {
1243     GNUNET_SCHEDULER_cancel (handle->quota_task);
1244     handle->quota_task = GNUNET_SCHEDULER_NO_TASK;
1245   }
1246   GNUNET_free_non_null (handle->my_hello);
1247   handle->my_hello = NULL;
1248   GNUNET_assert (handle->hwl_head == NULL);
1249   GNUNET_assert (handle->hwl_tail == NULL);
1250   GNUNET_CONTAINER_heap_destroy (handle->ready_heap);
1251   handle->ready_heap = NULL;
1252   GNUNET_free (handle);
1253 }
1254
1255
1256 /**
1257  * Check if we could queue a message of the given size for
1258  * transmission.  The transport service will take both its
1259  * internal buffers and bandwidth limits imposed by the
1260  * other peer into consideration when answering this query.
1261  *
1262  * @param handle connection to transport service
1263  * @param target who should receive the message
1264  * @param size how big is the message we want to transmit?
1265  * @param priority how important is the message?
1266  * @param timeout after how long should we give up (and call
1267  *        notify with buf NULL and size 0)?
1268  * @param notify function to call when we are ready to
1269  *        send such a message
1270  * @param notify_cls closure for notify
1271  * @return NULL if someone else is already waiting to be notified
1272  *         non-NULL if the notify callback was queued (can be used to cancel
1273  *         using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
1274  */
1275 struct GNUNET_TRANSPORT_TransmitHandle *
1276 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle *handle,
1277                                         const struct GNUNET_PeerIdentity
1278                                         *target, size_t size, uint32_t priority,
1279                                         struct GNUNET_TIME_Relative timeout,
1280                                         GNUNET_CONNECTION_TransmitReadyNotify
1281                                         notify, void *notify_cls)
1282 {
1283   struct Neighbour *n;
1284   struct GNUNET_TRANSPORT_TransmitHandle *th;
1285   struct GNUNET_TIME_Relative delay;
1286
1287   n = neighbour_find (handle, target);
1288   if (NULL == n)
1289   {
1290     /* use GNUNET_TRANSPORT_try_connect first, only use this function
1291      * once a connection has been established */
1292     GNUNET_assert (0);
1293     return NULL;
1294   }
1295   if (NULL != n->th)
1296   {
1297     /* attempt to send two messages at the same time to the same peer */
1298     GNUNET_assert (0);
1299     return NULL;
1300   }
1301   GNUNET_assert (NULL == n->hn);
1302   th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
1303   th->neighbour = n;
1304   th->notify = notify;
1305   th->notify_cls = notify_cls;
1306   th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1307   th->notify_size = size;
1308   th->priority = priority;
1309   n->th = th;
1310   /* calculate when our transmission should be ready */
1311   delay = GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker, size + n->traffic_overhead);
1312   n->traffic_overhead = 0;
1313   if (delay.rel_value > timeout.rel_value)
1314     delay.rel_value = 0;        /* notify immediately (with failure) */
1315   LOG (GNUNET_ERROR_TYPE_DEBUG,
1316        "Bandwidth tracker allows next transmission to peer %s in %llu ms\n",
1317        GNUNET_i2s (target), (unsigned long long) delay.rel_value);
1318   n->hn = GNUNET_CONTAINER_heap_insert (handle->ready_heap, n, delay.rel_value);
1319   schedule_transmission (handle);
1320   return th;
1321 }
1322
1323
1324 /**
1325  * Cancel the specified transmission-ready notification.
1326  *
1327  * @param th handle returned from GNUNET_TRANSPORT_notify_transmit_ready
1328  */
1329 void
1330 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
1331                                                GNUNET_TRANSPORT_TransmitHandle
1332                                                *th)
1333 {
1334   struct Neighbour *n;
1335
1336   GNUNET_assert (NULL == th->next);
1337   GNUNET_assert (NULL == th->prev);
1338   n = th->neighbour;
1339   GNUNET_assert (th == n->th);
1340   n->th = NULL;
1341   if (n->hn != NULL)
1342   {
1343     GNUNET_CONTAINER_heap_remove_node (n->hn);
1344     n->hn = NULL;
1345   }
1346   else
1347   {
1348     GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != th->timeout_task);
1349     GNUNET_SCHEDULER_cancel (th->timeout_task);
1350     th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1351   }
1352   GNUNET_free (th);
1353 }
1354
1355
1356 /* end of transport_api.c */