From: Nikos Mavrogiannopoulos <nmav@gnutls.org>
Date: Mon, 21 Feb 2011 23:07:15 +0000 (+0100)
Subject: documented the DTLS sequence particularities.
X-Git-Tag: gnutls_2_99_0~199
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=51c605d67a658f4ae675e1a09eec8e4f218f3fde;p=thirdparty%2Fgnutls.git

documented the DTLS sequence particularities.
---

diff --git a/lib/gnutls_record.c b/lib/gnutls_record.c
index 3f6ea81e9a..5f93fc5d3e 100644
--- a/lib/gnutls_record.c
+++ b/lib/gnutls_record.c
@@ -1312,7 +1312,12 @@ gnutls_record_recv (gnutls_session_t session, void *data, size_t data_size)
  *
  * This function is the same as gnutls_record_recv(), except that
  * it returns in addition to data, the sequence number of the data.
- * This is useful in DTLS.
+ * This is useful in DTLS where record packets might be received
+ * out-of-order.
+ *
+ * In DTLS the least significant 48-bits are a unique sequence
+ * number, per handshake. If your application is using TLS re-handshakes
+ * then the full 64-bits should be used as a unique sequence.
  *
  * Returns: the number of bytes received and zero on EOF.  A negative
  *   error code is returned in case of an error.  The number of bytes