[PATCH 4/9] Update documentation now that INT_MAX means no timeout.
Scott James Remnant
scott at netsplit.com
Fri Jul 18 09:19:12 PDT 2008
* dbus/dbus-connection.c (dbus_connection_send_with_reply): Fix documentation
now that INT_MAX will not be clamped.
(dbus_connection_send_with_reply_and_block): Update documentation too.
---
dbus/dbus-connection.c | 10 ++++------
1 files changed, 4 insertions(+), 6 deletions(-)
diff --git a/dbus/dbus-connection.c b/dbus/dbus-connection.c
index 9ff446f..49766e8 100644
--- a/dbus/dbus-connection.c
+++ b/dbus/dbus-connection.c
@@ -3191,10 +3191,8 @@ reply_handler_timeout (void *data)
*
* If -1 is passed for the timeout, a sane default timeout is used. -1
* is typically the best value for the timeout for this reason, unless
- * you want a very short or very long timeout. There is no way to
- * avoid a timeout entirely, other than passing INT_MAX for the
- * timeout to mean "very long timeout." libdbus clamps an INT_MAX
- * timeout down to a few hours timeout though.
+ * you want a very short or very long timeout. If INT_MAX is passed for
+ * the timeout, no timeout will be set and the call will block forever.
*
* @warning if the connection is disconnected, the #DBusPendingCall
* will be set to #NULL, so be careful with this.
@@ -3202,7 +3200,7 @@ reply_handler_timeout (void *data)
* @param connection the connection
* @param message the message to send
* @param pending_return return location for a #DBusPendingCall object, or #NULL if connection is disconnected
- * @param timeout_milliseconds timeout in milliseconds or -1 for default
+ * @param timeout_milliseconds timeout in milliseconds, -1 for default or INT_MAX for no timeout
* @returns #FALSE if no memory, #TRUE otherwise.
*
*/
@@ -3320,7 +3318,7 @@ dbus_connection_send_with_reply (DBusConnection *connection,
*
* @param connection the connection
* @param message the message to send
- * @param timeout_milliseconds timeout in milliseconds or -1 for default
+ * @param timeout_milliseconds timeout in milliseconds, -1 for default or INT_MAX for no timeout.
* @param error return location for error message
* @returns the message that is the reply or #NULL with an error code if the
* function fails.
--
1.5.4.3
More information about the dbus
mailing list