src/transport/transport_api.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010 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 #include "platform.h"
  27 #include "gnunet_bandwidth_lib.h"
  28 #include "gnunet_client_lib.h"
  29 #include "gnunet_constants.h"
  30 #include "gnunet_container_lib.h"
  31 #include "gnunet_arm_service.h"
  32 #include "gnunet_hello_lib.h"
  33 #include "gnunet_protocols.h"
  34 #include "gnunet_server_lib.h"
  35 #include "gnunet_time_lib.h"
  36 #include "gnunet_transport_service.h"
  37 #include "transport.h"
  38
  39 /**
  40  * After how long do we give up on transmitting a HELLO
  41  * to the service?
  42  */
  43 #define OFFER_HELLO_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
  44
  45 /**
  46  * After how long do we automatically retry an unsuccessful
  47  * CONNECT request?
  48  */
  49 #define CONNECT_RETRY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 750)
  50
  51 /**
  52  * How long should ARM wait when starting up the
  53  * transport service before reporting back?
  54  */
  55 #define START_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
  56
  57 /**
  58  * How long should ARM wait when stopping the
  59  * transport service before reporting back?
  60  */
  61 #define STOP_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
  62
  63 /**
  64  * How large to start with for the hashmap of neighbours.
  65  */
  66 #define STARTING_NEIGHBOURS_SIZE 10
  67
  68
  69 /**
  70  * What stage are we in for transmission processing?
  71  */
  72 enum TransmitStage
  73   {
  74     /**
  75      * No active message.
  76      */
  77     TS_NEW = 0,
  78
  79     /**
  80      * Message in local queue, not given to service.
  81      */
  82     TS_QUEUED = 1,
  83
  84     /**
  85      * Message given to service, not confirmed (no SEND_OK).
  86      */
  87     TS_TRANSMITTED = 2,
  88
  89     /**
  90      * One message was given to service and before it was confirmed,
  91      * another one was already queued (waiting for SEND_OK to pass on
  92      * to service).
  93      */
  94     TS_TRANSMITTED_QUEUED = 3
  95   };
  96
  97
  98 /**
  99  * Handle for a transmission-ready request.
 100  */
 101 struct GNUNET_TRANSPORT_TransmitHandle
 102 {
 103
 104   /**
 105    * Neighbour for this handle, NULL for control-traffic.
 106    */
 107   struct NeighbourList *neighbour;
 108
 109   /**
 110    * Function to call when notify_size bytes are available
 111    * for transmission.
 112    */
 113   GNUNET_CONNECTION_TransmitReadyNotify notify;
 114
 115   /**
 116    * Closure for notify.
 117    */
 118   void *notify_cls;
 119
 120   /**
 121    * transmit_ready task Id.  The task is used to introduce the
 122    * artificial delay that may be required to maintain the bandwidth
 123    * limits.  Later, this will be the ID of the "transmit_timeout"
 124    * task which is used to signal a timeout if the transmission could
 125    * not be done in a timely fashion.
 126    */
 127   GNUNET_SCHEDULER_TaskIdentifier notify_delay_task;
 128
 129   /**
 130    * Timeout for this request.
 131    */
 132   struct GNUNET_TIME_Absolute timeout;
 133
 134   /**
 135    * How many bytes is our notify callback waiting for?
 136    */
 137   size_t notify_size;
 138
 139   /**
 140    * How important is this message?
 141    */
 142   uint32_t priority;
 143
 144 };
 145
 146
 147 /**
 148  * Handle for a control message queue entry.
 149  */
 150 struct ControlMessage
 151 {
 152
 153   /**
 154    * This is a doubly-linked list.
 155    */
 156   struct ControlMessage *next;
 157
 158   /**
 159    * This is a doubly-linked list.
 160    */
 161   struct ControlMessage *prev;
 162
 163   /**
 164    * Overall transport handle.
 165    */
 166   struct GNUNET_TRANSPORT_Handle *h;
 167
 168   /**
 169    * Function to call when notify_size bytes are available
 170    * for transmission.
 171    */
 172   GNUNET_CONNECTION_TransmitReadyNotify notify;
 173
 174   /**
 175    * Closure for notify.
 176    */
 177   void *notify_cls;
 178
 179   /**
 180    * transmit_ready task Id.  The task is used to introduce the
 181    * artificial delay that may be required to maintain the bandwidth
 182    * limits.  Later, this will be the ID of the "transmit_timeout"
 183    * task which is used to signal a timeout if the transmission could
 184    * not be done in a timely fashion.
 185    */
 186   GNUNET_SCHEDULER_TaskIdentifier notify_delay_task;
 187
 188   /**
 189    * How many bytes is our notify callback waiting for?
 190    */
 191   size_t notify_size;
 192
 193 };
 194
 195 /**
 196  * Context for storing information about attempted next transmission.
 197  */
 198 struct TryTransmitContext
 199 {
 200
 201   /**
 202    * Main transport handle.
 203    */
 204   struct GNUNET_TRANSPORT_Handle *h;
 205
 206   /**
 207    * Returned transmission handle.
 208    */
 209   struct GNUNET_TRANSPORT_TransmitHandle *ret;
 210
 211   /**
 212    * Time to retry the send task.
 213    */
 214   struct GNUNET_TIME_Relative retry_time;
 215 };
 216
 217 /**
 218  * Entry in hash table of all of our current neighbours.
 219  */
 220 struct NeighbourList
 221 {
 222   /**
 223    * Overall transport handle.
 224    */
 225   struct GNUNET_TRANSPORT_Handle *h;
 226
 227   /**
 228    * Active transmit handle; available if 'transmit_forbidden'
 229    * is GNUNET_NO.
 230    */
 231   struct GNUNET_TRANSPORT_TransmitHandle transmit_handle;
 232
 233   /**
 234    * Identity of this neighbour.
 235    */
 236   struct GNUNET_PeerIdentity id;
 237
 238   /**
 239    * Outbound bandwidh tracker.
 240    */
 241   struct GNUNET_BANDWIDTH_Tracker out_tracker;
 242
 243   /**
 244    * Set to GNUNET_NO if we are currently allowed to accept a
 245    * message to the transport service for this peer, GNUNET_YES
 246    * if we have one and are waiting for transmission, GNUNET_SYSERR
 247    * if we are waiting for confirmation AND have already accepted
 248    * yet another message.
 249    */
 250   enum TransmitStage transmit_stage;
 251
 252   /**
 253    * Have we received a notification that this peer is connected
 254    * to us right now?
 255    */
 256   int is_connected;
 257
 258   /**
 259    * Are we in the middle of disconnecting the peer already?
 260    */
 261   unsigned int in_disconnect;
 262
 263 };
 264
 265
 266 /**
 267  * Linked list of requests from clients for our HELLO that were
 268  * deferred.
 269  */
 270 struct HelloWaitList
 271 {
 272
 273   /**
 274    * This is a linked list.
 275    */
 276   struct HelloWaitList *next;
 277
 278   /**
 279    * Reference back to our transport handle.
 280    */
 281   struct GNUNET_TRANSPORT_Handle *handle;
 282
 283   /**
 284    * Callback to call once we got our HELLO.
 285    */
 286   GNUNET_TRANSPORT_HelloUpdateCallback rec;
 287
 288   /**
 289    * Closure for rec.
 290    */
 291   void *rec_cls;
 292
 293 };
 294
 295
 296 /**
 297  * Handle for the transport service (includes all of the
 298  * state for the transport service).
 299  */
 300 struct GNUNET_TRANSPORT_Handle
 301 {
 302
 303   /**
 304    * Closure for the callbacks.
 305    */
 306   void *cls;
 307
 308   /**
 309    * Function to call for received data.
 310    */
 311   GNUNET_TRANSPORT_ReceiveCallback rec;
 312
 313   /**
 314    * function to call on connect events
 315    */
 316   GNUNET_TRANSPORT_NotifyConnect nc_cb;
 317
 318   /**
 319    * function to call on disconnect events
 320    */
 321   GNUNET_TRANSPORT_NotifyDisconnect nd_cb;
 322
 323   /**
 324    * Head of DLL of control messages.
 325    */
 326   struct ControlMessage *control_head;
 327
 328   /**
 329    * Tail of DLL of control messages.
 330    */
 331   struct ControlMessage *control_tail;
 332
 333   /**
 334    * The current HELLO message for this peer.  Updated
 335    * whenever transports change their addresses.
 336    */
 337   struct GNUNET_HELLO_Message *my_hello;
 338
 339   /**
 340    * My client connection to the transport service.
 341    */
 342   struct GNUNET_CLIENT_Connection *client;
 343
 344   /**
 345    * Handle to our registration with the client for notification.
 346    */
 347   struct GNUNET_CLIENT_TransmitHandle *network_handle;
 348
 349   /**
 350    * Linked list of pending requests for our HELLO.
 351    */
 352   struct HelloWaitList *hwl_head;
 353
 354   /**
 355    * My configuration.
 356    */
 357   const struct GNUNET_CONFIGURATION_Handle *cfg;
 358
 359   /**
 360    * Linked list of the current neighbours of this peer.
 361    */
 362   struct GNUNET_CONTAINER_MultiHashMap *neighbours;
 363
 364   /**
 365    * Peer identity as assumed by this process, or all zeros.
 366    */
 367   struct GNUNET_PeerIdentity self;
 368
 369   /**
 370    * ID of the task trying to reconnect to the service.
 371    */
 372   GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
 373
 374   /**
 375    * ID of the task trying to trigger transmission for a peer
 376    * while maintaining bandwidth quotas.
 377    */
 378   GNUNET_SCHEDULER_TaskIdentifier quota_task;
 379
 380   /**
 381    * Delay until we try to reconnect.
 382    */
 383   struct GNUNET_TIME_Relative reconnect_delay;
 384
 385   /**
 386    * Set once we are in the process of disconnecting from the
 387    * service.
 388    */
 389   int in_disconnect;
 390
 391   /**
 392    * Should we check that 'self' matches what the service thinks?
 393    * (if GNUNET_NO, then 'self' is all zeros!).
 394    */
 395   int check_self;
 396 };
 397
 398 struct HelloContext
 399 {
 400
 401   /**
 402    * Size of the HELLO copied to end of struct.
 403    */
 404   uint16_t size;
 405
 406   /**
 407    * Continuation to call once HELLO sent.
 408    */
 409   GNUNET_SCHEDULER_Task cont;
 410
 411   /**
 412    * Closure to call with the continuation.
 413    */
 414   void *cont_cls;
 415
 416   /* HELLO */
 417 };
 418
 419
 420 /**
 421  * Get the neighbour list entry for the given peer
 422  *
 423  * @param h our context
 424  * @param peer peer to look up
 425  * @return NULL if no such peer entry exists
 426  */
 427 static struct NeighbourList *
 428 neighbour_find (struct GNUNET_TRANSPORT_Handle *h,
 429                 const struct GNUNET_PeerIdentity *peer)
 430 {
 431   return GNUNET_CONTAINER_multihashmap_get(h->neighbours, &peer->hashPubKey);
 432 }
 433
 434
 435 /**
 436  * Schedule the task to send one message, either from the control
 437  * list or the peer message queues  to the service.
 438  */
 439 static void schedule_transmission (struct GNUNET_TRANSPORT_Handle *h);
 440
 441
 442 /**
 443  * Function called by the scheduler when the timeout for bandwidth
 444  * availablility for the target neighbour is reached.
 445  *
 446  * @param cls the 'struct GNUNET_TRANSPORT_Handle*'
 447  * @param tc scheduler context
 448  */
 449 static void
 450 quota_transmit_ready (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 451 {
 452   struct GNUNET_TRANSPORT_Handle *h = cls;
 453
 454   h->quota_task = GNUNET_SCHEDULER_NO_TASK;
 455   schedule_transmission (h);
 456 }
 457
 458
 459 /**
 460  * Iterator over hash map entries, attempt to schedule
 461  * a transmission to entries in the neighbour hashmap.
 462  *
 463  * @param cls closure a TryTransmitContext
 464  * @param key current key code
 465  * @param value value in the hash map, the neighbour entry to consider
 466  * @return GNUNET_YES if we should continue to
 467  *         iterate,
 468  *         GNUNET_NO if not.
 469  */
 470 static int
 471 try_schedule_transmission (void *cls,
 472                            const GNUNET_HashCode * key,
 473                            void *value)
 474 {
 475   struct NeighbourList *n = value;
 476   struct TryTransmitContext *try_transmit_ctx = cls;
 477   struct GNUNET_TIME_Relative duration;
 478   GNUNET_CONNECTION_TransmitReadyNotify notify;
 479   struct GNUNET_TRANSPORT_TransmitHandle *th;
 480   struct GNUNET_TIME_Absolute duration_abs;
 481
 482   if (n->transmit_stage != TS_QUEUED)
 483     return GNUNET_YES; /* not eligible, keep iterating */
 484   if (n->is_connected != GNUNET_YES)
 485     return GNUNET_YES; /* keep iterating */
 486
 487   th = &n->transmit_handle;
 488   GNUNET_break (n == th->neighbour);
 489   /* check outgoing quota */
 490   duration = GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker,
 491                                                  th->notify_size - sizeof (struct OutboundMessage));
 492   duration_abs = GNUNET_TIME_relative_to_absolute (duration);
 493   if (th->timeout.abs_value < duration_abs.abs_value)
 494     {
 495       /* signal timeout! */
 496 #if DEBUG_TRANSPORT
 497       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 498                   "Would need %llu ms before bandwidth is available for delivery to `%4s', that is too long.  Signaling timeout.\n",
 499                   duration.rel_value,
 500                   GNUNET_i2s (&n->id));
 501 #endif
 502       if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
 503         {
 504           GNUNET_SCHEDULER_cancel (th->notify_delay_task);
 505           th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
 506         }
 507       n->transmit_stage = TS_NEW;
 508       if (NULL != (notify = th->notify))
 509         {
 510           th->notify = NULL;
 511           GNUNET_assert (0 == notify (th->notify_cls, 0, NULL));
 512         }
 513       return GNUNET_YES; /* keep iterating */
 514     }
 515   if (duration.rel_value > 0)
 516     {
 517 #if DEBUG_TRANSPORT
 518       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 519                   "Need more bandwidth (%u b/s allowed, %u b needed), delaying delivery to `%4s' by %llu ms\n",
 520                   (unsigned int) n->out_tracker.available_bytes_per_s__,
 521                   (unsigned int) th->notify_size - sizeof (struct OutboundMessage),
 522                   GNUNET_i2s (&n->id),
 523                   (unsigned long long) duration.rel_value);
 524 #endif
 525       try_transmit_ctx->retry_time = GNUNET_TIME_relative_min (try_transmit_ctx->retry_time,
 526                                                                duration);
 527       return GNUNET_YES; /* keep iterating */
 528     }
 529 #if DEBUG_TRANSPORT
 530   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 531               "Have %u bytes of bandwidth available for transmission to `%4s' right now\n",
 532               th->notify_size - sizeof (struct OutboundMessage),
 533               GNUNET_i2s (&n->id));
 534 #endif
 535
 536   if ( (try_transmit_ctx->ret == NULL) ||
 537        (try_transmit_ctx->ret->priority < th->priority) )
 538     try_transmit_ctx->ret = th;
 539   return GNUNET_YES;
 540 }
 541
 542
 543 /**
 544  * Figure out which transmission to a peer can be done right now.
 545  * If none can, schedule a task to call 'schedule_transmission'
 546  * whenever a peer transmission can be done in the future and
 547  * return NULL.  Otherwise return the next transmission to be
 548  * performed.
 549  *
 550  * @param h handle to transport
 551  * @return NULL to wait longer before doing any peer transmissions
 552  */
 553 static struct GNUNET_TRANSPORT_TransmitHandle *
 554 schedule_peer_transmission (struct GNUNET_TRANSPORT_Handle *h)
 555 {
 556   struct TryTransmitContext try_transmit_ctx;
 557
 558   if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
 559     {
 560       GNUNET_SCHEDULER_cancel (h->quota_task);
 561       h->quota_task = GNUNET_SCHEDULER_NO_TASK;
 562     }
 563   try_transmit_ctx.h = h;
 564   try_transmit_ctx.ret = NULL;
 565   try_transmit_ctx.retry_time = GNUNET_TIME_UNIT_FOREVER_REL;
 566   GNUNET_CONTAINER_multihashmap_iterate(h->neighbours,
 567                                         &try_schedule_transmission,
 568                                         &try_transmit_ctx);
 569   if (try_transmit_ctx.ret == NULL)
 570     h->quota_task = GNUNET_SCHEDULER_add_delayed (try_transmit_ctx.retry_time,
 571                                                   &quota_transmit_ready,
 572                                                   h);
 573   return try_transmit_ctx.ret;
 574 }
 575
 576
 577 /**
 578  * Transmit message(s) to service.
 579  *
 580  * @param cls handle to transport
 581  * @param size number of bytes available in buf
 582  * @param buf where to copy the message
 583  * @return number of bytes copied to buf
 584  */
 585 static size_t
 586 transport_notify_ready (void *cls, size_t size, void *buf)
 587 {
 588   struct GNUNET_TRANSPORT_Handle *h = cls;
 589   struct ControlMessage *cm;
 590   struct GNUNET_TRANSPORT_TransmitHandle *th;
 591   struct NeighbourList *n;
 592   struct OutboundMessage obm;
 593   GNUNET_CONNECTION_TransmitReadyNotify notify;
 594   size_t ret;
 595   size_t mret;
 596   size_t nret;
 597   char *cbuf;
 598
 599   h->network_handle = NULL;
 600   if (buf == NULL)
 601     {
 602       schedule_transmission (h);
 603       return 0;
 604     }
 605 #if DEBUG_TRANSPORT
 606   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 607               "Ready to transmit %u bytes to transport service\n", size);
 608 #endif
 609   cbuf = buf;
 610   ret = 0;
 611   while ( (NULL != (cm = h->control_head)) &&
 612           (cm->notify_size <= size) )
 613     {
 614       if (cm->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
 615         {
 616           GNUNET_SCHEDULER_cancel (cm->notify_delay_task);
 617           cm->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
 618         }
 619       GNUNET_CONTAINER_DLL_remove (h->control_head,
 620                                    h->control_tail,
 621                                    cm);
 622       nret = cm->notify (cm->notify_cls, size, &cbuf[ret]);
 623 #if DEBUG_TRANSPORT
 624       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 625                   "Added %u bytes of control message at %u\n",
 626                   nret,
 627                   ret);
 628 #endif
 629       GNUNET_free (cm);
 630       ret += nret;
 631       size -= nret;
 632     }
 633   while ( (NULL != (th = schedule_peer_transmission (h))) &&
 634           (th->notify_size <= size) )
 635     {
 636       if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
 637         {
 638           GNUNET_SCHEDULER_cancel (th->notify_delay_task);
 639           th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
 640         }
 641       n = th->neighbour;
 642       switch (n->transmit_stage)
 643         {
 644         case TS_NEW:
 645           GNUNET_break (0);
 646           break;
 647         case TS_QUEUED:
 648           n->transmit_stage = TS_TRANSMITTED;
 649           break;
 650         case TS_TRANSMITTED:
 651           GNUNET_break (0);
 652           break;
 653         case TS_TRANSMITTED_QUEUED:
 654           GNUNET_break (0);
 655           break;
 656         default:
 657           GNUNET_break (0);
 658         }
 659       GNUNET_assert (size >= sizeof (struct OutboundMessage));
 660       notify = th->notify;
 661       th->notify = NULL;
 662       mret = notify (th->notify_cls,
 663                      size - sizeof (struct OutboundMessage),
 664                      &cbuf[ret + sizeof (struct OutboundMessage)]);
 665       GNUNET_assert (mret <= size - sizeof (struct OutboundMessage));
 666 #if DEBUG_TRANSPORT
 667       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 668                   "Message of %u bytes with timeout %llums constructed for `%4s'\n",
 669                   (unsigned int) mret,
 670                   (unsigned long long) GNUNET_TIME_absolute_get_remaining (th->timeout).rel_value,
 671                   GNUNET_i2s (&n->id));
 672 #endif
 673       if (mret != 0)
 674         {
 675           GNUNET_assert (mret + sizeof (struct OutboundMessage) < GNUNET_SERVER_MAX_MESSAGE_SIZE);
 676           obm.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND);
 677           obm.header.size = htons (mret + sizeof (struct OutboundMessage));
 678           obm.priority = htonl (th->priority);
 679           obm.timeout = GNUNET_TIME_relative_hton (GNUNET_TIME_absolute_get_remaining (th->timeout));
 680           obm.peer = n->id;
 681           memcpy (&cbuf[ret], &obm, sizeof (struct OutboundMessage));
 682           ret += (mret + sizeof (struct OutboundMessage));
 683           size -= (mret + sizeof (struct OutboundMessage));
 684           GNUNET_BANDWIDTH_tracker_consume (&n->out_tracker, mret);
 685         }
 686       else
 687         {
 688           switch (n->transmit_stage)
 689             {
 690             case TS_NEW:
 691               GNUNET_break (0);
 692               break;
 693             case TS_QUEUED:
 694               GNUNET_break (0);
 695               break;
 696             case TS_TRANSMITTED:
 697               n->transmit_stage = TS_NEW;
 698               break;
 699             case TS_TRANSMITTED_QUEUED:
 700               n->transmit_stage = TS_QUEUED;
 701               continue;
 702             default:
 703               GNUNET_break (0);
 704             }
 705         }
 706     }
 707   schedule_transmission (h);
 708 #if DEBUG_TRANSPORT
 709   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 710               "Transmitting %u bytes to transport service\n", ret);
 711 #endif
 712   return ret;
 713 }
 714
 715
 716 /**
 717  * Schedule the task to send one message, either from the control
 718  * list or the peer message queues  to the service.
 719  */
 720 static void
 721 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
 722 {
 723   size_t size;
 724   struct GNUNET_TIME_Relative timeout;
 725   struct GNUNET_TRANSPORT_TransmitHandle *th;
 726
 727   if (NULL != h->network_handle)
 728     return;
 729   if (h->client == NULL)
 730     {
 731       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 732                   _("Could not yet schedule transmission: we are not yet connected to the transport service!\n"));
 733       return;                   /* not yet connected */
 734     }
 735   if (NULL != h->control_head)
 736     {
 737       size = h->control_head->notify_size;
 738       timeout = GNUNET_TIME_UNIT_FOREVER_REL;
 739     }
 740   else
 741     {
 742       th = schedule_peer_transmission (h);
 743       if (th == NULL)
 744         {
 745           /* no transmission ready right now */
 746 #if DEBUG_TRANSPORT
 747           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 748                       "Could not yet schedule transmission: none ready\n");
 749 #endif
 750           return;
 751         }
 752       size = th->notify_size;
 753       timeout = GNUNET_TIME_absolute_get_remaining (th->timeout);
 754     }
 755 #if DEBUG_TRANSPORT
 756     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 757                 "Calling notify_transmit_ready\n");
 758 #endif
 759   h->network_handle =
 760     GNUNET_CLIENT_notify_transmit_ready (h->client,
 761                                          size,
 762                                          timeout,
 763                                          GNUNET_NO,
 764                                          &transport_notify_ready,
 765                                          h);
 766   GNUNET_assert (NULL != h->network_handle);
 767 }
 768
 769
 770 /**
 771  * Called when our transmit request timed out before any transport
 772  * reported success connecting to the desired peer or before the
 773  * transport was ready to receive.  Signal error and free
 774  * TransmitHandle.
 775  */
 776 static void
 777 control_transmit_timeout (void *cls,
 778                           const struct GNUNET_SCHEDULER_TaskContext *tc)
 779 {
 780   struct ControlMessage *th = cls;
 781
 782   th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
 783   if (NULL != th->notify)
 784     th->notify (th->notify_cls, 0, NULL);
 785   GNUNET_CONTAINER_DLL_remove (th->h->control_head,
 786                                th->h->control_tail,
 787                                th);
 788   GNUNET_free (th);
 789 }
 790
 791
 792 /**
 793  * Queue control request for transmission to the transport
 794  * service.
 795  *
 796  * @param h handle to the transport service
 797  * @param size number of bytes to be transmitted
 798  * @param at_head request must be added to the head of the queue
 799  *        (otherwise request will be appended)
 800  * @param timeout how long this transmission can wait (at most)
 801  * @param notify function to call to get the content
 802  * @param notify_cls closure for notify
 803  */
 804 static void
 805 schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h,
 806                            size_t size,
 807                            int at_head,
 808                            struct GNUNET_TIME_Relative timeout,
 809                            GNUNET_CONNECTION_TransmitReadyNotify notify,
 810                            void *notify_cls)
 811 {
 812   struct ControlMessage *cm;
 813
 814 #if DEBUG_TRANSPORT
 815   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 816               "Control transmit of %u bytes within %llums requested\n",
 817               size, (unsigned long long) timeout.rel_value);
 818 #endif
 819   cm = GNUNET_malloc (sizeof (struct ControlMessage));
 820   cm->h = h;
 821   cm->notify = notify;
 822   cm->notify_cls = notify_cls;
 823   cm->notify_size = size;
 824   cm->notify_delay_task
 825     = GNUNET_SCHEDULER_add_delayed (timeout, &control_transmit_timeout, cm);
 826   if (at_head)
 827     GNUNET_CONTAINER_DLL_insert (h->control_head,
 828                                  h->control_tail,
 829                                  cm);
 830   else
 831     GNUNET_CONTAINER_DLL_insert_after (h->control_head,
 832                                        h->control_tail,
 833                                        h->control_tail,
 834                                        cm);
 835   schedule_transmission (h);
 836 }
 837
 838
 839 /**
 840  * FIXME: document
 841  */
 842 struct SetQuotaContext
 843 {
 844   /**
 845    * FIXME: document
 846    */
 847   struct GNUNET_TRANSPORT_Handle *handle;
 848
 849   /**
 850    * FIXME: document
 851    */
 852   struct GNUNET_PeerIdentity target;
 853
 854   /**
 855    * FIXME: document
 856    */
 857   GNUNET_SCHEDULER_Task cont;
 858
 859   /**
 860    * Closure for 'cont'.
 861    */
 862   void *cont_cls;
 863
 864   /**
 865    * FIXME: document
 866    */
 867   struct GNUNET_TIME_Absolute timeout;
 868
 869   /**
 870    * FIXME: document
 871    */
 872   struct GNUNET_BANDWIDTH_Value32NBO quota_in;
 873 };
 874
 875
 876 /**
 877  * Send SET_QUOTA message to the service.
 878  *
 879  * @param cls the 'struct SetQuotaContext'
 880  * @param size number of bytes available in buf
 881  * @param buf where to copy the message
 882  * @return number of bytes copied to buf
 883  */
 884 static size_t
 885 send_set_quota (void *cls, size_t size, void *buf)
 886 {
 887   struct SetQuotaContext *sqc = cls;
 888   struct QuotaSetMessage *msg;
 889
 890   if (buf == NULL)
 891     {
 892       if (sqc->cont != NULL)
 893         GNUNET_SCHEDULER_add_continuation (sqc->cont,
 894                                            sqc->cont_cls,
 895                                            GNUNET_SCHEDULER_REASON_TIMEOUT);
 896       GNUNET_free (sqc);
 897       return 0;
 898     }
 899 #if DEBUG_TRANSPORT
 900   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 901               "Transmitting `%s' request with respect to `%4s'.\n",
 902               "SET_QUOTA",
 903               GNUNET_i2s (&sqc->target));
 904 #endif
 905   GNUNET_assert (size >= sizeof (struct QuotaSetMessage));
 906   msg = buf;
 907   msg->header.size = htons (sizeof (struct QuotaSetMessage));
 908   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
 909   msg->quota = sqc->quota_in;
 910   memcpy (&msg->peer, &sqc->target, sizeof (struct GNUNET_PeerIdentity));
 911   if (sqc->cont != NULL)
 912     GNUNET_SCHEDULER_add_continuation (sqc->cont,
 913                                        sqc->cont_cls,
 914                                        GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 915   GNUNET_free (sqc);
 916   return sizeof (struct QuotaSetMessage);
 917 }
 918
 919
 920 /**
 921  * Set the share of incoming bandwidth for the given
 922  * peer to the specified amount.
 923  *
 924  * @param handle connection to transport service
 925  * @param target who's bandwidth quota is being changed
 926  * @param quota_in incoming bandwidth quota in bytes per ms
 927  * @param quota_out outgoing bandwidth quota in bytes per ms
 928  */
 929 void
 930 GNUNET_TRANSPORT_set_quota (struct GNUNET_TRANSPORT_Handle *handle,
 931                             const struct GNUNET_PeerIdentity *target,
 932                             struct GNUNET_BANDWIDTH_Value32NBO quota_in,
 933                             struct GNUNET_BANDWIDTH_Value32NBO quota_out)
 934 {
 935   struct NeighbourList *n;
 936   struct SetQuotaContext *sqc;
 937
 938   n = neighbour_find (handle, target);
 939   if (n != NULL)
 940     {
 941 #if DEBUG_TRANSPORT
 942       if (ntohl (quota_out.value__) != n->out_tracker.available_bytes_per_s__)
 943         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 944                     "Quota changed from %u to %u for peer `%s'\n",
 945                     (unsigned int) n->out_tracker.available_bytes_per_s__,
 946                     (unsigned int) ntohl (quota_out.value__),
 947                     GNUNET_i2s (target));
 948       else
 949         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 950                     "Quota remains at %u for peer `%s'\n",
 951                     (unsigned int) n->out_tracker.available_bytes_per_s__,
 952                     GNUNET_i2s (target));
 953 #endif
 954       GNUNET_BANDWIDTH_tracker_update_quota (&n->out_tracker,
 955                                              quota_out);
 956     }
 957   else
 958     {
 959 #if DEBUG_TRANSPORT
 960       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 961                   "Quota changed to %u for peer `%s', but I have no such neighbour!\n",
 962                   (unsigned int) ntohl (quota_out.value__),
 963                   GNUNET_i2s (target));
 964 #endif
 965     }
 966   sqc = GNUNET_malloc (sizeof (struct SetQuotaContext));
 967   sqc->handle = handle;
 968   sqc->target = *target;
 969   sqc->cont = NULL;
 970   sqc->cont_cls = NULL;
 971   sqc->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_TIME_UNIT_FOREVER_REL);
 972   sqc->quota_in = quota_in;
 973   schedule_control_transmit (handle,
 974                              sizeof (struct QuotaSetMessage),
 975                              GNUNET_NO,
 976                              GNUNET_TIME_UNIT_FOREVER_REL, &send_set_quota, sqc);
 977 }
 978
 979
 980 /**
 981  * Obtain the HELLO message for this peer.
 982  *
 983  * @param handle connection to transport service
 984  * @param rec function to call with the HELLO, sender will be our peer
 985  *            identity; message and sender will be NULL on timeout
 986  *            (handshake with transport service pending/failed).
 987  *             cost estimate will be 0.
 988  * @param rec_cls closure for rec
 989  */
 990 void
 991 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
 992                             GNUNET_TRANSPORT_HelloUpdateCallback rec,
 993                             void *rec_cls)
 994 {
 995   struct HelloWaitList *hwl;
 996
 997   hwl = GNUNET_malloc (sizeof (struct HelloWaitList));
 998   hwl->next = handle->hwl_head;
 999   handle->hwl_head = hwl;
1000   hwl->handle = handle;
1001   hwl->rec = rec;
1002   hwl->rec_cls = rec_cls;
1003   if (handle->my_hello == NULL)
1004     return;
1005   rec (rec_cls, (const struct GNUNET_MessageHeader *) handle->my_hello);
1006 }
1007
1008
1009
1010 /**
1011  * Stop receiving updates about changes to our HELLO message.
1012  *
1013  * @param handle connection to transport service
1014  * @param rec function previously registered to be called with the HELLOs
1015  * @param rec_cls closure for rec
1016  */
1017 void
1018 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_Handle *handle,
1019                                    GNUNET_TRANSPORT_HelloUpdateCallback rec,
1020                                    void *rec_cls)
1021 {
1022   struct HelloWaitList *pos;
1023   struct HelloWaitList *prev;
1024
1025   prev = NULL;
1026   pos = handle->hwl_head;
1027   while (pos != NULL)
1028     {
1029       if ( (pos->rec == rec) &&
1030            (pos->rec_cls == rec_cls) )
1031         break;
1032       prev = pos;
1033       pos = pos->next;
1034     }
1035   GNUNET_break (pos != NULL);
1036   if (pos == NULL)
1037     return;
1038   if (prev == NULL)
1039     handle->hwl_head = pos->next;
1040   else
1041     prev->next = pos->next;
1042   GNUNET_free (pos);
1043 }
1044
1045
1046 /**
1047  * Send HELLO message to the service.
1048  *
1049  * @param cls the HELLO message to send
1050  * @param size number of bytes available in buf
1051  * @param buf where to copy the message
1052  * @return number of bytes copied to buf
1053  */
1054 static size_t
1055 send_hello (void *cls, size_t size, void *buf)
1056 {
1057   struct HelloContext *hc = cls;
1058   uint16_t ssize;
1059   if (buf == NULL)
1060     {
1061 #if DEBUG_TRANSPORT_TIMEOUT
1062       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1063                   "Timeout while trying to transmit `%s' request.\n",
1064                   "HELLO");
1065 #endif
1066       GNUNET_SCHEDULER_add_now(hc->cont, hc->cont_cls);
1067       GNUNET_free (hc);
1068       return 0;
1069     }
1070 #if DEBUG_TRANSPORT
1071   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1072               "Transmitting `%s' request.\n", "HELLO");
1073 #endif
1074   GNUNET_assert (size >= hc->size);
1075   memcpy (buf, &hc[1], hc->size);
1076
1077   if (hc->cont != NULL)
1078     {
1079       GNUNET_SCHEDULER_add_continuation(hc->cont, hc->cont_cls, GNUNET_SCHEDULER_REASON_PREREQ_DONE);
1080     }
1081   ssize = hc->size;
1082   GNUNET_free (hc);
1083   return ssize;
1084 }
1085
1086
1087 /**
1088  * Offer the transport service the HELLO of another peer.  Note that
1089  * the transport service may just ignore this message if the HELLO is
1090  * malformed or useless due to our local configuration.
1091  *
1092  * @param handle connection to transport service
1093  * @param hello the hello message
1094  * @param cont continuation to call when HELLO has been sent
1095  * @param cls closure for continuation
1096  *
1097  */
1098 void
1099 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
1100                               const struct GNUNET_MessageHeader *hello,
1101                               GNUNET_SCHEDULER_Task cont,
1102                               void *cls)
1103 {
1104   uint16_t size;
1105   struct GNUNET_PeerIdentity peer;
1106   struct HelloContext *hc;
1107
1108   GNUNET_break (ntohs (hello->type) == GNUNET_MESSAGE_TYPE_HELLO);
1109   size = ntohs (hello->size);
1110   GNUNET_break (size >= sizeof (struct GNUNET_MessageHeader));
1111   if (GNUNET_OK != GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message*) hello,
1112                                         &peer))
1113     {
1114       GNUNET_break (0);
1115       return;
1116     }
1117   hc = GNUNET_malloc(sizeof(struct HelloContext) + size);
1118   hc->size = size;
1119   hc->cont = cont;
1120   hc->cont_cls = cls;
1121   memcpy (&hc[1], hello, size);
1122
1123 #if DEBUG_TRANSPORT
1124   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1125               "Offering `%s' message of `%4s' to transport for validation.\n",
1126               "HELLO",
1127               GNUNET_i2s (&peer));
1128 #endif
1129
1130   schedule_control_transmit (handle,
1131                              size,
1132                              GNUNET_NO, OFFER_HELLO_TIMEOUT, &send_hello, hc);
1133 }
1134
1135
1136 /**
1137  * Transmit START message to service.
1138  *
1139  * @param cls unused
1140  * @param size number of bytes available in buf
1141  * @param buf where to copy the message
1142  * @return number of bytes copied to buf
1143  */
1144 static size_t
1145 send_start (void *cls, size_t size, void *buf)
1146 {
1147   struct GNUNET_TRANSPORT_Handle *h = cls;
1148   struct StartMessage s;
1149
1150   if (buf == NULL)
1151     {
1152       /* Can only be shutdown, just give up */
1153 #if DEBUG_TRANSPORT
1154       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1155                   "Shutdown while trying to transmit `%s' request.\n",
1156                   "START");
1157 #endif
1158       return 0;
1159     }
1160 #if DEBUG_TRANSPORT
1161   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1162               "Transmitting `%s' request.\n", "START");
1163 #endif
1164   GNUNET_assert (size >= sizeof (struct StartMessage));
1165   s.header.size = htons (sizeof (struct StartMessage));
1166   s.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_START);
1167   s.do_check = htonl (h->check_self);
1168   s.self = h->self;
1169   memcpy (buf, &s, sizeof (struct StartMessage));
1170   return sizeof (struct StartMessage);
1171 }
1172
1173
1174 /**
1175  * Free neighbour.
1176  *
1177  * @param n the entry to free
1178  */
1179 static void
1180 neighbour_free (struct NeighbourList *n)
1181 {
1182   struct GNUNET_TRANSPORT_Handle *h;
1183
1184   /* Added so task gets canceled when a disconnect is received! */
1185   /* Method 1
1186   if (n->transmit_handle.notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1187     {
1188       GNUNET_SCHEDULER_cancel(n->transmit_handle.notify_delay_task);
1189       n->transmit_handle.notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1190       n->transmit_handle.notify = NULL;
1191     }
1192   */
1193   /* NATE: if the above is not needed, then clearly this assertion
1194      should hold (I've checked the code and I'm pretty sure this is
1195      true. -CG
1196      FIXME: remove above comments once we've seen tests pass with the assert... */
1197   GNUNET_assert (n->transmit_handle.notify_delay_task == GNUNET_SCHEDULER_NO_TASK);
1198   GNUNET_assert (n->transmit_handle.notify == NULL);
1199   h = n->h;
1200 #if DEBUG_TRANSPORT
1201   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1202               "Removing neighbour `%s' from list of connected peers.\n",
1203               GNUNET_i2s (&n->id));
1204 #endif
1205   GNUNET_break (n->is_connected == GNUNET_NO);
1206   GNUNET_break (n->transmit_stage == TS_NEW);
1207
1208   GNUNET_assert(GNUNET_YES ==
1209                 GNUNET_CONTAINER_multihashmap_remove(h->neighbours,
1210                                                      &n->id.hashPubKey,
1211                                                      n));
1212   GNUNET_free (n);
1213 }
1214
1215
1216 /**
1217  * Mark neighbour as disconnected.
1218  *
1219  * @param n the entry to mark as disconnected
1220  */
1221 static void
1222 neighbour_disconnect (struct NeighbourList *n)
1223 {
1224   struct GNUNET_TRANSPORT_Handle *h = n->h;
1225 #if DEBUG_TRANSPORT
1226   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1227               "Removing neighbour `%s' from list of connected peers.\n",
1228               GNUNET_i2s (&n->id));
1229 #endif
1230   GNUNET_break (n->is_connected == GNUNET_YES);
1231   n->is_connected = GNUNET_NO;
1232   /* FIXME: this 'in_disconnect' flag is dubious; we should define
1233      clearly what disconnect means for pending 'notify_transmit_ready'
1234      requests; maybe a good approach is to REQUIRE clients to
1235      call 'notify_transmit_ready_cancel' on pending requests on disconnect
1236      and otherwise FAIL HARD with an assertion failure before
1237      'neighbour_free' right here (transmit_stage would be forced
1238      to 'TS_NEW') */
1239   n->in_disconnect = GNUNET_YES;
1240   if (h->nd_cb != NULL)
1241     h->nd_cb (h->cls, &n->id);
1242   if (n->transmit_stage == TS_NEW)
1243     neighbour_free (n);
1244 }
1245
1246
1247 /**
1248  * Function we use for handling incoming messages.
1249  *
1250  * @param cls closure (struct GNUNET_TRANSPORT_Handle *)
1251  * @param msg message received, NULL on timeout or fatal error
1252  */
1253 static void demultiplexer (void *cls,
1254                            const struct GNUNET_MessageHeader *msg);
1255
1256
1257 /**
1258  * Iterator over hash map entries, for getting rid of a neighbor
1259  * upon a reconnect call.
1260  *
1261  * @param cls closure (NULL)
1262  * @param key current key code
1263  * @param value value in the hash map, the neighbour entry to forget
1264  * @return GNUNET_YES if we should continue to
1265  *         iterate,
1266  *         GNUNET_NO if not.
1267  */
1268 static int
1269 forget_neighbours (void *cls,
1270                    const GNUNET_HashCode * key,
1271                    void *value)
1272 {
1273   struct NeighbourList *n = value;
1274
1275 #if DEBUG_TRANSPORT_DISCONNECT
1276   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1277               "Disconnecting due to reconnect being called\n");
1278 #endif
1279   if (n->is_connected)
1280     neighbour_disconnect (n);
1281
1282   return GNUNET_YES;
1283 }
1284
1285
1286 /**
1287  * Try again to connect to transport service.
1288  *
1289  * @param cls the handle to the transport service
1290  * @param tc scheduler context
1291  */
1292 static void
1293 reconnect (void *cls,
1294            const struct GNUNET_SCHEDULER_TaskContext *tc)
1295 {
1296   struct GNUNET_TRANSPORT_Handle *h = cls;
1297   struct ControlMessage *pos;
1298
1299   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1300   if ( (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
1301     {
1302       /* shutdown, just give up */
1303       return;
1304     }
1305   /* Forget about all neighbours that we used to be connected to */
1306   GNUNET_CONTAINER_multihashmap_iterate(h->neighbours,
1307                                         &forget_neighbours,
1308                                         NULL);
1309
1310 #if DEBUG_TRANSPORT
1311   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1312               "Connecting to transport service.\n");
1313 #endif
1314   GNUNET_assert (h->client == NULL);
1315   h->client = GNUNET_CLIENT_connect ("transport", h->cfg);
1316   GNUNET_assert (h->client != NULL);
1317   /* make sure we don't send "START" twice, remove existing entry from
1318      queue (if present) */
1319   pos = h->control_head;
1320   while (pos != NULL)
1321     {
1322       if (pos->notify == &send_start)
1323         {
1324           GNUNET_CONTAINER_DLL_remove (h->control_head,
1325                                        h->control_tail,
1326                                        pos);
1327           if (GNUNET_SCHEDULER_NO_TASK != pos->notify_delay_task)
1328             {
1329               GNUNET_SCHEDULER_cancel (pos->notify_delay_task);
1330               pos->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1331             }
1332           GNUNET_free (pos);
1333           break;
1334         }
1335       pos = pos->next;
1336     }
1337   schedule_control_transmit (h,
1338                              sizeof (struct StartMessage),
1339                              GNUNET_YES,
1340                              GNUNET_TIME_UNIT_FOREVER_REL, &send_start, h);
1341   GNUNET_CLIENT_receive (h->client,
1342                          &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1343 }
1344
1345
1346 /**
1347  * Function that will schedule the job that will try
1348  * to connect us again to the client.
1349  *
1350  * @param h transport service to reconnect
1351  */
1352 static void
1353 schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
1354 {
1355 #if DEBUG_TRANSPORT
1356   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1357               "Scheduling task to reconnect to transport service in %llu ms.\n",
1358               h->reconnect_delay.rel_value);
1359 #endif
1360   GNUNET_assert (h->client == NULL);
1361   GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
1362   h->reconnect_task
1363     = GNUNET_SCHEDULER_add_delayed (h->reconnect_delay, &reconnect, h);
1364   if (h->reconnect_delay.rel_value == 0)
1365     {
1366       h->reconnect_delay = GNUNET_TIME_UNIT_MILLISECONDS;
1367     }
1368   else
1369     {
1370       h->reconnect_delay = GNUNET_TIME_relative_multiply (h->reconnect_delay, 2);
1371       h->reconnect_delay = GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
1372                                                      h->reconnect_delay);
1373     }
1374 }
1375
1376
1377 /**
1378  * Send request connect message to the service.
1379  *
1380  * @param cls the TransportRequestConnectMessage
1381  * @param size number of bytes available in buf
1382  * @param buf where to copy the message
1383  * @return number of bytes copied to buf
1384  */
1385 static size_t
1386 send_transport_request_connect (void *cls, size_t size, void *buf)
1387 {
1388   struct TransportRequestConnectMessage *trcm = cls;
1389
1390   if (buf == NULL)
1391     {
1392 #if DEBUG_TRANSPORT
1393       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1394                   "Buffer null for %s\n",
1395                   "REQUEST_CONNECT");
1396 #endif
1397       GNUNET_free (trcm);
1398       return 0;
1399     }
1400 #if DEBUG_TRANSPORT
1401   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1402               "Transmitting `%s' request for `%4s'.\n",
1403               "REQUEST_CONNECT",
1404               GNUNET_i2s (&trcm->peer));
1405 #endif
1406   GNUNET_assert (size >= sizeof (struct TransportRequestConnectMessage));
1407   memcpy(buf, trcm, sizeof(struct TransportRequestConnectMessage));
1408   GNUNET_free (trcm);
1409   return sizeof(struct TransportRequestConnectMessage);
1410 }
1411
1412 /**
1413  * Create and send a request connect message to
1414  * the transport service for a particular peer.
1415  *
1416  * @param h handle to the transport service
1417  * @param n the neighbor to send the request connect message about
1418  *
1419  */
1420 static void
1421 send_request_connect_message(struct GNUNET_TRANSPORT_Handle *h, struct NeighbourList *n)
1422 {
1423   struct TransportRequestConnectMessage *trcm;
1424
1425   trcm = GNUNET_malloc(sizeof(struct TransportRequestConnectMessage));
1426   trcm->header.type = htons(GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT);
1427   trcm->header.size = htons(sizeof(struct TransportRequestConnectMessage));
1428   memcpy(&trcm->peer, &n->id, sizeof(struct GNUNET_PeerIdentity));
1429   schedule_control_transmit (h,
1430                              sizeof (struct TransportRequestConnectMessage),
1431                              GNUNET_NO,
1432                              GNUNET_TIME_UNIT_FOREVER_REL, &send_transport_request_connect, trcm);
1433 }
1434
1435
1436 /**
1437  * Add neighbour to our list
1438  *
1439  * @return NULL if this API is currently disconnecting from the service
1440  */
1441 static struct NeighbourList *
1442 neighbour_add (struct GNUNET_TRANSPORT_Handle *h,
1443                const struct GNUNET_PeerIdentity *pid)
1444 {
1445   struct NeighbourList *n;
1446
1447   if (GNUNET_YES == h->in_disconnect)
1448     return NULL;
1449   /* check for duplicates */
1450   if (NULL != (n = neighbour_find (h, pid)))
1451     {
1452       GNUNET_break (0);
1453       return n;
1454     }
1455 #if DEBUG_TRANSPORT
1456   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1457               "Creating entry for neighbour `%4s'.\n",
1458               GNUNET_i2s (pid));
1459 #endif
1460   n = GNUNET_malloc (sizeof (struct NeighbourList));
1461   n->id = *pid;
1462   n->h = h;
1463   GNUNET_BANDWIDTH_tracker_init (&n->out_tracker,
1464                                  GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
1465                                  MAX_BANDWIDTH_CARRY_S);
1466   GNUNET_CONTAINER_multihashmap_put (h->neighbours,
1467                                      &pid->hashPubKey,
1468                                      n,
1469                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
1470
1471   return n;
1472 }
1473
1474
1475 /**
1476  * Iterator over hash map entries, for deleting state of a neighbor.
1477  *
1478  * @param cls closure (NULL)
1479  * @param key current key code
1480  * @param value value in the hash map, the neighbour entry to delete
1481  * @return GNUNET_YES if we should continue to
1482  *         iterate,
1483  *         GNUNET_NO if not.
1484  */
1485 static int
1486 delete_neighbours (void *cls,
1487                    const GNUNET_HashCode * key,
1488                    void *value)
1489 {
1490   struct NeighbourList *n = value;
1491   struct GNUNET_TRANSPORT_TransmitHandle *th;
1492
1493   switch (n->transmit_stage)
1494     {
1495     case TS_NEW:
1496     case TS_TRANSMITTED:
1497       /* nothing to do */
1498       break;
1499     case TS_QUEUED:
1500     case TS_TRANSMITTED_QUEUED:
1501       th = &n->transmit_handle;
1502       if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1503         {
1504           GNUNET_SCHEDULER_cancel (th->notify_delay_task);
1505           th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1506         }
1507       GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
1508       break;
1509     default:
1510       GNUNET_break (0);
1511     }
1512   GNUNET_free (n);
1513   return GNUNET_YES;
1514 }
1515
1516
1517 /**
1518  * Connect to the transport service.  Note that the connection may
1519  * complete (or fail) asynchronously.
1520  *
1521  * @param cfg configuration to use
1522  * @param self our own identity (API should check that it matches
1523  *             the identity found by transport), or NULL (no check)
1524  * @param cls closure for the callbacks
1525  * @param rec receive function to call
1526  * @param nc function to call on connect events
1527  * @param nd function to call on disconnect events
1528  */
1529 struct GNUNET_TRANSPORT_Handle *
1530 GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1531                           const struct GNUNET_PeerIdentity *self,
1532                           void *cls,
1533                           GNUNET_TRANSPORT_ReceiveCallback rec,
1534                           GNUNET_TRANSPORT_NotifyConnect nc,
1535                           GNUNET_TRANSPORT_NotifyDisconnect nd)
1536 {
1537   struct GNUNET_TRANSPORT_Handle *ret;
1538
1539   ret = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_Handle));
1540   if (self != NULL)
1541     {
1542       ret->self = *self;
1543       ret->check_self = GNUNET_YES;
1544     }
1545   ret->cfg = cfg;
1546   ret->cls = cls;
1547   ret->rec = rec;
1548   ret->nc_cb = nc;
1549   ret->nd_cb = nd;
1550   ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
1551   ret->neighbours = GNUNET_CONTAINER_multihashmap_create(STARTING_NEIGHBOURS_SIZE);
1552   schedule_reconnect (ret);
1553   return ret;
1554 }
1555
1556
1557 /**
1558  * Disconnect from the transport service.
1559  */
1560 void
1561 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
1562 {
1563   struct HelloWaitList *hwl;
1564   struct GNUNET_CLIENT_Connection *client;
1565   struct ControlMessage *cm;
1566
1567 #if DEBUG_TRANSPORT
1568   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transport disconnect called!\n");
1569 #endif
1570   /* FIXME: this flag is dubious, we should be able to do this
1571      more cleanly; also, we should probably do 'disconnect'
1572      callbacks for every connected peer here, i.e. by calling
1573      the iterator with 'forget_neighbours' instead of 'delete_neighbours'.
1574   */
1575
1576   handle->in_disconnect = GNUNET_YES;
1577
1578   GNUNET_assert (GNUNET_SYSERR !=
1579                  GNUNET_CONTAINER_multihashmap_iterate(handle->neighbours,
1580                                                        &delete_neighbours,
1581                                                        handle));
1582   GNUNET_CONTAINER_multihashmap_destroy (handle->neighbours);
1583
1584   while (NULL != (hwl = handle->hwl_head))
1585     {
1586       handle->hwl_head = hwl->next;
1587       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1588                   _
1589                   ("Disconnect while notification for `%s' still registered.\n"),
1590                   "HELLO");
1591       if (hwl->rec != NULL)
1592         hwl->rec (hwl->rec_cls, NULL);
1593       GNUNET_free (hwl);
1594     }
1595
1596   /* Check for still scheduled control messages, cancel delay tasks if so */
1597   /* Added because somehow a notify_delay_task is remaining scheduled and is ever so annoying */
1598   while ( (NULL != (cm = handle->control_head)))
1599     {
1600 #if DEBUG_TRANSPORT
1601       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1602                   "Disconnect before control message sent!\n");
1603 #endif
1604       if (cm->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1605         {
1606           GNUNET_SCHEDULER_cancel (cm->notify_delay_task);
1607           cm->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1608         }
1609       GNUNET_CONTAINER_DLL_remove (handle->control_head,
1610                                    handle->control_tail,
1611                                    cm);
1612       GNUNET_free (cm);
1613     }
1614   /* end check */
1615
1616   if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1617     {
1618       GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1619       handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1620     }
1621   if (handle->quota_task != GNUNET_SCHEDULER_NO_TASK)
1622     {
1623       GNUNET_SCHEDULER_cancel (handle->quota_task);
1624       handle->quota_task = GNUNET_SCHEDULER_NO_TASK;
1625     }
1626   GNUNET_free_non_null (handle->my_hello);
1627   handle->my_hello = NULL;
1628
1629   if (NULL != handle->network_handle)
1630     {
1631       GNUNET_CLIENT_notify_transmit_ready_cancel (handle->network_handle);
1632       handle->network_handle = NULL;
1633     }
1634   if (NULL != (client = handle->client))
1635     {
1636 #if DEBUG_TRANSPORT
1637       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1638                   "Disconnecting from transport service for good.\n");
1639 #endif
1640       handle->client = NULL;
1641       GNUNET_CLIENT_disconnect (client, GNUNET_YES);
1642     }
1643   GNUNET_free (handle);
1644 }
1645
1646
1647 /**
1648  * Function we use for handling incoming messages.
1649  *
1650  * @param cls closure (struct GNUNET_TRANSPORT_Handle *)
1651  * @param msg message received, NULL on timeout or fatal error
1652  */
1653 static void
1654 demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
1655 {
1656   struct GNUNET_TRANSPORT_Handle *h = cls;
1657   const struct DisconnectInfoMessage *dim;
1658   const struct ConnectInfoMessage *cim;
1659   const struct InboundMessage *im;
1660   const struct GNUNET_MessageHeader *imm;
1661   const struct SendOkMessage *okm;
1662   struct HelloWaitList *hwl;
1663   struct HelloWaitList *next_hwl;
1664   struct NeighbourList *n;
1665   struct GNUNET_PeerIdentity me;
1666   uint16_t size;
1667   uint32_t ats_count;
1668
1669   if (h->client == NULL)
1670     {
1671       /* shutdown initiated from 'GNUNET_TRANSPORT_disconnect',
1672          finish clean up work! */
1673       GNUNET_free (h);
1674       return;
1675     }
1676   if (msg == NULL)
1677     {
1678 #if DEBUG_TRANSPORT
1679       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1680                   "Error receiving from transport service, disconnecting temporarily.\n");
1681 #endif
1682       if (h->network_handle != NULL)
1683         {
1684           GNUNET_CLIENT_notify_transmit_ready_cancel (h->network_handle);
1685           h->network_handle = NULL;
1686         }
1687       GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
1688       h->client = NULL;
1689       schedule_reconnect (h);
1690       return;
1691     }
1692   GNUNET_CLIENT_receive (h->client,
1693                          &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1694   size = ntohs (msg->size);
1695   switch (ntohs (msg->type))
1696     {
1697     case GNUNET_MESSAGE_TYPE_HELLO:
1698       if (GNUNET_OK !=
1699           GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) msg,
1700                                &me))
1701         {
1702           GNUNET_break (0);
1703           break;
1704         }
1705 #if DEBUG_TRANSPORT
1706       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1707                   "Receiving (my own) `%s' message, I am `%4s'.\n",
1708                   "HELLO", GNUNET_i2s (&me));
1709 #endif
1710       GNUNET_free_non_null (h->my_hello);
1711       h->my_hello = NULL;
1712       if (size < sizeof (struct GNUNET_MessageHeader))
1713         {
1714           GNUNET_break (0);
1715           break;
1716         }
1717       h->my_hello = GNUNET_malloc (size);
1718       memcpy (h->my_hello, msg, size);
1719       hwl = h->hwl_head;
1720       while (NULL != hwl)
1721         {
1722           next_hwl = hwl->next;
1723           hwl->rec (hwl->rec_cls,
1724                     (const struct GNUNET_MessageHeader *) h->my_hello);
1725           hwl = next_hwl;
1726         }
1727       break;
1728     case GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT:
1729
1730       if (size < sizeof (struct ConnectInfoMessage))
1731         {
1732           GNUNET_break (0);
1733           break;
1734         }
1735       cim = (const struct ConnectInfoMessage *) msg;
1736       ats_count = ntohl (cim->ats_count);
1737       if (size != sizeof (struct ConnectInfoMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information))
1738         {
1739           GNUNET_break (0);
1740           break;
1741         }
1742
1743 #if DEBUG_TRANSPORT
1744       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1745                   "Receiving `%s' message for `%4s'.\n",
1746                   "CONNECT", GNUNET_i2s (&cim->id));
1747 #endif
1748       n = neighbour_find (h, &cim->id);
1749       if (n == NULL)
1750           n = neighbour_add (h, &cim->id);
1751       if (n == NULL)
1752                  return;
1753       GNUNET_break (n->is_connected == GNUNET_NO);
1754       n->is_connected = GNUNET_YES;
1755       /* FIXME */
1756       if (h->nc_cb != NULL)
1757           h->nc_cb (h->cls, &n->id,
1758                   &cim->ats,ats_count);
1759       /* FIXEND */
1760       break;
1761     case GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT:
1762       if (size != sizeof (struct DisconnectInfoMessage))
1763         {
1764           GNUNET_break (0);
1765           break;
1766         }
1767       dim = (const struct DisconnectInfoMessage *) msg;
1768       GNUNET_break (ntohl (dim->reserved) == 0);
1769 #if DEBUG_TRANSPORT_DISCONNECT
1770       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1771                   "Receiving `%s' message for `%4s'.\n",
1772                   "DISCONNECT",
1773                   GNUNET_i2s (&dim->peer));
1774 #endif
1775       n = neighbour_find (h, &dim->peer);
1776       GNUNET_break (n != NULL);
1777       if (n != NULL)
1778         neighbour_disconnect (n);
1779       break;
1780     case GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK:
1781       if (size != sizeof (struct SendOkMessage))
1782         {
1783           GNUNET_break (0);
1784           break;
1785         }
1786       okm = (const struct SendOkMessage *) msg;
1787 #if DEBUG_TRANSPORT
1788       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1789                   "Receiving `%s' message, transmission %s.\n", "SEND_OK",
1790                   ntohl (okm->success) == GNUNET_OK ? "succeeded" : "failed");
1791 #endif
1792       n = neighbour_find (h, &okm->peer);
1793       GNUNET_assert (n != NULL);
1794       switch (n->transmit_stage)
1795         {
1796         case TS_NEW:
1797           GNUNET_break (0);
1798           break;
1799         case TS_QUEUED:
1800           GNUNET_break (0);
1801           break;
1802         case TS_TRANSMITTED:
1803           n->transmit_stage = TS_NEW;
1804           break;
1805         case TS_TRANSMITTED_QUEUED:
1806           n->transmit_stage = TS_QUEUED;
1807           schedule_transmission (h);
1808           break;
1809         default:
1810           GNUNET_break (0);
1811         }
1812       break;
1813     case GNUNET_MESSAGE_TYPE_TRANSPORT_RECV:
1814 #if DEBUG_TRANSPORT
1815       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1816                   "Receiving `%s' message.\n", "RECV");
1817 #endif
1818       if (size <
1819           sizeof (struct InboundMessage) +
1820           sizeof (struct GNUNET_MessageHeader))
1821         {
1822           GNUNET_break (0);
1823           break;
1824         }
1825       im = (const struct InboundMessage *) msg;
1826       GNUNET_break (0 == ntohl (im->reserved));
1827       ats_count = ntohl(im->ats_count);
1828       //imm = (const struct GNUNET_MessageHeader *) &im[1];
1829       imm = (const struct GNUNET_MessageHeader *) &((&(im->ats))[ats_count+1]);
1830
1831       if (ntohs (imm->size) + sizeof (struct InboundMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information) != size)
1832         {
1833           GNUNET_break (0);
1834           break;
1835         }
1836 #if DEBUG_TRANSPORT
1837       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1838                   "Received message of type %u from `%4s'.\n",
1839                   ntohs (imm->type), GNUNET_i2s (&im->peer));
1840 #endif
1841       n = neighbour_find (h, &im->peer);
1842       if (n == NULL)
1843         {
1844           GNUNET_break (0);
1845           break;
1846         }
1847       if (n->is_connected != GNUNET_YES)
1848         {
1849           GNUNET_break (0);
1850           break;
1851         }
1852       /* FIXME: */
1853       if (h->rec != NULL)
1854                 h->rec (h->cls, &im->peer, imm,
1855                         &im->ats, ats_count);
1856       /* ENDFIX */
1857       break;
1858     default:
1859       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1860                   _
1861                   ("Received unexpected message of type %u in %s:%u\n"),
1862                   ntohs (msg->type), __FILE__, __LINE__);
1863       GNUNET_break (0);
1864       break;
1865     }
1866 }
1867
1868
1869 /**
1870  * Called when our transmit request timed out before any transport
1871  * reported success connecting to the desired peer or before the
1872  * transport was ready to receive.  Signal error and free
1873  * TransmitHandle.
1874  *
1875  * @param cls the 'struct GNUNET_TRANSPORT_TransmitHandle*' that is timing out
1876  * @param tc scheduler context
1877  */
1878 static void
1879 peer_transmit_timeout (void *cls,
1880                        const struct GNUNET_SCHEDULER_TaskContext *tc)
1881 {
1882   struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
1883   struct NeighbourList *n;
1884   GNUNET_CONNECTION_TransmitReadyNotify notify;
1885   void *notify_cls;
1886
1887   th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1888   n = th->neighbour;
1889 #if DEBUG_TRANSPORT
1890   GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1891               "Triggering timeout for request to transmit to `%4s' (%d)\n",
1892               GNUNET_i2s (&n->id),
1893               n->transmit_stage);
1894 #endif
1895   notify = th->notify;
1896   th->notify = NULL;
1897   notify_cls = th->notify_cls;
1898   switch (n->transmit_stage)
1899     {
1900     case TS_NEW:
1901       GNUNET_break (0);
1902       break;
1903     case TS_QUEUED:
1904       n->transmit_stage = TS_NEW;
1905       if (n->is_connected == GNUNET_NO)
1906         neighbour_free (n);
1907       break;
1908     case TS_TRANSMITTED:
1909       GNUNET_break (0);
1910       break;
1911     case TS_TRANSMITTED_QUEUED:
1912       n->transmit_stage = TS_TRANSMITTED;
1913       break;
1914     default:
1915       GNUNET_break (0);
1916     }
1917   if (NULL != notify)
1918     notify (notify_cls, 0, NULL);
1919 }
1920
1921
1922 /**
1923  * Check if we could queue a message of the given size for
1924  * transmission.  The transport service will take both its
1925  * internal buffers and bandwidth limits imposed by the
1926  * other peer into consideration when answering this query.
1927  *
1928  * @param handle connection to transport service
1929  * @param target who should receive the message
1930  * @param size how big is the message we want to transmit?
1931  * @param priority how important is the message?
1932  * @param timeout after how long should we give up (and call
1933  *        notify with buf NULL and size 0)?
1934  * @param notify function to call when we are ready to
1935  *        send such a message
1936  * @param notify_cls closure for notify
1937  * @return NULL if someone else is already waiting to be notified
1938  *         non-NULL if the notify callback was queued (can be used to cancel
1939  *         using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
1940  */
1941 struct GNUNET_TRANSPORT_TransmitHandle *
1942 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle
1943                                         *handle,
1944                                         const struct GNUNET_PeerIdentity
1945                                         *target, size_t size,
1946                                         uint32_t priority,
1947                                         struct GNUNET_TIME_Relative timeout,
1948                                         GNUNET_CONNECTION_TransmitReadyNotify
1949                                         notify, void *notify_cls)
1950 {
1951   struct GNUNET_TRANSPORT_TransmitHandle *th;
1952   struct NeighbourList *n;
1953
1954   if (size + sizeof (struct OutboundMessage) >=
1955       GNUNET_SERVER_MAX_MESSAGE_SIZE)
1956     {
1957 #if DEBUG_TRANSPORT
1958       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1959                   "Message size is %d, max allowed is %d.\n",
1960                   size + sizeof (struct OutboundMessage), GNUNET_SERVER_MAX_MESSAGE_SIZE - 1);
1961 #endif
1962       GNUNET_break (0);
1963       return NULL;
1964     }
1965 #if DEBUG_TRANSPORT
1966   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1967               "Asking transport service for transmission of %u bytes to peer `%4s' within %llu ms.\n",
1968               size, GNUNET_i2s (target),
1969               (unsigned long long) timeout.rel_value);
1970 #endif
1971   n = neighbour_find (handle, target);
1972   if (n == NULL)
1973     {
1974       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1975                   "Created neighbour entry for peer `%s'\n",
1976                   GNUNET_i2s (target));
1977       n = neighbour_add (handle, target);
1978     }
1979   if (n == NULL)
1980     {
1981       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1982                   "Could not create neighbour entry for peer `%s'\n",
1983                   GNUNET_i2s (target));
1984       return NULL;
1985     }
1986
1987   /**
1988    *  Send a request connect message if not connected,
1989    *  otherwise we will never send anything to
1990    *  transport service
1991    */
1992   if (n->is_connected == GNUNET_NO)
1993     {
1994       send_request_connect_message(handle, n);
1995     }
1996
1997   switch (n->transmit_stage)
1998     {
1999     case TS_NEW:
2000       n->transmit_stage = TS_QUEUED;
2001       break;
2002     case TS_QUEUED:
2003       GNUNET_break (0);
2004       return NULL;
2005     case TS_TRANSMITTED:
2006       n->transmit_stage = TS_TRANSMITTED_QUEUED;
2007       break;
2008     case TS_TRANSMITTED_QUEUED:
2009       GNUNET_break (0);
2010       return NULL;
2011     default:
2012       GNUNET_break (0);
2013       return NULL;
2014     }
2015   th = &n->transmit_handle;
2016   th->neighbour = n;
2017   th->notify = notify;
2018   th->notify_cls = notify_cls;
2019   th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
2020   th->notify_size = size + sizeof (struct OutboundMessage);
2021   th->priority = priority;
2022   th->notify_delay_task
2023     = GNUNET_SCHEDULER_add_delayed (timeout,
2024                                     &peer_transmit_timeout, th);
2025   schedule_transmission (handle);
2026   return th;
2027 }
2028
2029
2030 /**
2031  * Cancel the specified transmission-ready notification.
2032  */
2033 void
2034 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
2035                                                GNUNET_TRANSPORT_TransmitHandle
2036                                                *th)
2037 {
2038   struct NeighbourList *n;
2039
2040   th->notify = NULL;
2041   n = th->neighbour;
2042 #if DEBUG_TRANSPORT
2043   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2044               "Transmission request of %u bytes to `%4s' was canceled.\n",
2045               th->notify_size - sizeof (struct OutboundMessage),
2046               GNUNET_i2s (&n->id));
2047 #endif
2048   if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
2049     {
2050       GNUNET_SCHEDULER_cancel (th->notify_delay_task);
2051       th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
2052     }
2053   switch (n->transmit_stage)
2054     {
2055     case TS_NEW:
2056       GNUNET_assert (0);
2057       break;
2058     case TS_QUEUED:
2059       n->transmit_stage = TS_NEW;
2060       if ( (n->in_disconnect == GNUNET_NO) &&
2061            (n->is_connected == GNUNET_NO) )
2062         neighbour_free (n);
2063       break;
2064     case TS_TRANSMITTED:
2065       GNUNET_break (0);
2066       break;
2067     case TS_TRANSMITTED_QUEUED:
2068       n->transmit_stage = TS_TRANSMITTED;
2069       break;
2070     default:
2071       GNUNET_break (0);
2072     }
2073 }
2074
2075
2076 /* end of transport_api.c */