summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@redhat.com>2017-01-26 14:49:33 +0100
committerNikos Mavrogiannopoulos <nmav@redhat.com>2017-01-26 16:10:50 +0100
commite173bec552096c7cecc918117a441921e964b8c8 (patch)
treefd82b1b9dcb4154f151cc729e39c4956d9a93054
parent65782f56a4b66f42df98f0be2630c6476d77cd2f (diff)
downloadgnutls-e173bec552096c7cecc918117a441921e964b8c8.tar.gz
heartbeat extension: doc update
Document how to calculate the total TLS data transmitted. Signed-off-by: Nikos Mavrogiannopoulos <nmav@redhat.com>
-rw-r--r--lib/ext/heartbeat.c5
1 files changed, 3 insertions, 2 deletions
diff --git a/lib/ext/heartbeat.c b/lib/ext/heartbeat.c
index 26a0928d9c..a1b6893fae 100644
--- a/lib/ext/heartbeat.c
+++ b/lib/ext/heartbeat.c
@@ -22,8 +22,6 @@
*/
/* This file implements the TLS heartbeat extension.
- * It was originally implemented during Google SoC 2012 by by Olga Smolenchuk,
- * and later rewritten by Nikos Mavrogiannopoulos.
*/
#include "errors.h"
@@ -151,6 +149,9 @@ heartbeat_send_data(gnutls_session_t session, const void *data,
* flag %GNUTLS_HEARTBEAT_WAIT, or you need to handle retransmissions
* and timeouts manually.
*
+ * The total TLS data transmitted as part of the ping message are given by
+ * the following formula: MAX(16, @data_size)+gnutls_record_overhead_size()+3.
+ *
* Returns: %GNUTLS_E_SUCCESS on success, otherwise a negative error code.
*
* Since: 3.1.2