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