]> git.ipfire.org Git - thirdparty/gnutls.git/commitdiff
doc update
authorNikos Mavrogiannopoulos <nmav@gnutls.org>
Mon, 16 Sep 2013 22:54:35 +0000 (00:54 +0200)
committerNikos Mavrogiannopoulos <nmav@gnutls.org>
Mon, 16 Sep 2013 22:54:43 +0000 (00:54 +0200)
doc/cha-intro-tls.texi
lib/ext/heartbeat.c

index 74adfeccb574016db0dafbe515f65d349cea09c5..de6155f9ef844b30c5cd3054c5fdb8b410aa51ba 100644 (file)
@@ -467,8 +467,8 @@ Since version 3.1.3 GnuTLS clients transparently support session tickets.
 @cindex TLS extensions
 @cindex heartbeat
 
-This TLS extension allows to ping and receive confirmation from the peer,
-is described in @xcite{RFC6520}. The extension is disabled by default and
+This is a TLS extension that allows to ping and receive confirmation from the peer,
+and is described in @xcite{RFC6520}. The extension is disabled by default and
 @funcref{gnutls_heartbeat_enable} can be used to enable it. A policy
 may be negotiated to only allow sending heartbeat messages or sending and receiving.
 The current session policy can be checked with @funcref{gnutls_heartbeat_allowed}. 
index 048b4b4c6b1bb78d24c40e2d2b13b7854931aef8..1c796acd24c19c0e85a4d0224d5c4c003724470b 100644 (file)
   * @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
   **/