summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2013-09-17 00:54:35 +0200
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2013-09-17 00:54:43 +0200
commit9654d4b90f0b2ebd300d402e615fff3f244593f6 (patch)
treef62bb5337ea488b39b18a3e3a2fdac0728d89d63 /lib
parent2486868a60f09a3e9d6384cc05af972416badc73 (diff)
downloadgnutls-9654d4b90f0b2ebd300d402e615fff3f244593f6.tar.gz
doc update
Diffstat (limited to 'lib')
-rw-r--r--lib/ext/heartbeat.c8
1 files changed, 6 insertions, 2 deletions
diff --git a/lib/ext/heartbeat.c b/lib/ext/heartbeat.c
index 048b4b4c6b..1c796acd24 100644
--- a/lib/ext/heartbeat.c
+++ b/lib/ext/heartbeat.c
@@ -40,8 +40,12 @@
* @session: is a #gnutls_session_t structure.
* @type: one of the GNUTLS_HB_* flags
*
- * This function will allow heartbeat messages to be
- * received.
+ * If this function is called with the %GNUTLS_HB_PEER_ALLOWED_TO_SEND
+ * GnuTLS will allow heartbeat messages to be received. Moreover it also
+ * request the peer to accept heartbeat messages.
+ *
+ * The function gnutls_heartbeat_allowed() can be used to test Whether
+ * locally generated heartbeat messages can be accepted by the peer.
*
* Since: 3.1.2
**/