Attachment 25772 Details for Bug 16841 – [PATCH 04/11] Update documentation now that INT_MAX means no timeout.

[patch] [PATCH 04/11] Update documentation now that INT_MAX means no timeout.

0004-Update-documentation-now-that-INT_MAX-means-no-timeo.patch (text/plain), 2.37 KB, created by Scott James Remnant on 2009-05-11 15:43:57 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Scott James Remnant

Created: 2009-05-11 15:43:57 UTC

Size: 2.37 KB

patch

obsolete

>From 2773a7ed265e64032e413eef1ad8cef15bf68e5c Mon Sep 17 00:00:00 2001
>From: Scott James Remnant <scott@ubuntu.com>
>Date: Mon, 11 May 2009 22:41:20 +0100
>Subject: [PATCH 04/11] Update documentation now that INT_MAX means no timeout.
>
>* 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.
>
>Signed-off-by: Scott James Remnant <scott@ubuntu.com>
>---
> 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 53d6307..31a1d99 100644
>--- a/dbus/dbus-connection.c
>+++ b/dbus/dbus-connection.c
>@@ -3201,10 +3201,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.
>@@ -3212,7 +3210,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.
>  *
>  */
>@@ -3330,7 +3328,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.6.0.4
>

Actions: View | Splinter Review

Attachments on bug 16841: 17862 | 17863 | 17864 | 17865 | 17866 | 17867 | 17868 | 17869 | 17870 | 25769 | 25770 | 25771 | 25772 | 25773 | 25774 | 25775 | 25776 | 25777 | 25778 | 25779

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.