[libsoup] SoupSession: clarify timeout and idle-timeout docs



commit e1600cd686e32a52e126998413445f038be81e01
Author: Dan Winship <danw gnome org>
Date:   Mon Aug 20 12:05:22 2012 -0400

    SoupSession: clarify timeout and idle-timeout docs
    
    They only affect connections opened after you set the property.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=681781

 libsoup/soup-session.c |   24 ++++++++++++++++++++++--
 1 files changed, 22 insertions(+), 2 deletions(-)
---
diff --git a/libsoup/soup-session.c b/libsoup/soup-session.c
index 90e9189..c826157 100644
--- a/libsoup/soup-session.c
+++ b/libsoup/soup-session.c
@@ -2224,7 +2224,14 @@ soup_session_class_init (SoupSessionClass *session_class)
 	/**
 	 * SoupSession:idle-timeout:
 	 *
-	 * Connection lifetime when idle
+	 * Connection lifetime (in seconds) when idle. Any connection
+	 * left idle longer than this will be closed.
+	 *
+	 * Although you can change this property at any time, it will
+	 * only affect newly-created connections, not currently-open
+	 * ones. You can call soup_session_abort() after setting this
+	 * if you want to ensure that all future connections will have
+	 * this timeout value.
 	 *
 	 * Since: 2.4.1
 	 **/
@@ -2428,10 +2435,23 @@ soup_session_class_init (SoupSessionClass *session_class)
 				      FALSE,
 				      G_PARAM_READWRITE));
 	/**
+	 * SoupSession:timeout:
+	 *
+	 * The timeout (in seconds) for socket I/O operations
+	 * (including connecting to a server, and waiting for a reply
+	 * to an HTTP request).
+	 *
+	 * Although you can change this property at any time, it will
+	 * only affect newly-created connections, not currently-open
+	 * ones. You can call soup_session_abort() after setting this
+	 * if you want to ensure that all future connections will have
+	 * this timeout value.
+	 */
+	/**
 	 * SOUP_SESSION_TIMEOUT:
 	 *
 	 * Alias for the #SoupSession:timeout property. (The timeout
-	 * in seconds for blocking socket I/O operations.)
+	 * in seconds for socket I/O operations.)
 	 **/
 	g_object_class_install_property (
 		object_class, PROP_TIMEOUT,



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]