From 492f43c951dfe35ce9b6a4ab57814b6f78620ac0 Mon Sep 17 00:00:00 2001 From: Simon McVittie Date: Mon, 28 Mar 2011 18:52:27 +0100 Subject: [PATCH 25/25] improve documentation of proxy timeouts to mention that -1 is special --- dbus/dbus-gproxy.c | 10 ++++++---- 1 files changed, 6 insertions(+), 4 deletions(-) diff --git a/dbus/dbus-gproxy.c b/dbus/dbus-gproxy.c index 578aff5..13a0cb6 100644 --- a/dbus/dbus-gproxy.c +++ b/dbus/dbus-gproxy.c @@ -2480,7 +2480,7 @@ dbus_g_proxy_begin_call (DBusGProxy *proxy, * @notify: callback to be invoked when method returns * @user_data: user data passed to callback * @destroy: function called to destroy user_data - * @timeout: specify the timeout in milliseconds + * @timeout: the timeout in milliseconds, or -1 to use a default * @first_arg_type: type of the first argument * * Asynchronously invokes a method on a remote interface. The method @@ -2632,7 +2632,7 @@ dbus_g_proxy_call (DBusGProxy *proxy, * dbus_g_proxy_call_with_timeout: * @proxy: a proxy for a remote interface * @method: method to invoke - * @timeout: specify the timeout in milliseconds + * @timeout: the timeout in milliseconds, or -1 to use a default * @error: return location for an error * @first_arg_type: type of first "in" argument * @@ -2983,10 +2983,12 @@ dbus_g_proxy_disconnect_signal (DBusGProxy *proxy, /** * dbus_g_proxy_set_default_timeout: * @proxy: a proxy for a remote interface - * @timeout: specify the timeout in milliseconds + * @timeout: the timeout in milliseconds, or -1 to reset to the libdbus default * * Sets the default timeout to use for a proxy. This timeout will be - * used in calls where the timeout is not specified. + * used in calls where the timeout is not specified, or is specified to be -1. + * If this timeout is also set to -1, libdbus will use a reasonable default + * value. * * This is useful for long-running operations that takes longer than * the default timeout (which is a on the order of magnitude of tens -- 1.7.4.1