dbus/dbus-connection.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-connection.c DBusConnection object
   3  *
   4  * Copyright (C) 2002, 2003  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24 #include "dbus-connection.h"
  25 #include "dbus-list.h"
  26 #include "dbus-timeout.h"
  27 #include "dbus-transport.h"
  28 #include "dbus-watch.h"
  29 #include "dbus-connection-internal.h"
  30 #include "dbus-list.h"
  31 #include "dbus-hash.h"
  32 #include "dbus-message-internal.h"
  33 #include "dbus-threads.h"
  34
  35 /**
  36  * @defgroup DBusConnection DBusConnection
  37  * @ingroup  DBus
  38  * @brief Connection to another application
  39  *
  40  * A DBusConnection represents a connection to another
  41  * application. Messages can be sent and received via this connection.
  42  *
  43  * The connection maintains a queue of incoming messages and a queue
  44  * of outgoing messages. dbus_connection_pop_message() and friends
  45  * can be used to read incoming messages from the queue.
  46  * Outgoing messages are automatically discarded as they are
  47  * written to the network.
  48  *
  49  * In brief a DBusConnection is a message queue associated with some
  50  * message transport mechanism such as a socket.
  51  *
  52  */
  53
  54 /**
  55  * @defgroup DBusConnectionInternals DBusConnection implementation details
  56  * @ingroup  DBusInternals
  57  * @brief Implementation details of DBusConnection
  58  *
  59  * @{
  60  */
  61
  62 /** default timeout value when waiting for a message reply */
  63 #define DEFAULT_TIMEOUT_VALUE (15 * 1000)
  64
  65 /** Opaque typedef for DBusDataSlot */
  66 typedef struct DBusDataSlot DBusDataSlot;
  67 /** DBusDataSlot is used to store application data on the connection */
  68 struct DBusDataSlot
  69 {
  70   void *data;                      /**< The application data */
  71   DBusFreeFunction free_data_func; /**< Free the application data */
  72 };
  73
  74 /**
  75  * Implementation details of DBusConnection. All fields are private.
  76  */
  77 struct DBusConnection
  78 {
  79   int refcount; /**< Reference count. */
  80
  81   DBusList *outgoing_messages; /**< Queue of messages we need to send, send the end of the list first. */
  82   DBusList *incoming_messages; /**< Queue of messages we have received, end of the list received most recently. */
  83
  84   int n_outgoing;              /**< Length of outgoing queue. */
  85   int n_incoming;              /**< Length of incoming queue. */
  86
  87   DBusTransport *transport;    /**< Object that sends/receives messages over network. */
  88   DBusWatchList *watches;      /**< Stores active watches. */
  89   DBusTimeoutList *timeouts;   /**< Stores active timeouts. */
  90
  91   DBusDisconnectFunction disconnect_function;      /**< Callback on disconnect. */
  92   void *disconnect_data;                           /**< Data for disconnect callback. */
  93   DBusFreeFunction disconnect_free_data_function;  /**< Free function for disconnect callback data. */
  94   DBusHashTable *handler_table; /**< Table of registered DBusMessageHandler */
  95   DBusList *filter_list;        /**< List of filters. */
  96   int filters_serial;           /**< Increments when the list of filters is changed. */
  97   int handlers_serial;          /**< Increments when the handler table is changed. */
  98   DBusDataSlot *data_slots;        /**< Data slots */
  99   int           n_slots; /**< Slots allocated so far. */
 100
 101   DBusCounter *connection_counter; /**< Counter that we decrement when finalized */
 102
 103   int client_serial;            /**< Client serial. Increments each time a message is sent  */
 104   unsigned int disconnect_notified : 1; /**< Already called disconnect_function */
 105 };
 106
 107 static void _dbus_connection_free_data_slots (DBusConnection *connection);
 108
 109 /**
 110  * Adds a message to the incoming message queue, returning #FALSE
 111  * if there's insufficient memory to queue the message.
 112  *
 113  * @param connection the connection.
 114  * @param message the message to queue.
 115  * @returns #TRUE on success.
 116  */
 117 dbus_bool_t
 118 _dbus_connection_queue_received_message (DBusConnection *connection,
 119                                          DBusMessage    *message)
 120 {
 121   _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
 122
 123   if (!_dbus_list_append (&connection->incoming_messages,
 124                           message))
 125     return FALSE;
 126
 127   dbus_message_ref (message);
 128   connection->n_incoming += 1;
 129
 130   _dbus_verbose ("Incoming message %p added to queue, %d incoming\n",
 131                  message, connection->n_incoming);
 132
 133   return TRUE;
 134 }
 135
 136 /**
 137  * Checks whether there are messages in the outgoing message queue.
 138  *
 139  * @param connection the connection.
 140  * @returns #TRUE if the outgoing queue is non-empty.
 141  */
 142 dbus_bool_t
 143 _dbus_connection_have_messages_to_send (DBusConnection *connection)
 144 {
 145   return connection->outgoing_messages != NULL;
 146 }
 147
 148 /**
 149  * Gets the next outgoing message. The message remains in the
 150  * queue, and the caller does not own a reference to it.
 151  *
 152  * @param connection the connection.
 153  * @returns the message to be sent.
 154  */
 155 DBusMessage*
 156 _dbus_connection_get_message_to_send (DBusConnection *connection)
 157 {
 158   return _dbus_list_get_last (&connection->outgoing_messages);
 159 }
 160
 161 /**
 162  * Notifies the connection that a message has been sent, so the
 163  * message can be removed from the outgoing queue.
 164  *
 165  * @param connection the connection.
 166  * @param message the message that was sent.
 167  */
 168 void
 169 _dbus_connection_message_sent (DBusConnection *connection,
 170                                DBusMessage    *message)
 171 {
 172   _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
 173   _dbus_assert (message == _dbus_list_get_last (&connection->outgoing_messages));
 174
 175   _dbus_list_pop_last (&connection->outgoing_messages);
 176   dbus_message_unref (message);
 177
 178   connection->n_outgoing -= 1;
 179
 180   _dbus_verbose ("Message %p removed from outgoing queue, %d left to send\n",
 181                  message, connection->n_outgoing);
 182
 183   if (connection->n_outgoing == 0)
 184     _dbus_transport_messages_pending (connection->transport,
 185                                       connection->n_outgoing);
 186 }
 187
 188 /**
 189  * Adds a watch using the connection's DBusAddWatchFunction if
 190  * available. Otherwise records the watch to be added when said
 191  * function is available. Also re-adds the watch if the
 192  * DBusAddWatchFunction changes. May fail due to lack of memory.
 193  *
 194  * @param connection the connection.
 195  * @param watch the watch to add.
 196  * @returns #TRUE on success.
 197  */
 198 dbus_bool_t
 199 _dbus_connection_add_watch (DBusConnection *connection,
 200                             DBusWatch      *watch)
 201 {
 202   if (connection->watches) /* null during finalize */
 203     return _dbus_watch_list_add_watch (connection->watches,
 204                                        watch);
 205   else
 206     return FALSE;
 207 }
 208
 209 /**
 210  * Removes a watch using the connection's DBusRemoveWatchFunction
 211  * if available. It's an error to call this function on a watch
 212  * that was not previously added.
 213  *
 214  * @param connection the connection.
 215  * @param watch the watch to remove.
 216  */
 217 void
 218 _dbus_connection_remove_watch (DBusConnection *connection,
 219                                DBusWatch      *watch)
 220 {
 221   if (connection->watches) /* null during finalize */
 222     _dbus_watch_list_remove_watch (connection->watches,
 223                                    watch);
 224 }
 225
 226 /**
 227  * Tells the connection that the transport has been disconnected.
 228  * Results in calling the application disconnect callback.
 229  * Only has an effect the first time it's called.
 230  *
 231  * @param connection the connection
 232  */
 233 void
 234 _dbus_connection_notify_disconnected (DBusConnection *connection)
 235 {
 236   if (connection->disconnect_function != NULL &&
 237       !connection->disconnect_notified)
 238     {
 239       connection->disconnect_notified = TRUE;
 240       dbus_connection_ref (connection);
 241       (* connection->disconnect_function) (connection,
 242                                            connection->disconnect_data);
 243       dbus_connection_unref (connection);
 244     }
 245 }
 246
 247 /**
 248  * Queues incoming messages and sends outgoing messages for this
 249  * connection, optionally blocking in the process. Each call to
 250  * _dbus_connection_do_iteration() will call select() or poll() one
 251  * time and then read or write data if possible.
 252  *
 253  * The purpose of this function is to be able to flush outgoing
 254  * messages or queue up incoming messages without returning
 255  * control to the application and causing reentrancy weirdness.
 256  *
 257  * The flags parameter allows you to specify whether to
 258  * read incoming messages, write outgoing messages, or both,
 259  * and whether to block if no immediate action is possible.
 260  *
 261  * The timeout_milliseconds parameter does nothing unless the
 262  * iteration is blocking.
 263  *
 264  * If there are no outgoing messages and DBUS_ITERATION_DO_READING
 265  * wasn't specified, then it's impossible to block, even if
 266  * you specify DBUS_ITERATION_BLOCK; in that case the function
 267  * returns immediately.
 268  *
 269  * @param connection the connection.
 270  * @param flags iteration flags.
 271  * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
 272  */
 273 void
 274 _dbus_connection_do_iteration (DBusConnection *connection,
 275                                unsigned int    flags,
 276                                int             timeout_milliseconds)
 277 {
 278   if (connection->n_outgoing == 0)
 279     flags &= ~DBUS_ITERATION_DO_WRITING;
 280
 281   _dbus_transport_do_iteration (connection->transport,
 282                                 flags, timeout_milliseconds);
 283 }
 284
 285 /**
 286  * Creates a new connection for the given transport.  A transport
 287  * represents a message stream that uses some concrete mechanism, such
 288  * as UNIX domain sockets. May return #NULL if insufficient
 289  * memory exists to create the connection.
 290  *
 291  * @param transport the transport.
 292  * @returns the new connection, or #NULL on failure.
 293  */
 294 DBusConnection*
 295 _dbus_connection_new_for_transport (DBusTransport *transport)
 296 {
 297   DBusConnection *connection;
 298   DBusWatchList *watch_list;
 299   DBusTimeoutList *timeout_list;
 300   DBusHashTable *handler_table;
 301
 302   watch_list = NULL;
 303   connection = NULL;
 304   handler_table = NULL;
 305
 306   watch_list = _dbus_watch_list_new ();
 307   if (watch_list == NULL)
 308     goto error;
 309
 310   timeout_list = _dbus_timeout_list_new ();
 311   if (timeout_list == NULL)
 312     goto error;
 313
 314   handler_table =
 315     _dbus_hash_table_new (DBUS_HASH_STRING,
 316                           dbus_free, NULL);
 317   if (handler_table == NULL)
 318     goto error;
 319
 320   connection = dbus_new0 (DBusConnection, 1);
 321   if (connection == NULL)
 322     goto error;
 323
 324   connection->refcount = 1;
 325   connection->transport = transport;
 326   connection->watches = watch_list;
 327   connection->timeouts = timeout_list;
 328   connection->handler_table = handler_table;
 329   connection->filter_list = NULL;
 330
 331   connection->data_slots = NULL;
 332   connection->n_slots = 0;
 333   connection->client_serial = 1;
 334   connection->disconnect_notified = FALSE;
 335
 336   _dbus_transport_ref (transport);
 337   _dbus_transport_set_connection (transport, connection);
 338
 339   return connection;
 340
 341  error:
 342
 343   if (connection != NULL)
 344     dbus_free (connection);
 345
 346   if (handler_table)
 347     _dbus_hash_table_unref (handler_table);
 348
 349   if (watch_list)
 350     _dbus_watch_list_free (watch_list);
 351
 352   return NULL;
 353 }
 354
 355 static dbus_int32_t
 356 _dbus_connection_get_next_client_serial (DBusConnection *connection)
 357 {
 358   int serial;
 359
 360   serial = connection->client_serial++;
 361
 362   if (connection->client_serial < 0)
 363     connection->client_serial = 1;
 364
 365   return serial;
 366 }
 367
 368 /**
 369  * Used to notify a connection when a DBusMessageHandler is
 370  * destroyed, so the connection can drop any reference
 371  * to the handler.
 372  *
 373  * @param connection the connection
 374  * @param handler the handler
 375  */
 376 void
 377 _dbus_connection_handler_destroyed (DBusConnection     *connection,
 378                                     DBusMessageHandler *handler)
 379 {
 380   DBusHashIter iter;
 381   DBusList *link;
 382
 383   _dbus_hash_iter_init (connection->handler_table, &iter);
 384   while (_dbus_hash_iter_next (&iter))
 385     {
 386       DBusMessageHandler *h = _dbus_hash_iter_get_value (&iter);
 387
 388       if (h == handler)
 389         _dbus_hash_iter_remove_entry (&iter);
 390     }
 391
 392   link = _dbus_list_get_first_link (&connection->filter_list);
 393   while (link != NULL)
 394     {
 395       DBusMessageHandler *h = link->data;
 396       DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
 397
 398       if (h == handler)
 399         _dbus_list_remove_link (&connection->filter_list,
 400                                 link);
 401
 402       link = next;
 403     }
 404 }
 405
 406 /**
 407  * Adds the counter used to count the number of open connections.
 408  * Increments the counter by one, and saves it to be decremented
 409  * again when this connection is finalized.
 410  *
 411  * @param connection a #DBusConnection
 412  * @param counter counter that tracks number of connections
 413  */
 414 void
 415 _dbus_connection_set_connection_counter (DBusConnection *connection,
 416                                          DBusCounter    *counter)
 417 {
 418   _dbus_assert (connection->connection_counter == NULL);
 419
 420   connection->connection_counter = counter;
 421   _dbus_counter_ref (connection->connection_counter);
 422   _dbus_counter_adjust (connection->connection_counter, 1);
 423 }
 424
 425 /** @} */
 426
 427 /**
 428  * @addtogroup DBusConnection
 429  *
 430  * @{
 431  */
 432
 433 /**
 434  * Opens a new connection to a remote address.
 435  *
 436  * @todo specify what the address parameter is. Right now
 437  * it's just the name of a UNIX domain socket. It should be
 438  * something more complex that encodes which transport to use.
 439  *
 440  * If the open fails, the function returns #NULL, and provides
 441  * a reason for the failure in the result parameter. Pass
 442  * #NULL for the result parameter if you aren't interested
 443  * in the reason for failure.
 444  *
 445  * @param address the address.
 446  * @param result address where a result code can be returned.
 447  * @returns new connection, or #NULL on failure.
 448  */
 449 DBusConnection*
 450 dbus_connection_open (const char     *address,
 451                       DBusResultCode *result)
 452 {
 453   DBusConnection *connection;
 454   DBusTransport *transport;
 455
 456   transport = _dbus_transport_open (address, result);
 457   if (transport == NULL)
 458     return NULL;
 459
 460   connection = _dbus_connection_new_for_transport (transport);
 461
 462   _dbus_transport_unref (transport);
 463
 464   if (connection == NULL)
 465     {
 466       dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
 467       return NULL;
 468     }
 469
 470   return connection;
 471 }
 472
 473 /**
 474  * Increments the reference count of a DBusConnection.
 475  *
 476  * @param connection the connection.
 477  */
 478 void
 479 dbus_connection_ref (DBusConnection *connection)
 480 {
 481   connection->refcount += 1;
 482 }
 483
 484 /**
 485  * Decrements the reference count of a DBusConnection, and finalizes
 486  * it if the count reaches zero.  If a connection is still connected
 487  * when it's finalized, it will be disconnected (that is, associated
 488  * file handles will be closed).
 489  *
 490  * @param connection the connection.
 491  */
 492 void
 493 dbus_connection_unref (DBusConnection *connection)
 494 {
 495   _dbus_assert (connection != NULL);
 496   _dbus_assert (connection->refcount > 0);
 497
 498   connection->refcount -= 1;
 499   if (connection->refcount == 0)
 500     {
 501       DBusHashIter iter;
 502       DBusList *link;
 503
 504       dbus_connection_disconnect (connection);
 505
 506       /* free disconnect data as a side effect */
 507       dbus_connection_set_disconnect_function (connection,
 508                                                NULL, NULL, NULL);
 509
 510       if (connection->connection_counter != NULL)
 511         {
 512           /* subtract ourselves from the counter */
 513           _dbus_counter_adjust (connection->connection_counter, - 1);
 514           _dbus_counter_unref (connection->connection_counter);
 515           connection->connection_counter = NULL;
 516         }
 517
 518       _dbus_watch_list_free (connection->watches);
 519       connection->watches = NULL;
 520
 521       _dbus_connection_free_data_slots (connection);
 522
 523       _dbus_hash_iter_init (connection->handler_table, &iter);
 524       while (_dbus_hash_iter_next (&iter))
 525         {
 526           DBusMessageHandler *h = _dbus_hash_iter_get_value (&iter);
 527
 528           _dbus_message_handler_remove_connection (h, connection);
 529         }
 530
 531       link = _dbus_list_get_first_link (&connection->filter_list);
 532       while (link != NULL)
 533         {
 534           DBusMessageHandler *h = link->data;
 535           DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
 536
 537           _dbus_message_handler_remove_connection (h, connection);
 538
 539           link = next;
 540         }
 541
 542       _dbus_hash_table_unref (connection->handler_table);
 543       connection->handler_table = NULL;
 544
 545       _dbus_list_clear (&connection->filter_list);
 546
 547       _dbus_list_foreach (&connection->outgoing_messages,
 548                           (DBusForeachFunction) dbus_message_unref,
 549                           NULL);
 550       _dbus_list_clear (&connection->outgoing_messages);
 551
 552       _dbus_list_foreach (&connection->incoming_messages,
 553                           (DBusForeachFunction) dbus_message_unref,
 554                           NULL);
 555       _dbus_list_clear (&connection->incoming_messages);
 556
 557       _dbus_transport_unref (connection->transport);
 558
 559       dbus_free (connection);
 560     }
 561 }
 562
 563 /**
 564  * Closes the connection, so no further data can be sent or received.
 565  * Any further attempts to send data will result in errors.  This
 566  * function does not affect the connection's reference count.  It's
 567  * safe to disconnect a connection more than once; all calls after the
 568  * first do nothing. It's impossible to "reconnect" a connection, a
 569  * new connection must be created.
 570  *
 571  * @param connection the connection.
 572  */
 573 void
 574 dbus_connection_disconnect (DBusConnection *connection)
 575 {
 576   _dbus_transport_disconnect (connection->transport);
 577 }
 578
 579 /**
 580  * Gets whether the connection is currently connected.  All
 581  * connections are connected when they are opened.  A connection may
 582  * become disconnected when the remote application closes its end, or
 583  * exits; a connection may also be disconnected with
 584  * dbus_connection_disconnect().
 585  *
 586  * @param connection the connection.
 587  * @returns #TRUE if the connection is still alive.
 588  */
 589 dbus_bool_t
 590 dbus_connection_get_is_connected (DBusConnection *connection)
 591 {
 592   return _dbus_transport_get_is_connected (connection->transport);
 593 }
 594
 595 /**
 596  * Gets whether the connection was authenticated. (Note that
 597  * if the connection was authenticated then disconnected,
 598  * this function still returns #TRUE)
 599  *
 600  * @param connection the connection
 601  * @returns #TRUE if the connection was ever authenticated
 602  */
 603 dbus_bool_t
 604 dbus_connection_get_is_authenticated (DBusConnection *connection)
 605 {
 606   return _dbus_transport_get_is_authenticated (connection->transport);
 607 }
 608
 609 /**
 610  * Adds a message to the outgoing message queue. Does not block to
 611  * write the message to the network; that happens asynchronously. to
 612  * force the message to be written, call dbus_connection_flush().
 613  *
 614  * If the function fails, it returns #FALSE and returns the
 615  * reason for failure via the result parameter.
 616  * The result parameter can be #NULL if you aren't interested
 617  * in the reason for the failure.
 618  *
 619  * @param connection the connection.
 620  * @param message the message to write.
 621  * @param client_serial return location for client serial.
 622  * @param result address where result code can be placed.
 623  * @returns #TRUE on success.
 624  */
 625 dbus_bool_t
 626 dbus_connection_send_message (DBusConnection *connection,
 627                               DBusMessage    *message,
 628                               dbus_int32_t   *client_serial,
 629                               DBusResultCode *result)
 630
 631 {
 632   dbus_int32_t serial;
 633
 634   if (!_dbus_list_prepend (&connection->outgoing_messages,
 635                            message))
 636     {
 637       dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
 638       return FALSE;
 639     }
 640
 641   dbus_message_ref (message);
 642   connection->n_outgoing += 1;
 643
 644   _dbus_verbose ("Message %p added to outgoing queue, %d pending to send\n",
 645                  message, connection->n_outgoing);
 646
 647   serial = _dbus_connection_get_next_client_serial (connection);
 648   _dbus_message_set_client_serial (message, serial);
 649
 650   if (client_serial)
 651     *client_serial = serial;
 652
 653   _dbus_message_lock (message);
 654
 655   if (connection->n_outgoing == 1)
 656     _dbus_transport_messages_pending (connection->transport,
 657                                       connection->n_outgoing);
 658
 659   return TRUE;
 660 }
 661
 662 /**
 663  * Queues a message to send, as with dbus_connection_send_message(),
 664  * but also sets up a DBusMessageHandler to receive a reply to the
 665  * message. If no reply is received in the given timeout_milliseconds,
 666  * expires the pending reply and sends the DBusMessageHandler a
 667  * synthetic error reply (generated in-process, not by the remote
 668  * application) indicating that a timeout occurred.
 669  *
 670  * Reply handlers see their replies after message filters see them,
 671  * but before message handlers added with
 672  * dbus_connection_register_handler() see them, regardless of the
 673  * reply message's name. Reply handlers are only handed a single
 674  * message as a reply, after a reply has been seen the handler is
 675  * removed. If a filter filters out the reply before the handler sees
 676  * it, the handler is not removed but the timeout will immediately
 677  * fire again. If a filter was dumb and kept removing the timeout
 678  * reply then we'd get in an infinite loop.
 679  *
 680  * If #NULL is passed for the reply_handler, the timeout reply will
 681  * still be generated and placed into the message queue, but no
 682  * specific message handler will receive the reply.
 683  *
 684  * If -1 is passed for the timeout, a sane default timeout is used. -1
 685  * is typically the best value for the timeout for this reason, unless
 686  * you want a very short or very long timeout.  There is no way to
 687  * avoid a timeout entirely, other than passing INT_MAX for the
 688  * timeout to postpone it indefinitely.
 689  *
 690  * @param connection the connection
 691  * @param message the message to send
 692  * @param reply_handler message handler expecting the reply, or #NULL
 693  * @param timeout_milliseconds timeout in milliseconds or -1 for default
 694  * @param result return location for result code
 695  * @returns #TRUE if the message is successfully queued, #FALSE if no memory.
 696  *
 697  * @todo this function isn't implemented because we need message serials
 698  * and other slightly more rich DBusMessage implementation in order to
 699  * implement it. The basic idea will be to keep a hash of serials we're
 700  * expecting a reply to, and also to add a way to tell GLib or Qt to
 701  * install a timeout. Then install a timeout which is the shortest
 702  * timeout of any pending reply.
 703  *
 704  */
 705 dbus_bool_t
 706 dbus_connection_send_message_with_reply (DBusConnection     *connection,
 707                                          DBusMessage        *message,
 708                                          DBusMessageHandler *reply_handler,
 709                                          int                 timeout_milliseconds,
 710                                          DBusResultCode     *result)
 711 {
 712   /* FIXME */
 713   return dbus_connection_send_message (connection, message, NULL, result);
 714 }
 715
 716 /**
 717  * Sends a message and blocks a certain time period while waiting for a reply.
 718  * This function does not dispatch any message handlers until the main loop
 719  * has been reached. This function is used to do non-reentrant "method calls."
 720  * If a reply is received, it is returned, and removed from the incoming
 721  * message queue. If it is not received, #NULL is returned and the
 722  * result is set to #DBUS_RESULT_NO_REPLY. If something else goes
 723  * wrong, result is set to whatever is appropriate, such as
 724  * #DBUS_RESULT_NO_MEMORY.
 725  *
 726  * @todo I believe if we get EINTR or otherwise interrupt the
 727  * do_iteration call in here, we won't block the required length of
 728  * time. I think there probably has to be a loop: "while (!timeout_elapsed)
 729  * { check_for_reply_in_queue(); iterate_with_remaining_timeout(); }"
 730  *
 731  * @todo need to remove the reply from the message queue, or someone
 732  * else might process it again later.
 733  *
 734  * @param connection the connection
 735  * @param message the message to send
 736  * @param timeout_milliseconds timeout in milliseconds or -1 for default
 737  * @param result return location for result code
 738  * @returns the message that is the reply or #NULL with an error code if the
 739  * function fails.
 740  */
 741 DBusMessage *
 742 dbus_connection_send_message_with_reply_and_block (DBusConnection     *connection,
 743                                                    DBusMessage        *message,
 744                                                    int                 timeout_milliseconds,
 745                                                    DBusResultCode     *result)
 746 {
 747   dbus_int32_t client_serial;
 748   DBusList *link;
 749
 750   if (timeout_milliseconds == -1)
 751     timeout_milliseconds = DEFAULT_TIMEOUT_VALUE;
 752
 753   if (!dbus_connection_send_message (connection, message, &client_serial, result))
 754     return NULL;
 755
 756   /* Flush message queue */
 757   dbus_connection_flush (connection);
 758
 759   /* Now we wait... */
 760   _dbus_connection_do_iteration (connection,
 761                                  DBUS_ITERATION_DO_READING |
 762                                  DBUS_ITERATION_BLOCK,
 763                                  timeout_milliseconds);
 764
 765   /* Check if we've gotten a reply */
 766   link = _dbus_list_get_first_link (&connection->incoming_messages);
 767
 768   while (link != NULL)
 769     {
 770       DBusMessage *reply = link->data;
 771
 772       if (_dbus_message_get_reply_serial (reply) == client_serial)
 773         {
 774           dbus_message_ref (message);
 775
 776           if (result)
 777             *result = DBUS_RESULT_SUCCESS;
 778
 779           return reply;
 780         }
 781       link = _dbus_list_get_next_link (&connection->incoming_messages, link);
 782     }
 783
 784   if (result)
 785     *result = DBUS_RESULT_NO_REPLY;
 786
 787   return NULL;
 788 }
 789
 790 /**
 791  * Blocks until the outgoing message queue is empty.
 792  *
 793  * @param connection the connection.
 794  */
 795 void
 796 dbus_connection_flush (DBusConnection *connection)
 797 {
 798   while (connection->n_outgoing > 0)
 799     _dbus_connection_do_iteration (connection,
 800                                    DBUS_ITERATION_DO_WRITING |
 801                                    DBUS_ITERATION_BLOCK,
 802                                    -1);
 803 }
 804
 805 /**
 806  * Gets the number of messages in the incoming message queue.
 807  *
 808  * @param connection the connection.
 809  * @returns the number of messages in the queue.
 810  */
 811 int
 812 dbus_connection_get_n_messages (DBusConnection *connection)
 813 {
 814   return connection->n_incoming;
 815 }
 816
 817 /**
 818  * Returns the first-received message from the incoming message queue,
 819  * leaving it in the queue. The caller does not own a reference to the
 820  * returned message. If the queue is empty, returns #NULL.
 821  *
 822  * @param connection the connection.
 823  * @returns next message in the incoming queue.
 824  */
 825 DBusMessage*
 826 dbus_connection_peek_message  (DBusConnection *connection)
 827 {
 828   return _dbus_list_get_first (&connection->incoming_messages);
 829 }
 830
 831 /**
 832  * Returns the first-received message from the incoming message queue,
 833  * removing it from the queue. The caller owns a reference to the
 834  * returned message. If the queue is empty, returns #NULL.
 835  *
 836  * @param connection the connection.
 837  * @returns next message in the incoming queue.
 838  */
 839 DBusMessage*
 840 dbus_connection_pop_message (DBusConnection *connection)
 841 {
 842   if (connection->n_incoming > 0)
 843     {
 844       DBusMessage *message;
 845
 846       message = _dbus_list_pop_first (&connection->incoming_messages);
 847       connection->n_incoming -= 1;
 848
 849       _dbus_verbose ("Incoming message %p removed from queue, %d incoming\n",
 850                      message, connection->n_incoming);
 851
 852       return message;
 853     }
 854   else
 855     return NULL;
 856 }
 857
 858 /**
 859  * Pops the first-received message from the current incoming message
 860  * queue, runs any handlers for it, then unrefs the message.
 861  *
 862  * @param connection the connection
 863  * @returns #TRUE if the queue is not empty after dispatch
 864  *
 865  * @todo this function is not properly robust against reentrancy,
 866  * that is, if handlers are added/removed while dispatching
 867  * a message, things will get messed up.
 868  */
 869 dbus_bool_t
 870 dbus_connection_dispatch_message (DBusConnection *connection)
 871 {
 872   DBusMessage *message;
 873   int filter_serial;
 874   int handler_serial;
 875   DBusList *link;
 876   DBusHandlerResult result;
 877   const char *name;
 878
 879   dbus_connection_ref (connection);
 880
 881   message = dbus_connection_pop_message (connection);
 882   if (message == NULL)
 883     {
 884       dbus_connection_unref (connection);
 885       return FALSE;
 886     }
 887
 888   filter_serial = connection->filters_serial;
 889   handler_serial = connection->handlers_serial;
 890
 891   result = DBUS_HANDLER_RESULT_ALLOW_MORE_HANDLERS;
 892
 893   link = _dbus_list_get_first_link (&connection->filter_list);
 894   while (link != NULL)
 895     {
 896       DBusMessageHandler *handler = link->data;
 897       DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
 898
 899       result = _dbus_message_handler_handle_message (handler, connection,
 900                                                      message);
 901
 902       if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
 903         goto out;
 904
 905       if (filter_serial != connection->filters_serial)
 906         {
 907           _dbus_warn ("Message filters added or removed while dispatching filters - not currently supported!\n");
 908           goto out;
 909         }
 910
 911       link = next;
 912     }
 913
 914   name = dbus_message_get_name (message);
 915   if (name != NULL)
 916     {
 917       DBusMessageHandler *handler;
 918
 919       handler = _dbus_hash_table_lookup_string (connection->handler_table,
 920                                                 name);
 921       if (handler != NULL)
 922         {
 923
 924           result = _dbus_message_handler_handle_message (handler, connection,
 925                                                          message);
 926
 927           if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
 928             goto out;
 929
 930           if (handler_serial != connection->handlers_serial)
 931             {
 932               _dbus_warn ("Message handlers added or removed while dispatching handlers - not currently supported!\n");
 933               goto out;
 934             }
 935         }
 936     }
 937
 938  out:
 939   dbus_connection_unref (connection);
 940   dbus_message_unref (message);
 941
 942   return connection->n_incoming > 0;
 943 }
 944
 945 /**
 946  * Sets the disconnect handler function for the connection.
 947  * Will be called exactly once, when the connection is
 948  * disconnected.
 949  *
 950  * @param connection the connection.
 951  * @param disconnect_function the disconnect handler.
 952  * @param data data to pass to the disconnect handler.
 953  * @param free_data_function function to be called to free the data.
 954  */
 955 void
 956 dbus_connection_set_disconnect_function  (DBusConnection              *connection,
 957                                           DBusDisconnectFunction       disconnect_function,
 958                                           void                        *data,
 959                                           DBusFreeFunction             free_data_function)
 960 {
 961   if (connection->disconnect_free_data_function != NULL)
 962     (* connection->disconnect_free_data_function) (connection->disconnect_data);
 963
 964   connection->disconnect_function = disconnect_function;
 965   connection->disconnect_data = data;
 966   connection->disconnect_free_data_function = free_data_function;
 967 }
 968
 969 /**
 970  * Sets the watch functions for the connection. These functions are
 971  * responsible for making the application's main loop aware of file
 972  * descriptors that need to be monitored for events, using select() or
 973  * poll(). When using Qt, typically the DBusAddWatchFunction would
 974  * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
 975  * could call g_io_add_watch(), or could be used as part of a more
 976  * elaborate GSource.
 977  *
 978  * The DBusWatch can be queried for the file descriptor to watch using
 979  * dbus_watch_get_fd(), and for the events to watch for using
 980  * dbus_watch_get_flags(). The flags returned by
 981  * dbus_watch_get_flags() will only contain DBUS_WATCH_READABLE and
 982  * DBUS_WATCH_WRITABLE, never DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR;
 983  * all watches implicitly include a watch for hangups, errors, and
 984  * other exceptional conditions.
 985  *
 986  * Once a file descriptor becomes readable or writable, or an exception
 987  * occurs, dbus_connection_handle_watch() should be called to
 988  * notify the connection of the file descriptor's condition.
 989  *
 990  * dbus_connection_handle_watch() cannot be called during the
 991  * DBusAddWatchFunction, as the connection will not be ready to handle
 992  * that watch yet.
 993  *
 994  * It is not allowed to reference a DBusWatch after it has been passed
 995  * to remove_function.
 996  *
 997  * @param connection the connection.
 998  * @param add_function function to begin monitoring a new descriptor.
 999  * @param remove_function function to stop monitoring a descriptor.
1000  * @param data data to pass to add_function and remove_function.
1001  * @param free_data_function function to be called to free the data.
1002  */
1003 void
1004 dbus_connection_set_watch_functions (DBusConnection              *connection,
1005                                      DBusAddWatchFunction         add_function,
1006                                      DBusRemoveWatchFunction      remove_function,
1007                                      void                        *data,
1008                                      DBusFreeFunction             free_data_function)
1009 {
1010   /* ref connection for slightly better reentrancy */
1011   dbus_connection_ref (connection);
1012
1013   _dbus_watch_list_set_functions (connection->watches,
1014                                   add_function, remove_function,
1015                                   data, free_data_function);
1016
1017   /* drop our paranoid refcount */
1018   dbus_connection_unref (connection);
1019 }
1020
1021 /**
1022  * Sets the timeout functions for the connection. These functions are
1023  * responsible for making the application's main loop aware of timeouts.
1024  * When using Qt, typically the DBusAddTimeoutFunction would create a
1025  * QTimer. When using GLib, the DBusAddTimeoutFunction would call
1026  * g_timeout_add.
1027  *
1028  * The DBusTimeout can be queried for the timer interval using
1029  * dbus_timeout_get_interval.
1030  *
1031  * Once a timeout occurs, dbus_timeout_handle should be call to invoke
1032  * the timeout's callback.
1033  */
1034 void
1035 dbus_connection_set_timeout_functions   (DBusConnection            *connection,
1036                                          DBusAddTimeoutFunction     add_function,
1037                                          DBusRemoveTimeoutFunction  remove_function,
1038                                          void                      *data,
1039                                          DBusFreeFunction           free_data_function)
1040 {
1041   /* ref connection for slightly better reentrancy */
1042   dbus_connection_ref (connection);
1043
1044   _dbus_timeout_list_set_functions (connection->timeouts,
1045                                     add_function, remove_function,
1046                                     data, free_data_function);
1047
1048   /* drop our paranoid refcount */
1049   dbus_connection_unref (connection);
1050 }
1051
1052 /**
1053  * Called to notify the connection when a previously-added watch
1054  * is ready for reading or writing, or has an exception such
1055  * as a hangup.
1056  *
1057  * @param connection the connection.
1058  * @param watch the watch.
1059  * @param condition the current condition of the file descriptors being watched.
1060  */
1061 void
1062 dbus_connection_handle_watch (DBusConnection              *connection,
1063                               DBusWatch                   *watch,
1064                               unsigned int                 condition)
1065 {
1066   _dbus_transport_handle_watch (connection->transport,
1067                                 watch, condition);
1068 }
1069
1070 /**
1071  * Adds a message filter. Filters are handlers that are run on
1072  * all incoming messages, prior to the normal handlers
1073  * registered with dbus_connection_register_handler().
1074  * Filters are run in the order that they were added.
1075  * The same handler can be added as a filter more than once, in
1076  * which case it will be run more than once.
1077  *
1078  * @param connection the connection
1079  * @param handler the handler
1080  * @returns #TRUE on success, #FALSE if not enough memory.
1081  */
1082 dbus_bool_t
1083 dbus_connection_add_filter (DBusConnection      *connection,
1084                             DBusMessageHandler  *handler)
1085 {
1086   if (!_dbus_message_handler_add_connection (handler, connection))
1087     return FALSE;
1088
1089   if (!_dbus_list_append (&connection->filter_list,
1090                           handler))
1091     {
1092       _dbus_message_handler_remove_connection (handler, connection);
1093       return FALSE;
1094     }
1095
1096   connection->filters_serial += 1;
1097
1098   return TRUE;
1099 }
1100
1101 /**
1102  * Removes a previously-added message filter. It is a programming
1103  * error to call this function for a handler that has not
1104  * been added as a filter. If the given handler was added
1105  * more than once, only one instance of it will be removed
1106  * (the most recently-added instance).
1107  *
1108  * @param connection the connection
1109  * @param handler the handler to remove
1110  *
1111  */
1112 void
1113 dbus_connection_remove_filter (DBusConnection      *connection,
1114                                DBusMessageHandler  *handler)
1115 {
1116   if (!_dbus_list_remove_last (&connection->filter_list, handler))
1117     {
1118       _dbus_warn ("Tried to remove a DBusConnection filter that had not been added\n");
1119       return;
1120     }
1121
1122   _dbus_message_handler_remove_connection (handler, connection);
1123
1124   connection->filters_serial += 1;
1125 }
1126
1127 /**
1128  * Registers a handler for a list of message names. A single handler
1129  * can be registered for any number of message names, but each message
1130  * name can only have one handler at a time. It's not allowed to call
1131  * this function with the name of a message that already has a
1132  * handler. If the function returns #FALSE, the handlers were not
1133  * registered due to lack of memory.
1134  *
1135  * @param connection the connection
1136  * @param handler the handler
1137  * @param messages_to_handle the messages to handle
1138  * @param n_messages the number of message names in messages_to_handle
1139  * @returns #TRUE on success, #FALSE if no memory or another handler already exists
1140  *
1141  **/
1142 dbus_bool_t
1143 dbus_connection_register_handler (DBusConnection     *connection,
1144                                   DBusMessageHandler *handler,
1145                                   const char        **messages_to_handle,
1146                                   int                 n_messages)
1147 {
1148   int i;
1149
1150   i = 0;
1151   while (i < n_messages)
1152     {
1153       DBusHashIter iter;
1154       char *key;
1155
1156       key = _dbus_strdup (messages_to_handle[i]);
1157       if (key == NULL)
1158         goto failed;
1159
1160       if (!_dbus_hash_iter_lookup (connection->handler_table,
1161                                    key, TRUE,
1162                                    &iter))
1163         {
1164           dbus_free (key);
1165           goto failed;
1166         }
1167
1168       if (_dbus_hash_iter_get_value (&iter) != NULL)
1169         {
1170           _dbus_warn ("Bug in application: attempted to register a second handler for %s\n",
1171                       messages_to_handle[i]);
1172           dbus_free (key); /* won't have replaced the old key with the new one */
1173           goto failed;
1174         }
1175
1176       if (!_dbus_message_handler_add_connection (handler, connection))
1177         {
1178           _dbus_hash_iter_remove_entry (&iter);
1179           /* key has freed on nuking the entry */
1180           goto failed;
1181         }
1182
1183       _dbus_hash_iter_set_value (&iter, handler);
1184
1185       connection->handlers_serial += 1;
1186
1187       ++i;
1188     }
1189
1190   return TRUE;
1191
1192  failed:
1193   /* unregister everything registered so far,
1194    * so we don't fail partially
1195    */
1196   dbus_connection_unregister_handler (connection,
1197                                       handler,
1198                                       messages_to_handle,
1199                                       i);
1200
1201   return FALSE;
1202 }
1203
1204 /**
1205  * Unregisters a handler for a list of message names. The handlers
1206  * must have been previously registered.
1207  *
1208  * @param connection the connection
1209  * @param handler the handler
1210  * @param messages_to_handle the messages to handle
1211  * @param n_messages the number of message names in messages_to_handle
1212  *
1213  **/
1214 void
1215 dbus_connection_unregister_handler (DBusConnection     *connection,
1216                                     DBusMessageHandler *handler,
1217                                     const char        **messages_to_handle,
1218                                     int                 n_messages)
1219 {
1220   int i;
1221
1222   i = 0;
1223   while (i < n_messages)
1224     {
1225       DBusHashIter iter;
1226
1227       if (!_dbus_hash_iter_lookup (connection->handler_table,
1228                                    (char*) messages_to_handle[i], FALSE,
1229                                    &iter))
1230         {
1231           _dbus_warn ("Bug in application: attempted to unregister handler for %s which was not registered\n",
1232                       messages_to_handle[i]);
1233         }
1234       else if (_dbus_hash_iter_get_value (&iter) != handler)
1235         {
1236           _dbus_warn ("Bug in application: attempted to unregister handler for %s which was registered by a different handler\n",
1237                       messages_to_handle[i]);
1238         }
1239       else
1240         {
1241           _dbus_hash_iter_remove_entry (&iter);
1242           _dbus_message_handler_remove_connection (handler, connection);
1243         }
1244
1245       ++i;
1246     }
1247
1248   connection->handlers_serial += 1;
1249 }
1250
1251 static int *allocated_slots = NULL;
1252 static int  n_allocated_slots = 0;
1253 static int  n_used_slots = 0;
1254 static DBusStaticMutex allocated_slots_lock = DBUS_STATIC_MUTEX_INIT;
1255
1256 /**
1257  * Allocates an integer ID to be used for storing application-specific
1258  * data on any DBusConnection. The allocated ID may then be used
1259  * with dbus_connection_set_data() and dbus_connection_get_data().
1260  * If allocation fails, -1 is returned.
1261  *
1262  * @returns -1 on failure, otherwise the data slot ID
1263  */
1264 int
1265 dbus_connection_allocate_data_slot (void)
1266 {
1267   int slot;
1268
1269   if (!dbus_static_mutex_lock (&allocated_slots_lock))
1270     return -1;
1271
1272   if (n_used_slots < n_allocated_slots)
1273     {
1274       slot = 0;
1275       while (slot < n_allocated_slots)
1276         {
1277           if (allocated_slots[slot] < 0)
1278             {
1279               allocated_slots[slot] = slot;
1280               n_used_slots += 1;
1281               break;
1282             }
1283           ++slot;
1284         }
1285
1286       _dbus_assert (slot < n_allocated_slots);
1287     }
1288   else
1289     {
1290       int *tmp;
1291
1292       slot = -1;
1293       tmp = dbus_realloc (allocated_slots,
1294                           sizeof (int) * (n_allocated_slots + 1));
1295       if (tmp == NULL)
1296         goto out;
1297
1298       allocated_slots = tmp;
1299       slot = n_allocated_slots;
1300       n_allocated_slots += 1;
1301       n_used_slots += 1;
1302       allocated_slots[slot] = slot;
1303     }
1304
1305   _dbus_assert (slot >= 0);
1306   _dbus_assert (slot < n_allocated_slots);
1307
1308  out:
1309   dbus_static_mutex_unlock (&allocated_slots_lock);
1310   return slot;
1311 }
1312
1313 /**
1314  * Deallocates a global ID for connection data slots.
1315  * dbus_connection_get_data() and dbus_connection_set_data()
1316  * may no longer be used with this slot.
1317  * Existing data stored on existing DBusConnection objects
1318  * will be freed when the connection is finalized,
1319  * but may not be retrieved (and may only be replaced
1320  * if someone else reallocates the slot).
1321  *
1322  * @param slot the slot to deallocate
1323  */
1324 void
1325 dbus_connection_free_data_slot (int slot)
1326 {
1327   dbus_static_mutex_lock (&allocated_slots_lock);
1328
1329   _dbus_assert (slot < n_allocated_slots);
1330   _dbus_assert (allocated_slots[slot] == slot);
1331
1332   allocated_slots[slot] = -1;
1333   n_used_slots -= 1;
1334
1335   if (n_used_slots == 0)
1336     {
1337       dbus_free (allocated_slots);
1338       allocated_slots = NULL;
1339       n_allocated_slots = 0;
1340     }
1341
1342   dbus_static_mutex_unlock (&allocated_slots_lock);
1343 }
1344
1345 /**
1346  * Stores a pointer on a DBusConnection, along
1347  * with an optional function to be used for freeing
1348  * the data when the data is set again, or when
1349  * the connection is finalized. The slot number
1350  * must have been allocated with dbus_connection_allocate_data_slot().
1351  *
1352  * @param connection the connection
1353  * @param slot the slot number
1354  * @param data the data to store
1355  * @param free_data_func finalizer function for the data
1356  * @returns #TRUE if there was enough memory to store the data
1357  */
1358 dbus_bool_t
1359 dbus_connection_set_data (DBusConnection   *connection,
1360                           int               slot,
1361                           void             *data,
1362                           DBusFreeFunction  free_data_func)
1363 {
1364   _dbus_assert (slot < n_allocated_slots);
1365   _dbus_assert (allocated_slots[slot] == slot);
1366
1367   if (slot >= connection->n_slots)
1368     {
1369       DBusDataSlot *tmp;
1370       int i;
1371
1372       tmp = dbus_realloc (connection->data_slots,
1373                           sizeof (DBusDataSlot) * (slot + 1));
1374       if (tmp == NULL)
1375         return FALSE;
1376
1377       connection->data_slots = tmp;
1378       i = connection->n_slots;
1379       connection->n_slots = slot + 1;
1380       while (i < connection->n_slots)
1381         {
1382           connection->data_slots[i].data = NULL;
1383           connection->data_slots[i].free_data_func = NULL;
1384           ++i;
1385         }
1386     }
1387
1388   _dbus_assert (slot < connection->n_slots);
1389
1390   if (connection->data_slots[slot].free_data_func)
1391     (* connection->data_slots[slot].free_data_func) (connection->data_slots[slot].data);
1392
1393   connection->data_slots[slot].data = data;
1394   connection->data_slots[slot].free_data_func = free_data_func;
1395
1396   return TRUE;
1397 }
1398
1399 /**
1400  * Retrieves data previously set with dbus_connection_set_data().
1401  * The slot must still be allocated (must not have been freed).
1402  *
1403  * @param connection the connection
1404  * @param slot the slot to get data from
1405  * @returns the data, or #NULL if not found
1406  */
1407 void*
1408 dbus_connection_get_data (DBusConnection   *connection,
1409                           int               slot)
1410 {
1411   _dbus_assert (slot < n_allocated_slots);
1412   _dbus_assert (allocated_slots[slot] == slot);
1413
1414   if (slot >= connection->n_slots)
1415     return NULL;
1416
1417   return connection->data_slots[slot].data;
1418 }
1419
1420 static void
1421 _dbus_connection_free_data_slots (DBusConnection *connection)
1422 {
1423   int i;
1424
1425   i = 0;
1426   while (i < connection->n_slots)
1427     {
1428       if (connection->data_slots[i].free_data_func)
1429         (* connection->data_slots[i].free_data_func) (connection->data_slots[i].data);
1430       connection->data_slots[i].data = NULL;
1431       connection->data_slots[i].free_data_func = NULL;
1432       ++i;
1433     }
1434
1435   dbus_free (connection->data_slots);
1436   connection->data_slots = NULL;
1437   connection->n_slots = 0;
1438 }
1439
1440 /**
1441  * Specifies the maximum size message this connection is allowed to
1442  * receive. Larger messages will result in disconnecting the
1443  * connection.
1444  *
1445  * @param connection a #DBusConnection
1446  * @param size maximum message size the connection can receive, in bytes
1447  */
1448 void
1449 dbus_connection_set_max_message_size (DBusConnection *connection,
1450                                       long            size)
1451 {
1452   _dbus_transport_set_max_message_size (connection->transport,
1453                                         size);
1454 }
1455
1456 /**
1457  * Gets the value set by dbus_connection_set_max_message_size().
1458  *
1459  * @param connection the connection
1460  * @returns the max size of a single message
1461  */
1462 long
1463 dbus_connection_get_max_message_size (DBusConnection *connection)
1464 {
1465   return _dbus_transport_get_max_message_size (connection->transport);
1466 }
1467
1468 /**
1469  * Sets the maximum total number of bytes that can be used for all messages
1470  * received on this connection. Messages count toward the maximum until
1471  * they are finalized. When the maximum is reached, the connection will
1472  * not read more data until some messages are finalized.
1473  *
1474  * The semantics of the maximum are: if outstanding messages are
1475  * already above the maximum, additional messages will not be read.
1476  * The semantics are not: if the next message would cause us to exceed
1477  * the maximum, we don't read it. The reason is that we don't know the
1478  * size of a message until after we read it.
1479  *
1480  * Thus, the max live messages size can actually be exceeded
1481  * by up to the maximum size of a single message.
1482  *
1483  * Also, if we read say 1024 bytes off the wire in a single read(),
1484  * and that contains a half-dozen small messages, we may exceed the
1485  * size max by that amount. But this should be inconsequential.
1486  *
1487  * @param connection the connection
1488  * @param size the maximum size in bytes of all outstanding messages
1489  */
1490 void
1491 dbus_connection_set_max_live_messages_size (DBusConnection *connection,
1492                                             long            size)
1493 {
1494   _dbus_transport_set_max_live_messages_size (connection->transport,
1495                                               size);
1496 }
1497
1498 /**
1499  * Gets the value set by dbus_connection_set_max_live_messages_size().
1500  *
1501  * @param connection the connection
1502  * @returns the max size of all live messages
1503  */
1504 long
1505 dbus_connection_get_max_live_messages_size (DBusConnection *connection)
1506 {
1507   return _dbus_transport_get_max_live_messages_size (connection->transport);
1508 }
1509
1510 /** @} */