src/util/client.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001-2013 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 util/client.c
  23  * @brief code for access to services
  24  * @author Christian Grothoff
  25  *
  26  * Generic TCP code for reliable, record-oriented TCP
  27  * connections between clients and service providers.
  28  */
  29 #include "platform.h"
  30 #include "gnunet_protocols.h"
  31 #include "gnunet_util_lib.h"
  32
  33
  34 /**
  35  * How often do we re-try tranmsitting requests before giving up?
  36  * Note that if we succeeded transmitting a request but failed to read
  37  * a response, we do NOT re-try.
  38  */
  39 #define MAX_ATTEMPTS 50
  40
  41 #define LOG(kind,...) GNUNET_log_from (kind, "util",__VA_ARGS__)
  42
  43 /**
  44  * Handle for a transmission request.
  45  */
  46 struct GNUNET_CLIENT_TransmitHandle
  47 {
  48   /**
  49    * Connection state.
  50    */
  51   struct GNUNET_CLIENT_Connection *client;
  52
  53   /**
  54    * Function to call to get the data for transmission.
  55    */
  56   GNUNET_CONNECTION_TransmitReadyNotify notify;
  57
  58   /**
  59    * Closure for @e notify.
  60    */
  61   void *notify_cls;
  62
  63   /**
  64    * Handle to the transmission with the underlying
  65    * connection.
  66    */
  67   struct GNUNET_CONNECTION_TransmitHandle *th;
  68
  69   /**
  70    * If we are re-trying and are delaying to do so,
  71    * handle to the scheduled task managing the delay.
  72    */
  73   struct GNUNET_SCHEDULER_Task * reconnect_task;
  74
  75   /**
  76    * Timeout for the operation overall.
  77    */
  78   struct GNUNET_TIME_Absolute timeout;
  79
  80   /**
  81    * Number of bytes requested.
  82    */
  83   size_t size;
  84
  85   /**
  86    * Are we allowed to re-try to connect without telling
  87    * the user (of this API) about the connection troubles?
  88    */
  89   int auto_retry;
  90
  91   /**
  92    * Number of attempts left for transmitting the request.  We may
  93    * fail the first time (say because the service is not yet up), in
  94    * which case (if auto_retry is set) we wait a bit and re-try
  95    * (timeout permitting).
  96    */
  97   unsigned int attempts_left;
  98
  99 };
 100
 101
 102 /**
 103  * Context for processing
 104  * "GNUNET_CLIENT_transmit_and_get_response" requests.
 105  */
 106 struct TransmitGetResponseContext
 107 {
 108   /**
 109    * Client handle.
 110    */
 111   struct GNUNET_CLIENT_Connection *client;
 112
 113   /**
 114    * Message to transmit; do not free, allocated
 115    * right after this struct.
 116    */
 117   const struct GNUNET_MessageHeader *hdr;
 118
 119   /**
 120    * Timeout to use.
 121    */
 122   struct GNUNET_TIME_Absolute timeout;
 123
 124   /**
 125    * Function to call when done.
 126    */
 127   GNUNET_CLIENT_MessageHandler rn;
 128
 129   /**
 130    * Closure for @e rn.
 131    */
 132   void *rn_cls;
 133 };
 134
 135 /**
 136  * Struct to refer to a GNUnet TCP connection.
 137  * This is more than just a socket because if the server
 138  * drops the connection, the client automatically tries
 139  * to reconnect (and for that needs connection information).
 140  */
 141 struct GNUNET_CLIENT_Connection
 142 {
 143
 144   /**
 145    * The connection handle, NULL if not live
 146    */
 147   struct GNUNET_CONNECTION_Handle *connection;
 148
 149   /**
 150    * Our configuration.
 151    */
 152   const struct GNUNET_CONFIGURATION_Handle *cfg;
 153
 154   /**
 155    * Name of the service we interact with.
 156    */
 157   char *service_name;
 158
 159   /**
 160    * Context of a transmit_and_get_response operation, NULL
 161    * if no such operation is pending.
 162    */
 163   struct TransmitGetResponseContext *tag;
 164
 165   /**
 166    * Handler for current receiver task.
 167    */
 168   GNUNET_CLIENT_MessageHandler receiver_handler;
 169
 170   /**
 171    * Closure for @e receiver_handler.
 172    */
 173   void *receiver_handler_cls;
 174
 175   /**
 176    * Handle for a pending transmission request, NULL if there is
 177    * none pending.
 178    */
 179   struct GNUNET_CLIENT_TransmitHandle *th;
 180
 181   /**
 182    * If we are re-trying and are delaying to do so,
 183    * handle to the scheduled task managing the delay.
 184    */
 185   struct GNUNET_SCHEDULER_Task * receive_task;
 186
 187   /**
 188    * Buffer for received message.
 189    */
 190   char *received_buf;
 191
 192   /**
 193    * Timeout for receiving a response (absolute time).
 194    */
 195   struct GNUNET_TIME_Absolute receive_timeout;
 196
 197   /**
 198    * Current value for our incremental back-off (for
 199    * connect re-tries).
 200    */
 201   struct GNUNET_TIME_Relative back_off;
 202
 203   /**
 204    * Number of bytes in received_buf that are valid.
 205    */
 206   size_t received_pos;
 207
 208   /**
 209    * Size of received_buf.
 210    */
 211   unsigned int received_size;
 212
 213   /**
 214    * Do we have a complete response in received_buf?
 215    */
 216   int msg_complete;
 217
 218   /**
 219    * Are we currently busy doing receive-processing?
 220    * #GNUNET_YES if so, #GNUNET_NO if not.
 221    */
 222   int in_receive;
 223
 224   /**
 225    * Is this the first message we are sending to the service?
 226    */
 227   int first_message;
 228
 229   /**
 230    * How often have we tried to connect?
 231    */
 232   unsigned int attempts;
 233
 234 };
 235
 236
 237 /**
 238  * Try connecting to the server using UNIX domain sockets.
 239  *
 240  * @param service_name name of service to connect to
 241  * @param cfg configuration to use
 242  * @return NULL on error, connection to UNIX otherwise
 243  */
 244 static struct GNUNET_CONNECTION_Handle *
 245 try_unixpath (const char *service_name,
 246               const struct GNUNET_CONFIGURATION_Handle *cfg)
 247 {
 248 #if AF_UNIX
 249   struct GNUNET_CONNECTION_Handle *connection;
 250   char *unixpath;
 251   struct sockaddr_un s_un;
 252
 253   unixpath = NULL;
 254   if ((GNUNET_OK == GNUNET_CONFIGURATION_get_value_filename (cfg, service_name, "UNIXPATH", &unixpath)) &&
 255       (0 < strlen (unixpath)))
 256   {
 257     /* We have a non-NULL unixpath, need to validate it */
 258     if (strlen (unixpath) >= sizeof (s_un.sun_path))
 259     {
 260       LOG (GNUNET_ERROR_TYPE_WARNING,
 261            _("UNIXPATH `%s' too long, maximum length is %llu\n"), unixpath,
 262            (unsigned long long) sizeof (s_un.sun_path));
 263       unixpath = GNUNET_NETWORK_shorten_unixpath (unixpath);
 264       LOG (GNUNET_ERROR_TYPE_INFO,
 265            _("Using `%s' instead\n"), unixpath);
 266       if (NULL == unixpath)
 267         return NULL;
 268     }
 269     connection = GNUNET_CONNECTION_create_from_connect_to_unixpath (cfg, unixpath);
 270     if (NULL != connection)
 271     {
 272       LOG (GNUNET_ERROR_TYPE_DEBUG, "Connected to unixpath `%s'!\n",
 273            unixpath);
 274       GNUNET_free (unixpath);
 275       return connection;
 276     }
 277   }
 278   GNUNET_free_non_null (unixpath);
 279 #endif
 280   return NULL;
 281 }
 282
 283
 284 /**
 285  * Test whether the configuration has proper values for connection
 286  * (UNIXPATH || (PORT && HOSTNAME)).
 287  *
 288  * @param service_name name of service to connect to
 289  * @param cfg configuration to use
 290  * @return #GNUNET_OK if the configuration is valid, #GNUNET_SYSERR if not
 291  */
 292 static int
 293 test_service_configuration (const char *service_name,
 294                             const struct GNUNET_CONFIGURATION_Handle *cfg)
 295 {
 296   int ret = GNUNET_SYSERR;
 297   char *hostname = NULL;
 298   unsigned long long port;
 299 #if AF_UNIX
 300   char *unixpath = NULL;
 301
 302   if ((GNUNET_OK == GNUNET_CONFIGURATION_get_value_filename (cfg, service_name, "UNIXPATH", &unixpath)) &&
 303       (0 < strlen (unixpath)))
 304     ret = GNUNET_OK;
 305   GNUNET_free_non_null (unixpath);
 306 #endif
 307
 308   if ( (GNUNET_YES ==
 309         GNUNET_CONFIGURATION_have_value (cfg, service_name, "PORT")) &&
 310        (GNUNET_OK ==
 311         GNUNET_CONFIGURATION_get_value_number (cfg, service_name, "PORT", &port)) &&
 312        (port <= 65535) && (0 != port) &&
 313        (GNUNET_OK ==
 314         GNUNET_CONFIGURATION_get_value_string (cfg, service_name, "HOSTNAME",
 315                                                &hostname)) &&
 316        (0 != strlen (hostname)) )
 317     ret = GNUNET_OK;
 318   GNUNET_free_non_null (hostname);
 319   return ret;
 320 }
 321
 322
 323 /**
 324  * Try to connect to the service.
 325  *
 326  * @param service_name name of service to connect to
 327  * @param cfg configuration to use
 328  * @param attempt counter used to alternate between IP and UNIX domain sockets
 329  * @return NULL on error
 330  */
 331 static struct GNUNET_CONNECTION_Handle *
 332 do_connect (const char *service_name,
 333             const struct GNUNET_CONFIGURATION_Handle *cfg,
 334             unsigned int attempt)
 335 {
 336   struct GNUNET_CONNECTION_Handle *connection;
 337   char *hostname;
 338   unsigned long long port;
 339
 340   connection = NULL;
 341   if (0 == (attempt % 2))
 342   {
 343     /* on even rounds, try UNIX first */
 344     connection = try_unixpath (service_name, cfg);
 345     if (NULL != connection)
 346       return connection;
 347   }
 348   if (GNUNET_YES ==
 349       GNUNET_CONFIGURATION_have_value (cfg, service_name, "PORT"))
 350   {
 351     if ((GNUNET_OK !=
 352          GNUNET_CONFIGURATION_get_value_number (cfg, service_name, "PORT", &port))
 353         || (port > 65535) ||
 354         (GNUNET_OK !=
 355          GNUNET_CONFIGURATION_get_value_string (cfg, service_name, "HOSTNAME",
 356                                                 &hostname)))
 357     {
 358       LOG (GNUNET_ERROR_TYPE_WARNING,
 359            _
 360            ("Could not determine valid hostname and port for service `%s' from configuration.\n"),
 361            service_name);
 362       return NULL;
 363     }
 364     if (0 == strlen (hostname))
 365     {
 366       GNUNET_free (hostname);
 367       LOG (GNUNET_ERROR_TYPE_WARNING,
 368            _("Need a non-empty hostname for service `%s'.\n"), service_name);
 369       return NULL;
 370     }
 371   }
 372   else
 373   {
 374     /* unspecified means 0 (disabled) */
 375     port = 0;
 376     hostname = NULL;
 377   }
 378   if (0 == port)
 379   {
 380     /* if port is 0, try UNIX */
 381     connection = try_unixpath (service_name, cfg);
 382     if (NULL != connection)
 383     {
 384       GNUNET_free_non_null (hostname);
 385       return connection;
 386     }
 387     LOG (GNUNET_ERROR_TYPE_DEBUG,
 388          "Port is 0 for service `%s', UNIXPATH did not work, returning NULL!\n",
 389          service_name);
 390     GNUNET_free_non_null (hostname);
 391     return NULL;
 392   }
 393   connection = GNUNET_CONNECTION_create_from_connect (cfg, hostname, port);
 394   GNUNET_free (hostname);
 395   return connection;
 396 }
 397
 398
 399 /**
 400  * Get a connection with a service.
 401  *
 402  * @param service_name name of the service
 403  * @param cfg configuration to use
 404  * @return NULL on error (service unknown to configuration)
 405  */
 406 struct GNUNET_CLIENT_Connection *
 407 GNUNET_CLIENT_connect (const char *service_name,
 408                        const struct GNUNET_CONFIGURATION_Handle *cfg)
 409 {
 410   struct GNUNET_CLIENT_Connection *client;
 411   struct GNUNET_CONNECTION_Handle *connection;
 412
 413   if (GNUNET_OK !=
 414       test_service_configuration (service_name,
 415                                   cfg))
 416     return NULL;
 417   connection = do_connect (service_name, cfg, 0);
 418   client = GNUNET_new (struct GNUNET_CLIENT_Connection);
 419   client->first_message = GNUNET_YES;
 420   client->attempts = 1;
 421   client->connection = connection;
 422   client->service_name = GNUNET_strdup (service_name);
 423   client->cfg = cfg;
 424   client->back_off = GNUNET_TIME_UNIT_MILLISECONDS;
 425   return client;
 426 }
 427
 428
 429 /**
 430  * Destroy connection with the service.  This will automatically
 431  * cancel any pending "receive" request (however, the handler will
 432  * *NOT* be called, not even with a NULL message).  Any pending
 433  * transmission request will also be cancelled UNLESS the callback for
 434  * the transmission request has already been called, in which case the
 435  * transmission 'finish_pending_write' argument determines whether or
 436  * not the write is guaranteed to complete before the socket is fully
 437  * destroyed (unless, of course, there is an error with the server in
 438  * which case the message may still be lost).
 439  *
 440  * @param client handle to the service connection
 441  */
 442 void
 443 GNUNET_CLIENT_disconnect (struct GNUNET_CLIENT_Connection *client)
 444 {
 445   if (GNUNET_YES == client->in_receive)
 446   {
 447     GNUNET_CONNECTION_receive_cancel (client->connection);
 448     client->in_receive = GNUNET_NO;
 449   }
 450   if (NULL != client->th)
 451   {
 452     GNUNET_CLIENT_notify_transmit_ready_cancel (client->th);
 453     client->th = NULL;
 454   }
 455   if (NULL != client->connection)
 456   {
 457     GNUNET_CONNECTION_destroy (client->connection);
 458     client->connection = NULL;
 459   }
 460   if (NULL != client->receive_task)
 461   {
 462     GNUNET_SCHEDULER_cancel (client->receive_task);
 463     client->receive_task = NULL;
 464   }
 465   if (NULL != client->tag)
 466   {
 467     GNUNET_free (client->tag);
 468     client->tag = NULL;
 469   }
 470   client->receiver_handler = NULL;
 471   GNUNET_array_grow (client->received_buf, client->received_size, 0);
 472   GNUNET_free (client->service_name);
 473   GNUNET_free (client);
 474 }
 475
 476
 477 /**
 478  * Check if message is complete.  Sets the "msg_complete" member
 479  * in the client struct.
 480  *
 481  * @param client connection with the buffer to check
 482  */
 483 static void
 484 check_complete (struct GNUNET_CLIENT_Connection *client)
 485 {
 486   if ((client->received_pos >= sizeof (struct GNUNET_MessageHeader)) &&
 487       (client->received_pos >=
 488        ntohs (((const struct GNUNET_MessageHeader *) client->received_buf)->
 489               size)))
 490     client->msg_complete = GNUNET_YES;
 491 }
 492
 493
 494 /**
 495  * Callback function for data received from the network.  Note that
 496  * both @a available and @a errCode would be 0 if the read simply timed out.
 497  *
 498  * @param cls closure
 499  * @param buf pointer to received data
 500  * @param available number of bytes availabe in @a buf,
 501  *        possibly 0 (on errors)
 502  * @param addr address of the sender
 503  * @param addrlen size of @a addr
 504  * @param errCode value of errno (on errors receiving)
 505  */
 506 static void
 507 receive_helper (void *cls, const void *buf, size_t available,
 508                 const struct sockaddr *addr, socklen_t addrlen, int errCode)
 509 {
 510   struct GNUNET_CLIENT_Connection *client = cls;
 511   struct GNUNET_TIME_Relative remaining;
 512   GNUNET_CLIENT_MessageHandler receive_handler;
 513   void *receive_handler_cls;
 514
 515   GNUNET_assert (GNUNET_NO == client->msg_complete);
 516   GNUNET_assert (GNUNET_YES == client->in_receive);
 517   client->in_receive = GNUNET_NO;
 518   if ((0 == available) || (NULL == client->connection) || (0 != errCode))
 519   {
 520     /* signal timeout! */
 521     LOG (GNUNET_ERROR_TYPE_DEBUG,
 522          "Timeout in receive_helper, available %u, client->connection %s, errCode `%s'\n",
 523          (unsigned int) available, NULL == client->connection ? "NULL" : "non-NULL",
 524          STRERROR (errCode));
 525     if (NULL != (receive_handler = client->receiver_handler))
 526     {
 527       receive_handler_cls = client->receiver_handler_cls;
 528       client->receiver_handler = NULL;
 529       receive_handler (receive_handler_cls, NULL);
 530     }
 531     return;
 532   }
 533   /* FIXME: optimize for common fast case where buf contains the
 534    * entire message and we need no copying... */
 535
 536   /* slow path: append to array */
 537   if (client->received_size < client->received_pos + available)
 538     GNUNET_array_grow (client->received_buf, client->received_size,
 539                        client->received_pos + available);
 540   memcpy (&client->received_buf[client->received_pos], buf, available);
 541   client->received_pos += available;
 542   check_complete (client);
 543   /* check for timeout */
 544   remaining = GNUNET_TIME_absolute_get_remaining (client->receive_timeout);
 545   if (0 == remaining.rel_value_us)
 546   {
 547     /* signal timeout! */
 548     if (NULL != (receive_handler = client->receiver_handler))
 549     {
 550       client->receiver_handler = NULL;
 551       receive_handler (client->receiver_handler_cls, NULL);
 552     }
 553     return;
 554   }
 555   /* back to receive -- either for more data or to call callback! */
 556   GNUNET_CLIENT_receive (client, client->receiver_handler,
 557                          client->receiver_handler_cls, remaining);
 558 }
 559
 560
 561 /**
 562  * Continuation to call the receive callback.
 563  *
 564  * @param cls  our handle to the client connection
 565  * @param tc scheduler context
 566  */
 567 static void
 568 receive_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 569 {
 570   struct GNUNET_CLIENT_Connection *client = cls;
 571   GNUNET_CLIENT_MessageHandler handler = client->receiver_handler;
 572   const struct GNUNET_MessageHeader *cmsg =
 573       (const struct GNUNET_MessageHeader *) client->received_buf;
 574   void *handler_cls = client->receiver_handler_cls;
 575   uint16_t msize = ntohs (cmsg->size);
 576   char mbuf[msize] GNUNET_ALIGN;
 577   struct GNUNET_MessageHeader *msg = (struct GNUNET_MessageHeader *) mbuf;
 578
 579   LOG (GNUNET_ERROR_TYPE_DEBUG,
 580        "Received message of type %u and size %u from %s service.\n",
 581        ntohs (cmsg->type),
 582        msize,
 583        client->service_name);
 584   client->receive_task = NULL;
 585   GNUNET_assert (GNUNET_YES == client->msg_complete);
 586   GNUNET_assert (client->received_pos >= msize);
 587   memcpy (msg, cmsg, msize);
 588   memmove (client->received_buf, &client->received_buf[msize],
 589            client->received_pos - msize);
 590   client->received_pos -= msize;
 591   client->msg_complete = GNUNET_NO;
 592   client->receiver_handler = NULL;
 593   check_complete (client);
 594   if (NULL != handler)
 595     handler (handler_cls, msg);
 596 }
 597
 598
 599 /**
 600  * Read from the service.
 601  *
 602  * @param client the service
 603  * @param handler function to call with the message
 604  * @param handler_cls closure for @a handler
 605  * @param timeout how long to wait until timing out
 606  */
 607 void
 608 GNUNET_CLIENT_receive (struct GNUNET_CLIENT_Connection *client,
 609                        GNUNET_CLIENT_MessageHandler handler,
 610                        void *handler_cls,
 611                        struct GNUNET_TIME_Relative timeout)
 612 {
 613   if (NULL == client->connection)
 614   {
 615     /* already disconnected, fail instantly! */
 616     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 617                 "Client API violation for service `%s'\n",
 618                 client->service_name);
 619     GNUNET_break (0);           /* this should not happen in well-written code! */
 620     if (NULL != handler)
 621       handler (handler_cls, NULL);
 622     return;
 623   }
 624   client->receiver_handler = handler;
 625   client->receiver_handler_cls = handler_cls;
 626   client->receive_timeout = GNUNET_TIME_relative_to_absolute (timeout);
 627   if (GNUNET_YES == client->msg_complete)
 628   {
 629     GNUNET_assert (NULL == client->receive_task);
 630     client->receive_task = GNUNET_SCHEDULER_add_now (&receive_task, client);
 631   }
 632   else
 633   {
 634     LOG (GNUNET_ERROR_TYPE_DEBUG, "calling GNUNET_CONNECTION_receive\n");
 635     GNUNET_assert (GNUNET_NO == client->in_receive);
 636     client->in_receive = GNUNET_YES;
 637     GNUNET_CONNECTION_receive (client->connection, GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
 638                                timeout, &receive_helper, client);
 639   }
 640 }
 641
 642
 643 /**
 644  * Handle for a test to check if a service is running.
 645  */
 646 struct GNUNET_CLIENT_TestHandle
 647 {
 648   /**
 649    * Function to call with the result of the test.
 650    */
 651   GNUNET_CLIENT_TestResultCallback cb;
 652
 653   /**
 654    * Closure for @e cb.
 655    */
 656   void *cb_cls;
 657
 658   /**
 659    * Client connection we are using for the test, if any.
 660    */
 661   struct GNUNET_CLIENT_Connection *client;
 662
 663   /**
 664    * Handle for the transmission request, if any.
 665    */
 666   struct GNUNET_CLIENT_TransmitHandle *th;
 667
 668   /**
 669    * Deadline for calling @e cb.
 670    */
 671   struct GNUNET_TIME_Absolute test_deadline;
 672
 673   /**
 674    * ID of task used for asynchronous operations.
 675    */
 676   struct GNUNET_SCHEDULER_Task * task;
 677
 678   /**
 679    * Final result to report back (once known).
 680    */
 681   int result;
 682 };
 683
 684
 685 /**
 686  * Abort testing for service.
 687  *
 688  * @param th test handle
 689  */
 690 void
 691 GNUNET_CLIENT_service_test_cancel (struct GNUNET_CLIENT_TestHandle *th)
 692 {
 693   if (NULL != th->th)
 694   {
 695     GNUNET_CLIENT_notify_transmit_ready_cancel (th->th);
 696     th->th = NULL;
 697   }
 698   if (NULL != th->client)
 699   {
 700     GNUNET_CLIENT_disconnect (th->client);
 701     th->client = NULL;
 702   }
 703   if (NULL != th->task)
 704   {
 705     GNUNET_SCHEDULER_cancel (th->task);
 706     th->task = NULL;
 707   }
 708   GNUNET_free (th);
 709 }
 710
 711
 712 /**
 713  * Task that reports back the result by calling the callback
 714  * and then cleans up.
 715  *
 716  * @param cls the `struct GNUNET_CLIENT_TestHandle`
 717  * @param tc scheduler context
 718  */
 719 static void
 720 report_result (void *cls,
 721                const struct GNUNET_SCHEDULER_TaskContext *tc)
 722 {
 723   struct GNUNET_CLIENT_TestHandle *th = cls;
 724
 725   th->task = NULL;
 726   th->cb (th->cb_cls, th->result);
 727   GNUNET_CLIENT_service_test_cancel (th);
 728 }
 729
 730
 731 /**
 732  * Report service test result asynchronously back to callback.
 733  *
 734  * @param th test handle with the result and the callback
 735  * @param result result to report
 736  */
 737 static void
 738 service_test_report (struct GNUNET_CLIENT_TestHandle *th,
 739                      int result)
 740 {
 741   th->result = result;
 742   th->task = GNUNET_SCHEDULER_add_now (&report_result,
 743                                        th);
 744 }
 745
 746
 747 /**
 748  * Receive confirmation from test, service is up.
 749  *
 750  * @param cls closure with the `struct GNUNET_CLIENT_TestHandle`
 751  * @param msg message received, NULL on timeout or fatal error
 752  */
 753 static void
 754 confirm_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 755 {
 756   struct GNUNET_CLIENT_TestHandle *th = cls;
 757
 758   /* We may want to consider looking at the reply in more
 759    * detail in the future, for example, is this the
 760    * correct service? FIXME! */
 761   if (NULL != msg)
 762   {
 763     LOG (GNUNET_ERROR_TYPE_DEBUG,
 764          "Received confirmation that service is running.\n");
 765     service_test_report (th, GNUNET_YES);
 766   }
 767   else
 768   {
 769     service_test_report (th, GNUNET_NO);
 770   }
 771 }
 772
 773
 774 /**
 775  * Send the 'TEST' message to the service.  If successful, prepare to
 776  * receive the reply.
 777  *
 778  * @param cls the `struct GNUNET_CLIENT_TestHandle` of the test
 779  * @param size number of bytes available in @a buf
 780  * @param buf where to write the message
 781  * @return number of bytes written to @a buf
 782  */
 783 static size_t
 784 write_test (void *cls, size_t size, void *buf)
 785 {
 786   struct GNUNET_CLIENT_TestHandle *th = cls;
 787   struct GNUNET_MessageHeader *msg;
 788
 789   th->th = NULL;
 790   if (size < sizeof (struct GNUNET_MessageHeader))
 791   {
 792     LOG (GNUNET_ERROR_TYPE_DEBUG,
 793          "Failed to transmit TEST request.\n");
 794     service_test_report (th, GNUNET_NO);
 795     return 0;                   /* client disconnected */
 796   }
 797   LOG (GNUNET_ERROR_TYPE_DEBUG,
 798        "Transmitting `%s' request.\n",
 799        "TEST");
 800   msg = (struct GNUNET_MessageHeader *) buf;
 801   msg->type = htons (GNUNET_MESSAGE_TYPE_TEST);
 802   msg->size = htons (sizeof (struct GNUNET_MessageHeader));
 803   GNUNET_CLIENT_receive (th->client,
 804                          &confirm_handler, th,
 805                          GNUNET_TIME_absolute_get_remaining
 806                          (th->test_deadline));
 807   return sizeof (struct GNUNET_MessageHeader);
 808 }
 809
 810
 811 /**
 812  * Test if the service is running.  If we are given a UNIXPATH or a
 813  * local address, we do this NOT by trying to connect to the service,
 814  * but by trying to BIND to the same port.  If the BIND fails, we know
 815  * the service is running.
 816  *
 817  * @param service name of the service to wait for
 818  * @param cfg configuration to use
 819  * @param timeout how long to wait at most
 820  * @param cb function to call with the result
 821  * @param cb_cls closure for @a cb
 822  * @return handle to cancel the test
 823  */
 824 struct GNUNET_CLIENT_TestHandle *
 825 GNUNET_CLIENT_service_test (const char *service,
 826                             const struct GNUNET_CONFIGURATION_Handle *cfg,
 827                             struct GNUNET_TIME_Relative timeout,
 828                             GNUNET_CLIENT_TestResultCallback cb,
 829                             void *cb_cls)
 830 {
 831   struct GNUNET_CLIENT_TestHandle *th;
 832   char *hostname;
 833   unsigned long long port;
 834   struct GNUNET_NETWORK_Handle *sock;
 835
 836   th = GNUNET_new (struct GNUNET_CLIENT_TestHandle);
 837   th->cb = cb;
 838   th->cb_cls = cb_cls;
 839   th->test_deadline = GNUNET_TIME_relative_to_absolute (timeout);
 840   LOG (GNUNET_ERROR_TYPE_DEBUG,
 841        "Testing if service `%s' is running.\n",
 842        service);
 843 #ifdef AF_UNIX
 844   {
 845     /* probe UNIX support */
 846     struct sockaddr_un s_un;
 847     char *unixpath;
 848     int abstract;
 849
 850     unixpath = NULL;
 851     if ((GNUNET_OK ==
 852          GNUNET_CONFIGURATION_get_value_filename (cfg,
 853                                                   service,
 854                                                   "UNIXPATH",
 855                                                   &unixpath)) &&
 856         (0 < strlen (unixpath)))  /* We have a non-NULL unixpath, does that mean it's valid? */
 857     {
 858       if (strlen (unixpath) >= sizeof (s_un.sun_path))
 859       {
 860         LOG (GNUNET_ERROR_TYPE_WARNING,
 861              _("UNIXPATH `%s' too long, maximum length is %llu\n"),
 862              unixpath,
 863              (unsigned long long) sizeof (s_un.sun_path));
 864         unixpath = GNUNET_NETWORK_shorten_unixpath (unixpath);
 865         LOG (GNUNET_ERROR_TYPE_INFO,
 866              _("Using `%s' instead\n"), unixpath);
 867       }
 868     }
 869 #ifdef LINUX
 870     abstract = GNUNET_CONFIGURATION_get_value_yesno (cfg,
 871                                                      "TESTING",
 872                                                      "USE_ABSTRACT_SOCKETS");
 873 #else
 874     abstract = GNUNET_NO;
 875 #endif
 876     if ((NULL != unixpath) && (GNUNET_YES != abstract))
 877     {
 878       if (GNUNET_SYSERR == GNUNET_DISK_directory_create_for_file (unixpath))
 879         GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 880                                   "mkdir", unixpath);
 881     }
 882     if (NULL != unixpath)
 883     {
 884       sock = GNUNET_NETWORK_socket_create (PF_UNIX, SOCK_STREAM, 0);
 885       if (NULL != sock)
 886       {
 887         memset (&s_un, 0, sizeof (s_un));
 888         s_un.sun_family = AF_UNIX;
 889         strncpy (s_un.sun_path, unixpath, sizeof (s_un.sun_path) - 1);
 890         if (GNUNET_YES == abstract)
 891           s_un.sun_path[0] = '\0';
 892 #if HAVE_SOCKADDR_IN_SIN_LEN
 893         s_un.sun_len = (u_char) sizeof (struct sockaddr_un);
 894 #endif
 895         if (GNUNET_OK !=
 896             GNUNET_NETWORK_socket_bind (sock, (const struct sockaddr *) &s_un,
 897                                         sizeof (struct sockaddr_un)))
 898         {
 899           /* failed to bind => service must be running */
 900           GNUNET_free (unixpath);
 901           (void) GNUNET_NETWORK_socket_close (sock);
 902           service_test_report (th, GNUNET_YES);
 903           return th;
 904         }
 905         (void) GNUNET_NETWORK_socket_close (sock);
 906         /* let's try IP */
 907       }
 908     }
 909     GNUNET_free_non_null (unixpath);
 910   }
 911 #endif
 912
 913   hostname = NULL;
 914   if ((GNUNET_OK !=
 915        GNUNET_CONFIGURATION_get_value_number (cfg, service, "PORT", &port)) ||
 916       (port > 65535) ||
 917       (GNUNET_OK !=
 918        GNUNET_CONFIGURATION_get_value_string (cfg, service, "HOSTNAME",
 919                                               &hostname)))
 920   {
 921     /* UNIXPATH failed (if possible) AND IP failed => error */
 922     service_test_report (th, GNUNET_SYSERR);
 923     return th;
 924   }
 925
 926   if (0 == strcmp ("localhost", hostname)
 927 #if !LINUX
 928       && 0
 929 #endif
 930       )
 931   {
 932     /* can test using 'bind' */
 933     struct sockaddr_in s_in;
 934
 935     memset (&s_in, 0, sizeof (s_in));
 936 #if HAVE_SOCKADDR_IN_SIN_LEN
 937     s_in.sin_len = sizeof (struct sockaddr_in);
 938 #endif
 939     s_in.sin_family = AF_INET;
 940     s_in.sin_port = htons (port);
 941
 942     sock = GNUNET_NETWORK_socket_create (AF_INET, SOCK_STREAM, 0);
 943     if (NULL != sock)
 944     {
 945       if (GNUNET_OK !=
 946           GNUNET_NETWORK_socket_bind (sock, (const struct sockaddr *) &s_in,
 947                                       sizeof (s_in)))
 948       {
 949         /* failed to bind => service must be running */
 950         GNUNET_free (hostname);
 951         (void) GNUNET_NETWORK_socket_close (sock);
 952         service_test_report (th, GNUNET_YES);
 953         return th;
 954       }
 955       (void) GNUNET_NETWORK_socket_close (sock);
 956     }
 957   }
 958
 959   if (0 == strcmp ("ip6-localhost", hostname)
 960 #if !LINUX
 961       && 0
 962 #endif
 963       )
 964   {
 965     /* can test using 'bind' */
 966     struct sockaddr_in6 s_in6;
 967
 968     memset (&s_in6, 0, sizeof (s_in6));
 969 #if HAVE_SOCKADDR_IN_SIN_LEN
 970     s_in6.sin6_len = sizeof (struct sockaddr_in6);
 971 #endif
 972     s_in6.sin6_family = AF_INET6;
 973     s_in6.sin6_port = htons (port);
 974
 975     sock = GNUNET_NETWORK_socket_create (AF_INET6, SOCK_STREAM, 0);
 976     if (NULL != sock)
 977     {
 978       if (GNUNET_OK !=
 979           GNUNET_NETWORK_socket_bind (sock, (const struct sockaddr *) &s_in6,
 980                                       sizeof (s_in6)))
 981       {
 982         /* failed to bind => service must be running */
 983         GNUNET_free (hostname);
 984         (void) GNUNET_NETWORK_socket_close (sock);
 985         service_test_report (th, GNUNET_YES);
 986         return th;
 987       }
 988       (void) GNUNET_NETWORK_socket_close (sock);
 989     }
 990   }
 991
 992   if (((0 == strcmp ("localhost", hostname)) ||
 993        (0 == strcmp ("ip6-localhost", hostname)))
 994 #if !LINUX
 995       && 0
 996 #endif
 997       )
 998   {
 999     /* all binds succeeded => claim service not running right now */
1000     GNUNET_free_non_null (hostname);
1001     service_test_report (th, GNUNET_NO);
1002     return th;
1003   }
1004   GNUNET_free_non_null (hostname);
1005
1006   /* non-localhost, try 'connect' method */
1007   th->client = GNUNET_CLIENT_connect (service, cfg);
1008   if (NULL == th->client)
1009   {
1010     LOG (GNUNET_ERROR_TYPE_INFO,
1011          _("Could not connect to service `%s', configuration broken.\n"),
1012          service);
1013     service_test_report (th, GNUNET_SYSERR);
1014     return th;
1015   }
1016   th->th = GNUNET_CLIENT_notify_transmit_ready (th->client,
1017                                                 sizeof (struct GNUNET_MessageHeader),
1018                                                 timeout, GNUNET_YES,
1019                                                 &write_test, th);
1020   if (NULL == th->th)
1021   {
1022     LOG (GNUNET_ERROR_TYPE_WARNING,
1023          _("Failure to transmit request to service `%s'\n"), service);
1024     service_test_report (th, GNUNET_SYSERR);
1025     return th;
1026   }
1027   return th;
1028 }
1029
1030
1031 /**
1032  * Connection notifies us about failure or success of
1033  * a transmission request.  Either pass it on to our
1034  * user or, if possible, retry.
1035  *
1036  * @param cls our `struct GNUNET_CLIENT_TransmissionHandle`
1037  * @param size number of bytes available for transmission
1038  * @param buf where to write them
1039  * @return number of bytes written to buf
1040  */
1041 static size_t
1042 client_notify (void *cls, size_t size, void *buf);
1043
1044
1045 /**
1046  * This task is run if we should re-try connection to the
1047  * service after a while.
1048  *
1049  * @param cls our `struct GNUNET_CLIENT_TransmitHandle` of the request
1050  * @param tc unused
1051  */
1052 static void
1053 client_delayed_retry (void *cls,
1054                       const struct GNUNET_SCHEDULER_TaskContext *tc)
1055 {
1056   struct GNUNET_CLIENT_TransmitHandle *th = cls;
1057   struct GNUNET_TIME_Relative delay;
1058
1059   th->reconnect_task = NULL;
1060   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1061   {
1062     /* give up, was shutdown */
1063     th->client->th = NULL;
1064     th->notify (th->notify_cls, 0, NULL);
1065     GNUNET_free (th);
1066     return;
1067   }
1068   th->client->connection =
1069     do_connect (th->client->service_name,
1070                 th->client->cfg,
1071                 th->client->attempts++);
1072   th->client->first_message = GNUNET_YES;
1073   if (NULL == th->client->connection)
1074   {
1075     /* could happen if we're out of sockets */
1076     delay = GNUNET_TIME_relative_min (GNUNET_TIME_absolute_get_remaining (th->timeout),
1077                                       th->client->back_off);
1078     th->client->back_off = GNUNET_TIME_STD_BACKOFF (th->client->back_off);
1079     LOG (GNUNET_ERROR_TYPE_DEBUG,
1080          "Transmission failed %u times, trying again in %s.\n",
1081          MAX_ATTEMPTS - th->attempts_left,
1082          GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
1083     GNUNET_assert (NULL == th->reconnect_task);
1084     th->reconnect_task =
1085         GNUNET_SCHEDULER_add_delayed (delay, &client_delayed_retry, th);
1086     return;
1087   }
1088   th->th =
1089       GNUNET_CONNECTION_notify_transmit_ready (th->client->connection, th->size,
1090                                                GNUNET_TIME_absolute_get_remaining
1091                                                (th->timeout), &client_notify,
1092                                                th);
1093   if (NULL == th->th)
1094   {
1095     GNUNET_break (0);
1096     th->client->th = NULL;
1097     th->notify (th->notify_cls, 0, NULL);
1098     GNUNET_free (th);
1099     return;
1100   }
1101 }
1102
1103
1104 /**
1105  * Connection notifies us about failure or success of a transmission
1106  * request.  Either pass it on to our user or, if possible, retry.
1107  *
1108  * @param cls our `struct GNUNET_CLIENT_TransmissionHandle`
1109  * @param size number of bytes available for transmission
1110  * @param buf where to write them
1111  * @return number of bytes written to @a buf
1112  */
1113 static size_t
1114 client_notify (void *cls, size_t size, void *buf)
1115 {
1116   struct GNUNET_CLIENT_TransmitHandle *th = cls;
1117   struct GNUNET_CLIENT_Connection *client = th->client;
1118   size_t ret;
1119   struct GNUNET_TIME_Relative delay;
1120
1121   LOG (GNUNET_ERROR_TYPE_DEBUG,
1122        "client_notify is running\n");
1123   th->th = NULL;
1124   client->th = NULL;
1125   if (NULL == buf)
1126   {
1127     delay = GNUNET_TIME_absolute_get_remaining (th->timeout);
1128     delay.rel_value_us /= 2;
1129     if ((GNUNET_YES != th->auto_retry) || (0 == --th->attempts_left) ||
1130         (delay.rel_value_us < 1)||
1131         (0 != (GNUNET_SCHEDULER_get_reason() & GNUNET_SCHEDULER_REASON_SHUTDOWN)))
1132     {
1133       LOG (GNUNET_ERROR_TYPE_DEBUG,
1134            "Transmission failed %u times, giving up.\n",
1135            MAX_ATTEMPTS - th->attempts_left);
1136       GNUNET_break (0 == th->notify (th->notify_cls, 0, NULL));
1137       GNUNET_free (th);
1138       return 0;
1139     }
1140     /* auto-retry */
1141     LOG (GNUNET_ERROR_TYPE_DEBUG,
1142          "Failed to connect to `%s', automatically trying again.\n",
1143          client->service_name);
1144     if (GNUNET_YES == client->in_receive)
1145     {
1146       GNUNET_CONNECTION_receive_cancel (client->connection);
1147       client->in_receive = GNUNET_NO;
1148     }
1149     GNUNET_CONNECTION_destroy (client->connection);
1150     client->connection = NULL;
1151     delay = GNUNET_TIME_relative_min (delay, client->back_off);
1152     client->back_off =
1153         GNUNET_TIME_relative_min (GNUNET_TIME_relative_multiply
1154                                   (client->back_off, 2),
1155                                   GNUNET_TIME_UNIT_SECONDS);
1156     LOG (GNUNET_ERROR_TYPE_DEBUG,
1157          "Transmission failed %u times, trying again in %s.\n",
1158          MAX_ATTEMPTS - th->attempts_left,
1159          GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
1160     client->th = th;
1161     GNUNET_assert (NULL == th->reconnect_task);
1162     th->reconnect_task =
1163         GNUNET_SCHEDULER_add_delayed (delay, &client_delayed_retry, th);
1164     return 0;
1165   }
1166   GNUNET_assert (size >= th->size);
1167   ret = th->notify (th->notify_cls, size, buf);
1168   GNUNET_free (th);
1169   if (sizeof (struct GNUNET_MessageHeader) <= ret)
1170   {
1171     LOG (GNUNET_ERROR_TYPE_DEBUG,
1172          "Transmitting message of type %u and size %u to %s service.\n",
1173          ntohs (((struct GNUNET_MessageHeader *) buf)->type),
1174          ntohs (((struct GNUNET_MessageHeader *) buf)->size),
1175          client->service_name);
1176   }
1177   return ret;
1178 }
1179
1180
1181 /**
1182  * Ask the client to call us once the specified number of bytes
1183  * are free in the transmission buffer.  Will never call the @a notify
1184  * callback in this task, but always first go into the scheduler.
1185  *
1186  * @param client connection to the service
1187  * @param size number of bytes to send
1188  * @param timeout after how long should we give up (and call
1189  *        notify with buf NULL and size 0)?
1190  * @param auto_retry if the connection to the service dies, should we
1191  *        automatically re-connect and retry (within the timeout period)
1192  *        or should we immediately fail in this case?  Pass GNUNET_YES
1193  *        if the caller does not care about temporary connection errors,
1194  *        for example because the protocol is stateless
1195  * @param notify function to call
1196  * @param notify_cls closure for @a notify
1197  * @return NULL if our buffer will never hold size bytes,
1198  *         a handle if the notify callback was queued (can be used to cancel)
1199  */
1200 struct GNUNET_CLIENT_TransmitHandle *
1201 GNUNET_CLIENT_notify_transmit_ready (struct GNUNET_CLIENT_Connection *client,
1202                                      size_t size,
1203                                      struct GNUNET_TIME_Relative timeout,
1204                                      int auto_retry,
1205                                      GNUNET_CONNECTION_TransmitReadyNotify notify,
1206                                      void *notify_cls)
1207 {
1208   struct GNUNET_CLIENT_TransmitHandle *th;
1209
1210   if (NULL != client->th)
1211   {
1212     /* If this breaks, you most likley called this function twice without waiting
1213      * for completion or canceling the request */
1214     GNUNET_assert (0);
1215     return NULL;
1216   }
1217   th = GNUNET_new (struct GNUNET_CLIENT_TransmitHandle);
1218   th->client = client;
1219   th->size = size;
1220   th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1221   /* always auto-retry on first message to service */
1222   th->auto_retry = (GNUNET_YES == client->first_message) ? GNUNET_YES : auto_retry;
1223   client->first_message = GNUNET_NO;
1224   th->notify = notify;
1225   th->notify_cls = notify_cls;
1226   th->attempts_left = MAX_ATTEMPTS;
1227   client->th = th;
1228   if (NULL == client->connection)
1229   {
1230     GNUNET_assert (NULL == th->reconnect_task);
1231     th->reconnect_task =
1232         GNUNET_SCHEDULER_add_delayed (client->back_off,
1233                                       &client_delayed_retry,
1234                                       th);
1235
1236   }
1237   else
1238   {
1239     th->th =
1240         GNUNET_CONNECTION_notify_transmit_ready (client->connection, size, timeout,
1241                                                  &client_notify, th);
1242     if (NULL == th->th)
1243     {
1244       GNUNET_break (0);
1245       GNUNET_free (th);
1246       client->th = NULL;
1247       return NULL;
1248     }
1249   }
1250   return th;
1251 }
1252
1253
1254 /**
1255  * Cancel a request for notification.
1256  *
1257  * @param th handle from the original request.
1258  */
1259 void
1260 GNUNET_CLIENT_notify_transmit_ready_cancel (struct GNUNET_CLIENT_TransmitHandle *th)
1261 {
1262   if (NULL != th->reconnect_task)
1263   {
1264     GNUNET_assert (NULL == th->th);
1265     GNUNET_SCHEDULER_cancel (th->reconnect_task);
1266     th->reconnect_task = NULL;
1267   }
1268   else
1269   {
1270     GNUNET_assert (NULL != th->th);
1271     GNUNET_CONNECTION_notify_transmit_ready_cancel (th->th);
1272   }
1273   th->client->th = NULL;
1274   GNUNET_free (th);
1275 }
1276
1277
1278 /**
1279  * Function called to notify a client about the socket
1280  * begin ready to queue the message.  @a buf will be
1281  * NULL and @a size zero if the socket was closed for
1282  * writing in the meantime.
1283  *
1284  * @param cls closure of type "struct TransmitGetResponseContext*"
1285  * @param size number of bytes available in @a buf
1286  * @param buf where the callee should write the message
1287  * @return number of bytes written to @a buf
1288  */
1289 static size_t
1290 transmit_for_response (void *cls,
1291                        size_t size,
1292                        void *buf)
1293 {
1294   struct TransmitGetResponseContext *tc = cls;
1295   uint16_t msize;
1296
1297   tc->client->tag = NULL;
1298   msize = ntohs (tc->hdr->size);
1299   if (NULL == buf)
1300   {
1301     LOG (GNUNET_ERROR_TYPE_DEBUG,
1302          _("Could not submit request, not expecting to receive a response.\n"));
1303     if (NULL != tc->rn)
1304       tc->rn (tc->rn_cls, NULL);
1305     GNUNET_free (tc);
1306     return 0;
1307   }
1308   GNUNET_assert (size >= msize);
1309   memcpy (buf, tc->hdr, msize);
1310   GNUNET_CLIENT_receive (tc->client, tc->rn, tc->rn_cls,
1311                          GNUNET_TIME_absolute_get_remaining (tc->timeout));
1312   GNUNET_free (tc);
1313   return msize;
1314 }
1315
1316
1317 /**
1318  * Convenience API that combines sending a request
1319  * to the service and waiting for a response.
1320  * If either operation times out, the callback
1321  * will be called with a "NULL" response (in which
1322  * case the connection should probably be destroyed).
1323  *
1324  * @param client connection to use
1325  * @param hdr message to transmit
1326  * @param timeout when to give up (for both transmission
1327  *         and for waiting for a response)
1328  * @param auto_retry if the connection to the service dies, should we
1329  *        automatically re-connect and retry (within the timeout period)
1330  *        or should we immediately fail in this case?  Pass GNUNET_YES
1331  *        if the caller does not care about temporary connection errors,
1332  *        for example because the protocol is stateless
1333  * @param rn function to call with the response
1334  * @param rn_cls closure for @a rn
1335  * @return #GNUNET_OK on success, #GNUNET_SYSERR if a request
1336  *         is already pending
1337  */
1338 int
1339 GNUNET_CLIENT_transmit_and_get_response (struct GNUNET_CLIENT_Connection *client,
1340                                          const struct GNUNET_MessageHeader *hdr,
1341                                          struct GNUNET_TIME_Relative timeout,
1342                                          int auto_retry,
1343                                          GNUNET_CLIENT_MessageHandler rn,
1344                                          void *rn_cls)
1345 {
1346   struct TransmitGetResponseContext *tc;
1347   uint16_t msize;
1348
1349   if (NULL != client->th)
1350     return GNUNET_SYSERR;
1351   GNUNET_assert (NULL == client->tag);
1352   msize = ntohs (hdr->size);
1353   tc = GNUNET_malloc (sizeof (struct TransmitGetResponseContext) + msize);
1354   tc->client = client;
1355   tc->hdr = (const struct GNUNET_MessageHeader *) &tc[1];
1356   memcpy (&tc[1], hdr, msize);
1357   tc->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1358   tc->rn = rn;
1359   tc->rn_cls = rn_cls;
1360   if (NULL ==
1361       GNUNET_CLIENT_notify_transmit_ready (client, msize, timeout, auto_retry,
1362                                            &transmit_for_response, tc))
1363   {
1364     GNUNET_break (0);
1365     GNUNET_free (tc);
1366     return GNUNET_SYSERR;
1367   }
1368   client->tag = tc;
1369   return GNUNET_OK;
1370 }
1371
1372
1373 /*  end of client.c */