diff options
| author | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2013-09-17 00:54:35 +0200 |
|---|---|---|
| committer | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2013-09-17 00:54:43 +0200 |
| commit | 9654d4b90f0b2ebd300d402e615fff3f244593f6 (patch) | |
| tree | f62bb5337ea488b39b18a3e3a2fdac0728d89d63 | |
| parent | 2486868a60f09a3e9d6384cc05af972416badc73 (diff) | |
| download | gnutls-9654d4b90f0b2ebd300d402e615fff3f244593f6.tar.gz | |
doc update
| -rw-r--r-- | doc/cha-intro-tls.texi | 4 | ||||
| -rw-r--r-- | lib/ext/heartbeat.c | 8 |
2 files changed, 8 insertions, 4 deletions
diff --git a/doc/cha-intro-tls.texi b/doc/cha-intro-tls.texi index 74adfeccb5..de6155f9ef 100644 --- a/doc/cha-intro-tls.texi +++ b/doc/cha-intro-tls.texi @@ -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}. 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 **/ |