summaryrefslogtreecommitdiff
path: root/lib/gnutls_buffers.c
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2011-08-24 20:57:45 +0200
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2011-08-24 21:32:30 +0200
commit7f97d06161f257b0bb8b1106d1b64cbb58d29a3c (patch)
tree25486bb5f13bb752695871c2261e05ddf2805fb5 /lib/gnutls_buffers.c
parent7b74c80ed124af1de0d2d52f3c3b80d36b3a97bc (diff)
downloadgnutls-7f97d06161f257b0bb8b1106d1b64cbb58d29a3c.tar.gz
documentation changes.
Diffstat (limited to 'lib/gnutls_buffers.c')
-rw-r--r--lib/gnutls_buffers.c8
1 files changed, 5 insertions, 3 deletions
diff --git a/lib/gnutls_buffers.c b/lib/gnutls_buffers.c
index 38e9828122..4f946f4445 100644
--- a/lib/gnutls_buffers.c
+++ b/lib/gnutls_buffers.c
@@ -84,10 +84,12 @@ _gnutls_record_buffer_put (gnutls_session_t session,
* gnutls_record_check_pending:
* @session: is a #gnutls_session_t structure.
*
- * This function checks if there are any data to receive in the gnutls
- * buffers.
+ * This function checks if there are unread data
+ * in the gnutls buffers. If the return value is
+ * non-zero the next call to gnutls_record_recv()
+ * is guarranteed not to block.
*
- * Returns: The size of that data or 0.
+ * Returns: Returns the size of the data or zero.
**/
size_t
gnutls_record_check_pending (gnutls_session_t session)