summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@redhat.com>2016-04-08 15:40:06 +0200
committerNikos Mavrogiannopoulos <nmav@redhat.com>2016-04-08 15:43:56 +0200
commit083872727157c54c2e115aba6d71c1e6adb6d87a (patch)
treeadbab4afe469d09bacbc736ff7da1348da434f31
parentefedab6be53e8d4d42f6ab7a71e85e722160aa83 (diff)
downloadgnutls-083872727157c54c2e115aba6d71c1e6adb6d87a.tar.gz
gnutls_record_get_direction: doc update [ci skip]
-rw-r--r--lib/gnutls_state.c18
1 files changed, 7 insertions, 11 deletions
diff --git a/lib/gnutls_state.c b/lib/gnutls_state.c
index abcce06bb8..19ef576cf3 100644
--- a/lib/gnutls_state.c
+++ b/lib/gnutls_state.c
@@ -1354,20 +1354,16 @@ void
* @session: is a #gnutls_session_t type.
*
* This function provides information about the internals of the
- * record protocol and is only useful if a prior gnutls function call
- * (e.g. gnutls_handshake()) was interrupted for some reason, that
+ * record protocol and is only useful if a prior gnutls function call,
+ * e.g. gnutls_handshake(), was interrupted for some reason. That
* is, if a function returned %GNUTLS_E_INTERRUPTED or
- * %GNUTLS_E_AGAIN. In such a case, you might want to call select()
- * or poll() before calling the interrupted gnutls function again. To
- * tell you whether a file descriptor should be selected for either
- * reading or writing, gnutls_record_get_direction() returns 0 if the
- * interrupted function was trying to read data, and 1 if it was
- * trying to write data.
- *
- * This function's output is unreliable if you are using the
+ * %GNUTLS_E_AGAIN. In such a case, you might want to call select()
+ * or poll() before restoring the interrupted gnutls function.
+ *
+ * This function's output is unreliable if you are using the same
* @session in different threads, for sending and receiving.
*
- * Returns: 0 if trying to read data, 1 if trying to write data.
+ * Returns: 0 if interrupted while trying to read data, or 1 while trying to write data.
**/
int gnutls_record_get_direction(gnutls_session_t session)
{