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