modify dbus_connection_send documentation

* dbus/dbus-connection.c (dbus_connection_send): add documentation
  to describe when to call dbus_connection_flush and
  dbus_connection_unref after a call to dbus_connection_send is made
  Initial wording by Stanislav Brabec <sbrabec at suse.cz>
  (fd.o bug#13558)

diff --git a/ChangeLog b/ChangeLog
index ae1f7be..edca811 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,13 @@
 2008-04-03  John (J5) Palmieri <johnp@redhat.com>
 
+       * dbus/dbus-connection.c (dbus_connection_send): add documentation
+         to describe when to call dbus_connection_flush and
+         dbus_connection_unref after a call to dbus_connection_send is made
+         Initial wording by Stanislav Brabec <sbrabec at suse.cz> 
+         (fd.o bug#13558)
+
+2008-04-03  John (J5) Palmieri <johnp@redhat.com>
+
        Patch from Jérémie Dimino <jeremie at dimino.org>
 
        * tools/dbus-send.c (append_dict): Send in signature when opening up

diff --git a/dbus/dbus-connection.c b/dbus/dbus-connection.c
index 9439f63..3a1670c 100644 (file)
--- a/dbus/dbus-connection.c
+++ b/dbus/dbus-connection.c
@@ -3055,18 +3055,24 @@ _dbus_connection_send_unlocked_no_update (DBusConnection *connection,
 /**
  * Adds a message to the outgoing message queue. Does not block to
  * write the message to the network; that happens asynchronously. To
- * force the message to be written, call dbus_connection_flush().
+ * force the message to be written, call dbus_connection_flush() however
+ * it is not necessary to call dbus_connection_flush() by hand; the 
+ * message will be sent the next time the main loop is run. 
+ * dbus_connection_flush() should only be used, for example, if
+ * the application was expected to exit before running the main loop.
+ *
  * Because this only queues the message, the only reason it can
  * fail is lack of memory. Even if the connection is disconnected,
- * no error will be returned.
- *
- * If the function fails due to lack of memory, it returns #FALSE.
- * The function will never fail for other reasons; even if the
- * connection is disconnected, you can queue an outgoing message,
+ * no error will be returned. If the function fails due to lack of memory, 
+ * it returns #FALSE. The function will never fail for other reasons; even 
+ * if the connection is disconnected, you can queue an outgoing message,
  * though obviously it won't be sent.
  *
  * The message serial is used by the remote application to send a
  * reply; see dbus_message_get_serial() or the D-Bus specification.
+ *
+ * dbus_message_unref() can be called as soon as this method returns
+ * as the message queue will hold its own ref until the message is sent.
  * 
  * @param connection the connection.
  * @param message the message to write.