@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}.
* @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
**/