From b5818e619f6258cc6d530ee62e99bd019b6d069b Mon Sep 17 00:00:00 2001 From: "John (J5) Palmieri" Date: Thu, 3 Apr 2008 13:15:45 -0400 Subject: 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 (fd.o bug#13558) --- dbus/dbus-connection.c | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) (limited to 'dbus') diff --git a/dbus/dbus-connection.c b/dbus/dbus-connection.c index 9439f63f..3a1670ca 100644 --- 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. -- cgit