summaryrefslogtreecommitdiff
path: root/lib/system.c
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2015-01-25 08:28:13 +0100
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2015-01-25 08:33:30 +0100
commit5de4b3d1f6b2b68b35cb689a1c964f71a63134c1 (patch)
treef594099512b2b88f1f5a7317845bfceb09b96bb0 /lib/system.c
parent6e591e4b10d92ad9d1435416014bc092fad861f4 (diff)
downloadgnutls-5de4b3d1f6b2b68b35cb689a1c964f71a63134c1.tar.gz
doc update
Diffstat (limited to 'lib/system.c')
-rw-r--r--lib/system.c5
1 files changed, 3 insertions, 2 deletions
diff --git a/lib/system.c b/lib/system.c
index 4753301fda..cace67163c 100644
--- a/lib/system.c
+++ b/lib/system.c
@@ -132,10 +132,11 @@ system_read(gnutls_transport_ptr_t ptr, void *data, size_t data_size)
* @ms: The number of milliseconds to wait.
*
* Wait for data to be received from the provided socket (@ptr) within a
- * timeout period in milliseconds.
+ * timeout period in milliseconds, using select() on the provided @ptr.
*
* This function is provided as a helper for constructing custom
- * callbacks for gnutls_transport_set_pull_timeout_function().
+ * callbacks for gnutls_transport_set_pull_timeout_function(),
+ * which can be used if you rely on socket file descriptors.
*
* Returns -1 on error, 0 on timeout, positive value if data are available for reading.
*