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  *
 721  * @param connection the connection
 722  * @param message the message to send
 723  * @param timeout_milliseconds timeout in milliseconds or -1 for default
 724  * @param result return location for result code
 725  * @returns the message that is the reply or #NULL with an error code if the
 726  * function fails.
 727  */
 728 DBusMessage *
 729 dbus_connection_send_message_with_reply_and_block (DBusConnection     *connection,
 730                                                    DBusMessage        *message,
 731                                                    int                 timeout_milliseconds,
 732                                                    DBusResultCode     *result)
 733 {
 734   dbus_int32_t client_serial;
 735   DBusList *link;
 736
 737   if (timeout_milliseconds == -1)
 738     timeout_milliseconds = DEFAULT_TIMEOUT_VALUE;
 739
 740   if (!dbus_connection_send_message (connection, message, &client_serial, result))
 741     return NULL;
 742
 743   /* Flush message queue */
 744   dbus_connection_flush (connection);
 745
 746   /* Now we wait... */
 747   _dbus_connection_do_iteration (connection,
 748                                  DBUS_ITERATION_DO_READING |
 749                                  DBUS_ITERATION_BLOCK,
 750                                  timeout_milliseconds);
 751
 752   /* Check if we've gotten a reply */
 753   link = _dbus_list_get_first_link (&connection->incoming_messages);
 754
 755   while (link != NULL)
 756     {
 757       DBusMessage *reply = link->data;
 758
 759       if (_dbus_message_get_reply_serial (reply) == client_serial)
 760         {
 761           dbus_message_ref (message);
 762
 763           if (result)
 764             *result = DBUS_RESULT_SUCCESS;
 765
 766           return reply;
 767         }
 768       link = _dbus_list_get_next_link (&connection->incoming_messages, link);
 769     }
 770
 771   if (result)
 772     *result = DBUS_RESULT_NO_REPLY;
 773
 774   return NULL;
 775 }
 776
 777 /**
 778  * Blocks until the outgoing message queue is empty.
 779  *
 780  * @param connection the connection.
 781  */
 782 void
 783 dbus_connection_flush (DBusConnection *connection)
 784 {
 785   while (connection->n_outgoing > 0)
 786     _dbus_connection_do_iteration (connection,
 787                                    DBUS_ITERATION_DO_WRITING |
 788                                    DBUS_ITERATION_BLOCK,
 789                                    -1);
 790 }
 791
 792 /**
 793  * Gets the number of messages in the incoming message queue.
 794  *
 795  * @param connection the connection.
 796  * @returns the number of messages in the queue.
 797  */
 798 int
 799 dbus_connection_get_n_messages (DBusConnection *connection)
 800 {
 801   return connection->n_incoming;
 802 }
 803
 804 /**
 805  * Returns the first-received message from the incoming message queue,
 806  * leaving it in the queue. The caller does not own a reference to the
 807  * returned message. If the queue is empty, returns #NULL.
 808  *
 809  * @param connection the connection.
 810  * @returns next message in the incoming queue.
 811  */
 812 DBusMessage*
 813 dbus_connection_peek_message  (DBusConnection *connection)
 814 {
 815   return _dbus_list_get_first (&connection->incoming_messages);
 816 }
 817
 818 /**
 819  * Returns the first-received message from the incoming message queue,
 820  * removing it from the queue. The caller owns a reference to the
 821  * returned message. If the queue is empty, returns #NULL.
 822  *
 823  * @param connection the connection.
 824  * @returns next message in the incoming queue.
 825  */
 826 DBusMessage*
 827 dbus_connection_pop_message (DBusConnection *connection)
 828 {
 829   if (connection->n_incoming > 0)
 830     {
 831       DBusMessage *message;
 832
 833       message = _dbus_list_pop_first (&connection->incoming_messages);
 834       connection->n_incoming -= 1;
 835
 836       _dbus_verbose ("Incoming message %p removed from queue, %d incoming\n",
 837                      message, connection->n_incoming);
 838
 839       return message;
 840     }
 841   else
 842     return NULL;
 843 }
 844
 845 /**
 846  * Pops the first-received message from the current incoming message
 847  * queue, runs any handlers for it, then unrefs the message.
 848  *
 849  * @param connection the connection
 850  * @returns #TRUE if the queue is not empty after dispatch
 851  *
 852  * @todo this function is not properly robust against reentrancy,
 853  * that is, if handlers are added/removed while dispatching
 854  * a message, things will get messed up.
 855  */
 856 dbus_bool_t
 857 dbus_connection_dispatch_message (DBusConnection *connection)
 858 {
 859   DBusMessage *message;
 860   int filter_serial;
 861   int handler_serial;
 862   DBusList *link;
 863   DBusHandlerResult result;
 864   const char *name;
 865
 866   dbus_connection_ref (connection);
 867
 868   message = dbus_connection_pop_message (connection);
 869   if (message == NULL)
 870     {
 871       dbus_connection_unref (connection);
 872       return FALSE;
 873     }
 874
 875   filter_serial = connection->filters_serial;
 876   handler_serial = connection->handlers_serial;
 877
 878   result = DBUS_HANDLER_RESULT_ALLOW_MORE_HANDLERS;
 879
 880   link = _dbus_list_get_first_link (&connection->filter_list);
 881   while (link != NULL)
 882     {
 883       DBusMessageHandler *handler = link->data;
 884       DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
 885
 886       result = _dbus_message_handler_handle_message (handler, connection,
 887                                                      message);
 888
 889       if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
 890         goto out;
 891
 892       if (filter_serial != connection->filters_serial)
 893         {
 894           _dbus_warn ("Message filters added or removed while dispatching filters - not currently supported!\n");
 895           goto out;
 896         }
 897
 898       link = next;
 899     }
 900
 901   name = dbus_message_get_name (message);
 902   if (name != NULL)
 903     {
 904       DBusMessageHandler *handler;
 905
 906       handler = _dbus_hash_table_lookup_string (connection->handler_table,
 907                                                 name);
 908       if (handler != NULL)
 909         {
 910
 911           result = _dbus_message_handler_handle_message (handler, connection,
 912                                                          message);
 913
 914           if (result == DBUS_HANDLER_RESULT_REMOVE_MESSAGE)
 915             goto out;
 916
 917           if (handler_serial != connection->handlers_serial)
 918             {
 919               _dbus_warn ("Message handlers added or removed while dispatching handlers - not currently supported!\n");
 920               goto out;
 921             }
 922         }
 923     }
 924
 925  out:
 926   dbus_connection_unref (connection);
 927   dbus_message_unref (message);
 928
 929   return connection->n_incoming > 0;
 930 }
 931
 932 /**
 933  * Sets the disconnect handler function for the connection.
 934  * Will be called exactly once, when the connection is
 935  * disconnected.
 936  *
 937  * @param connection the connection.
 938  * @param disconnect_function the disconnect handler.
 939  * @param data data to pass to the disconnect handler.
 940  * @param free_data_function function to be called to free the data.
 941  */
 942 void
 943 dbus_connection_set_disconnect_function  (DBusConnection              *connection,
 944                                           DBusDisconnectFunction       disconnect_function,
 945                                           void                        *data,
 946                                           DBusFreeFunction             free_data_function)
 947 {
 948   if (connection->disconnect_free_data_function != NULL)
 949     (* connection->disconnect_free_data_function) (connection->disconnect_data);
 950
 951   connection->disconnect_function = disconnect_function;
 952   connection->disconnect_data = data;
 953   connection->disconnect_free_data_function = free_data_function;
 954 }
 955
 956 /**
 957  * Sets the watch functions for the connection. These functions are
 958  * responsible for making the application's main loop aware of file
 959  * descriptors that need to be monitored for events, using select() or
 960  * poll(). When using Qt, typically the DBusAddWatchFunction would
 961  * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
 962  * could call g_io_add_watch(), or could be used as part of a more
 963  * elaborate GSource.
 964  *
 965  * The DBusWatch can be queried for the file descriptor to watch using
 966  * dbus_watch_get_fd(), and for the events to watch for using
 967  * dbus_watch_get_flags(). The flags returned by
 968  * dbus_watch_get_flags() will only contain DBUS_WATCH_READABLE and
 969  * DBUS_WATCH_WRITABLE, never DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR;
 970  * all watches implicitly include a watch for hangups, errors, and
 971  * other exceptional conditions.
 972  *
 973  * Once a file descriptor becomes readable or writable, or an exception
 974  * occurs, dbus_connection_handle_watch() should be called to
 975  * notify the connection of the file descriptor's condition.
 976  *
 977  * dbus_connection_handle_watch() cannot be called during the
 978  * DBusAddWatchFunction, as the connection will not be ready to handle
 979  * that watch yet.
 980  *
 981  * It is not allowed to reference a DBusWatch after it has been passed
 982  * to remove_function.
 983  *
 984  * @param connection the connection.
 985  * @param add_function function to begin monitoring a new descriptor.
 986  * @param remove_function function to stop monitoring a descriptor.
 987  * @param data data to pass to add_function and remove_function.
 988  * @param free_data_function function to be called to free the data.
 989  */
 990 void
 991 dbus_connection_set_watch_functions (DBusConnection              *connection,
 992                                      DBusAddWatchFunction         add_function,
 993                                      DBusRemoveWatchFunction      remove_function,
 994                                      void                        *data,
 995                                      DBusFreeFunction             free_data_function)
 996 {
 997   /* ref connection for slightly better reentrancy */
 998   dbus_connection_ref (connection);
 999
1000   _dbus_watch_list_set_functions (connection->watches,
1001                                   add_function, remove_function,
1002                                   data, free_data_function);
1003
1004   /* drop our paranoid refcount */
1005   dbus_connection_unref (connection);
1006 }
1007
1008 /**
1009  * Sets the timeout functions for the connection. These functions are
1010  * responsible for making the application's main loop aware of timeouts.
1011  * When using Qt, typically the DBusAddTimeoutFunction would create a
1012  * QTimer. When using GLib, the DBusAddTimeoutFunction would call
1013  * g_timeout_add.
1014  *
1015  * The DBusTimeout can be queried for the timer interval using
1016  * dbus_timeout_get_interval.
1017  *
1018  * Once a timeout occurs, dbus_timeout_handle should be call to invoke
1019  * the timeout's callback.
1020  */
1021 void
1022 dbus_connection_set_timeout_functions   (DBusConnection            *connection,
1023                                          DBusAddTimeoutFunction     add_function,
1024                                          DBusRemoveTimeoutFunction  remove_function,
1025                                          void                      *data,
1026                                          DBusFreeFunction           free_data_function)
1027 {
1028   /* ref connection for slightly better reentrancy */
1029   dbus_connection_ref (connection);
1030
1031   _dbus_timeout_list_set_functions (connection->timeouts,
1032                                     add_function, remove_function,
1033                                     data, free_data_function);
1034
1035   /* drop our paranoid refcount */
1036   dbus_connection_unref (connection);
1037 }
1038
1039 /**
1040  * Called to notify the connection when a previously-added watch
1041  * is ready for reading or writing, or has an exception such
1042  * as a hangup.
1043  *
1044  * @param connection the connection.
1045  * @param watch the watch.
1046  * @param condition the current condition of the file descriptors being watched.
1047  */
1048 void
1049 dbus_connection_handle_watch (DBusConnection              *connection,
1050                               DBusWatch                   *watch,
1051                               unsigned int                 condition)
1052 {
1053   _dbus_transport_handle_watch (connection->transport,
1054                                 watch, condition);
1055 }
1056
1057 /**
1058  * Adds a message filter. Filters are handlers that are run on
1059  * all incoming messages, prior to the normal handlers
1060  * registered with dbus_connection_register_handler().
1061  * Filters are run in the order that they were added.
1062  * The same handler can be added as a filter more than once, in
1063  * which case it will be run more than once.
1064  *
1065  * @param connection the connection
1066  * @param handler the handler
1067  * @returns #TRUE on success, #FALSE if not enough memory.
1068  */
1069 dbus_bool_t
1070 dbus_connection_add_filter (DBusConnection      *connection,
1071                             DBusMessageHandler  *handler)
1072 {
1073   if (!_dbus_message_handler_add_connection (handler, connection))
1074     return FALSE;
1075
1076   if (!_dbus_list_append (&connection->filter_list,
1077                           handler))
1078     {
1079       _dbus_message_handler_remove_connection (handler, connection);
1080       return FALSE;
1081     }
1082
1083   connection->filters_serial += 1;
1084
1085   return TRUE;
1086 }
1087
1088 /**
1089  * Removes a previously-added message filter. It is a programming
1090  * error to call this function for a handler that has not
1091  * been added as a filter. If the given handler was added
1092  * more than once, only one instance of it will be removed
1093  * (the most recently-added instance).
1094  *
1095  * @param connection the connection
1096  * @param handler the handler to remove
1097  *
1098  */
1099 void
1100 dbus_connection_remove_filter (DBusConnection      *connection,
1101                                DBusMessageHandler  *handler)
1102 {
1103   if (!_dbus_list_remove_last (&connection->filter_list, handler))
1104     {
1105       _dbus_warn ("Tried to remove a DBusConnection filter that had not been added\n");
1106       return;
1107     }
1108
1109   _dbus_message_handler_remove_connection (handler, connection);
1110
1111   connection->filters_serial += 1;
1112 }
1113
1114 /**
1115  * Registers a handler for a list of message names. A single handler
1116  * can be registered for any number of message names, but each message
1117  * name can only have one handler at a time. It's not allowed to call
1118  * this function with the name of a message that already has a
1119  * handler. If the function returns #FALSE, the handlers were not
1120  * registered due to lack of memory.
1121  *
1122  * @param connection the connection
1123  * @param handler the handler
1124  * @param messages_to_handle the messages to handle
1125  * @param n_messages the number of message names in messages_to_handle
1126  * @returns #TRUE on success, #FALSE if no memory or another handler already exists
1127  *
1128  **/
1129 dbus_bool_t
1130 dbus_connection_register_handler (DBusConnection     *connection,
1131                                   DBusMessageHandler *handler,
1132                                   const char        **messages_to_handle,
1133                                   int                 n_messages)
1134 {
1135   int i;
1136
1137   i = 0;
1138   while (i < n_messages)
1139     {
1140       DBusHashIter iter;
1141       char *key;
1142
1143       key = _dbus_strdup (messages_to_handle[i]);
1144       if (key == NULL)
1145         goto failed;
1146
1147       if (!_dbus_hash_iter_lookup (connection->handler_table,
1148                                    key, TRUE,
1149                                    &iter))
1150         {
1151           dbus_free (key);
1152           goto failed;
1153         }
1154
1155       if (_dbus_hash_iter_get_value (&iter) != NULL)
1156         {
1157           _dbus_warn ("Bug in application: attempted to register a second handler for %s\n",
1158                       messages_to_handle[i]);
1159           dbus_free (key); /* won't have replaced the old key with the new one */
1160           goto failed;
1161         }
1162
1163       if (!_dbus_message_handler_add_connection (handler, connection))
1164         {
1165           _dbus_hash_iter_remove_entry (&iter);
1166           /* key has freed on nuking the entry */
1167           goto failed;
1168         }
1169
1170       _dbus_hash_iter_set_value (&iter, handler);
1171
1172       connection->handlers_serial += 1;
1173
1174       ++i;
1175     }
1176
1177   return TRUE;
1178
1179  failed:
1180   /* unregister everything registered so far,
1181    * so we don't fail partially
1182    */
1183   dbus_connection_unregister_handler (connection,
1184                                       handler,
1185                                       messages_to_handle,
1186                                       i);
1187
1188   return FALSE;
1189 }
1190
1191 /**
1192  * Unregisters a handler for a list of message names. The handlers
1193  * must have been previously registered.
1194  *
1195  * @param connection the connection
1196  * @param handler the handler
1197  * @param messages_to_handle the messages to handle
1198  * @param n_messages the number of message names in messages_to_handle
1199  *
1200  **/
1201 void
1202 dbus_connection_unregister_handler (DBusConnection     *connection,
1203                                     DBusMessageHandler *handler,
1204                                     const char        **messages_to_handle,
1205                                     int                 n_messages)
1206 {
1207   int i;
1208
1209   i = 0;
1210   while (i < n_messages)
1211     {
1212       DBusHashIter iter;
1213
1214       if (!_dbus_hash_iter_lookup (connection->handler_table,
1215                                    (char*) messages_to_handle[i], FALSE,
1216                                    &iter))
1217         {
1218           _dbus_warn ("Bug in application: attempted to unregister handler for %s which was not registered\n",
1219                       messages_to_handle[i]);
1220         }
1221       else if (_dbus_hash_iter_get_value (&iter) != handler)
1222         {
1223           _dbus_warn ("Bug in application: attempted to unregister handler for %s which was registered by a different handler\n",
1224                       messages_to_handle[i]);
1225         }
1226       else
1227         {
1228           _dbus_hash_iter_remove_entry (&iter);
1229           _dbus_message_handler_remove_connection (handler, connection);
1230         }
1231
1232       ++i;
1233     }
1234
1235   connection->handlers_serial += 1;
1236 }
1237
1238 static int *allocated_slots = NULL;
1239 static int  n_allocated_slots = 0;
1240 static int  n_used_slots = 0;
1241 static DBusStaticMutex allocated_slots_lock = DBUS_STATIC_MUTEX_INIT;
1242
1243 /**
1244  * Allocates an integer ID to be used for storing application-specific
1245  * data on any DBusConnection. The allocated ID may then be used
1246  * with dbus_connection_set_data() and dbus_connection_get_data().
1247  * If allocation fails, -1 is returned.
1248  *
1249  * @returns -1 on failure, otherwise the data slot ID
1250  */
1251 int
1252 dbus_connection_allocate_data_slot (void)
1253 {
1254   int slot;
1255
1256   if (!dbus_static_mutex_lock (&allocated_slots_lock))
1257     return -1;
1258
1259   if (n_used_slots < n_allocated_slots)
1260     {
1261       slot = 0;
1262       while (slot < n_allocated_slots)
1263         {
1264           if (allocated_slots[slot] < 0)
1265             {
1266               allocated_slots[slot] = slot;
1267               n_used_slots += 1;
1268               break;
1269             }
1270           ++slot;
1271         }
1272
1273       _dbus_assert (slot < n_allocated_slots);
1274     }
1275   else
1276     {
1277       int *tmp;
1278
1279       slot = -1;
1280       tmp = dbus_realloc (allocated_slots,
1281                           sizeof (int) * (n_allocated_slots + 1));
1282       if (tmp == NULL)
1283         goto out;
1284
1285       allocated_slots = tmp;
1286       slot = n_allocated_slots;
1287       n_allocated_slots += 1;
1288       n_used_slots += 1;
1289       allocated_slots[slot] = slot;
1290     }
1291
1292   _dbus_assert (slot >= 0);
1293   _dbus_assert (slot < n_allocated_slots);
1294
1295  out:
1296   dbus_static_mutex_unlock (&allocated_slots_lock);
1297   return slot;
1298 }
1299
1300 /**
1301  * Deallocates a global ID for connection data slots.
1302  * dbus_connection_get_data() and dbus_connection_set_data()
1303  * may no longer be used with this slot.
1304  * Existing data stored on existing DBusConnection objects
1305  * will be freed when the connection is finalized,
1306  * but may not be retrieved (and may only be replaced
1307  * if someone else reallocates the slot).
1308  *
1309  * @param slot the slot to deallocate
1310  */
1311 void
1312 dbus_connection_free_data_slot (int slot)
1313 {
1314   dbus_static_mutex_lock (&allocated_slots_lock);
1315
1316   _dbus_assert (slot < n_allocated_slots);
1317   _dbus_assert (allocated_slots[slot] == slot);
1318
1319   allocated_slots[slot] = -1;
1320   n_used_slots -= 1;
1321
1322   if (n_used_slots == 0)
1323     {
1324       dbus_free (allocated_slots);
1325       allocated_slots = NULL;
1326       n_allocated_slots = 0;
1327     }
1328
1329   dbus_static_mutex_unlock (&allocated_slots_lock);
1330 }
1331
1332 /**
1333  * Stores a pointer on a DBusConnection, along
1334  * with an optional function to be used for freeing
1335  * the data when the data is set again, or when
1336  * the connection is finalized. The slot number
1337  * must have been allocated with dbus_connection_allocate_data_slot().
1338  *
1339  * @param connection the connection
1340  * @param slot the slot number
1341  * @param data the data to store
1342  * @param free_data_func finalizer function for the data
1343  * @returns #TRUE if there was enough memory to store the data
1344  */
1345 dbus_bool_t
1346 dbus_connection_set_data (DBusConnection   *connection,
1347                           int               slot,
1348                           void             *data,
1349                           DBusFreeFunction  free_data_func)
1350 {
1351   _dbus_assert (slot < n_allocated_slots);
1352   _dbus_assert (allocated_slots[slot] == slot);
1353
1354   if (slot >= connection->n_slots)
1355     {
1356       DBusDataSlot *tmp;
1357       int i;
1358
1359       tmp = dbus_realloc (connection->data_slots,
1360                           sizeof (DBusDataSlot) * (slot + 1));
1361       if (tmp == NULL)
1362         return FALSE;
1363
1364       connection->data_slots = tmp;
1365       i = connection->n_slots;
1366       connection->n_slots = slot + 1;
1367       while (i < connection->n_slots)
1368         {
1369           connection->data_slots[i].data = NULL;
1370           connection->data_slots[i].free_data_func = NULL;
1371           ++i;
1372         }
1373     }
1374
1375   _dbus_assert (slot < connection->n_slots);
1376
1377   if (connection->data_slots[slot].free_data_func)
1378     (* connection->data_slots[slot].free_data_func) (connection->data_slots[slot].data);
1379
1380   connection->data_slots[slot].data = data;
1381   connection->data_slots[slot].free_data_func = free_data_func;
1382
1383   return TRUE;
1384 }
1385
1386 /**
1387  * Retrieves data previously set with dbus_connection_set_data().
1388  * The slot must still be allocated (must not have been freed).
1389  *
1390  * @param connection the connection
1391  * @param slot the slot to get data from
1392  * @returns the data, or #NULL if not found
1393  */
1394 void*
1395 dbus_connection_get_data (DBusConnection   *connection,
1396                           int               slot)
1397 {
1398   _dbus_assert (slot < n_allocated_slots);
1399   _dbus_assert (allocated_slots[slot] == slot);
1400
1401   if (slot >= connection->n_slots)
1402     return NULL;
1403
1404   return connection->data_slots[slot].data;
1405 }
1406
1407 static void
1408 _dbus_connection_free_data_slots (DBusConnection *connection)
1409 {
1410   int i;
1411
1412   i = 0;
1413   while (i < connection->n_slots)
1414     {
1415       if (connection->data_slots[i].free_data_func)
1416         (* connection->data_slots[i].free_data_func) (connection->data_slots[i].data);
1417       connection->data_slots[i].data = NULL;
1418       connection->data_slots[i].free_data_func = NULL;
1419       ++i;
1420     }
1421
1422   dbus_free (connection->data_slots);
1423   connection->data_slots = NULL;
1424   connection->n_slots = 0;
1425 }
1426
1427 /**
1428  * Specifies the maximum size message this connection is allowed to
1429  * receive. Larger messages will result in disconnecting the
1430  * connection.
1431  *
1432  * @param connection a #DBusConnection
1433  * @param size maximum message size the connection can receive, in bytes
1434  */
1435 void
1436 dbus_connection_set_max_message_size (DBusConnection *connection,
1437                                       long            size)
1438 {
1439   _dbus_transport_set_max_message_size (connection->transport,
1440                                         size);
1441 }
1442
1443 /**
1444  * Gets the value set by dbus_connection_set_max_message_size().
1445  *
1446  * @param connection the connection
1447  * @returns the max size of a single message
1448  */
1449 long
1450 dbus_connection_get_max_message_size (DBusConnection *connection)
1451 {
1452   return _dbus_transport_get_max_message_size (connection->transport);
1453 }
1454
1455 /**
1456  * Sets the maximum total number of bytes that can be used for all messages
1457  * received on this connection. Messages count toward the maximum until
1458  * they are finalized. When the maximum is reached, the connection will
1459  * not read more data until some messages are finalized.
1460  *
1461  * The semantics of the maximum are: if outstanding messages are
1462  * already above the maximum, additional messages will not be read.
1463  * The semantics are not: if the next message would cause us to exceed
1464  * the maximum, we don't read it. The reason is that we don't know the
1465  * size of a message until after we read it.
1466  *
1467  * Thus, the max live messages size can actually be exceeded
1468  * by up to the maximum size of a single message.
1469  *
1470  * Also, if we read say 1024 bytes off the wire in a single read(),
1471  * and that contains a half-dozen small messages, we may exceed the
1472  * size max by that amount. But this should be inconsequential.
1473  *
1474  * @param connection the connection
1475  * @param size the maximum size in bytes of all outstanding messages
1476  */
1477 void
1478 dbus_connection_set_max_live_messages_size (DBusConnection *connection,
1479                                             long            size)
1480 {
1481   _dbus_transport_set_max_live_messages_size (connection->transport,
1482                                               size);
1483 }
1484
1485 /**
1486  * Gets the value set by dbus_connection_set_max_live_messages_size().
1487  *
1488  * @param connection the connection
1489  * @returns the max size of all live messages
1490  */
1491 long
1492 dbus_connection_get_max_live_messages_size (DBusConnection *connection)
1493 {
1494   return _dbus_transport_get_max_live_messages_size (connection->transport);
1495 }
1496
1497 /** @} */