[glib] gsocket: Clarify GSocket:blocking doesn’ t apply to ops with a parameter



commit 347e4a75ec745e09fa8433f557b363e5e95491cd
Author: Philip Withnall <philip withnall collabora co uk>
Date:   Wed Jul 29 14:08:31 2015 +0100

    gsocket: Clarify GSocket:blocking doesn’t apply to ops with a parameter
    
    Operations which take an explicit blocking parameter are completely
    unaffected by GSocket:blocking.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=751924

 gio/gsocket.c |    6 ++++--
 1 files changed, 4 insertions(+), 2 deletions(-)
---
diff --git a/gio/gsocket.c b/gio/gsocket.c
index 7003842..6ce4e7c 100644
--- a/gio/gsocket.c
+++ b/gio/gsocket.c
@@ -92,7 +92,8 @@
  * %NULL.
  *
  * Sockets operate in two general modes, blocking or non-blocking. When
- * in blocking mode all operations block until the requested operation
+ * in blocking mode all operations (which don’t take an explicit blocking
+ * parameter) block until the requested operation
  * is finished or there is an error. In non-blocking mode all calls that
  * would block return immediately with a %G_IO_ERROR_WOULD_BLOCK error.
  * To know when a call would successfully run you can call g_socket_condition_check(),
@@ -1093,7 +1094,8 @@ g_socket_new_from_fd (gint     fd,
  * @blocking: Whether to use blocking I/O or not.
  *
  * Sets the blocking mode of the socket. In blocking mode
- * all operations block until they succeed or there is an error. In
+ * all operations (which don’t take an explicit blocking parameter) block until
+ * they succeed or there is an error. In
  * non-blocking mode all functions return results immediately or
  * with a %G_IO_ERROR_WOULD_BLOCK error.
  *


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