summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2013-05-01 10:47:09 +0300
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2013-05-01 10:47:09 +0300
commitc8e7cc4218b43a83806c7b7c164bfc52d1e00453 (patch)
treed850071b92dce37174b58d83d73257b456badb91
parent3a46382ea6c92e60090e2aa81ab6b671f0be0f46 (diff)
downloadgnutls-c8e7cc4218b43a83806c7b7c164bfc52d1e00453.tar.gz
doc update
-rw-r--r--lib/gnutls_dtls.c11
1 files changed, 10 insertions, 1 deletions
diff --git a/lib/gnutls_dtls.c b/lib/gnutls_dtls.c
index 30549a7afb..2785e7bf4a 100644
--- a/lib/gnutls_dtls.c
+++ b/lib/gnutls_dtls.c
@@ -781,6 +781,10 @@ unsigned int diff;
* for (i.e. #gnutls_session_t) is the one that the
* original incoming packet was originated from.
*
+ * This function must be called at the first incoming packet,
+ * prior to allocating any resources and must be succeeded
+ * by gnutls_dtls_cookie_verify().
+ *
* Returns: the number of bytes sent, or a negative error code.
*
* Since: 3.0
@@ -878,11 +882,13 @@ uint8_t digest[C_HASH_SIZE];
* @msg_size: The size of the message.
* @prestate: The cookie of this client.
*
- * This function will verify an incoming message for
+ * This function will verify the received message for
* a valid cookie. If a valid cookie is returned then
* it should be associated with the session using
* gnutls_dtls_prestate_set();
*
+ * This function must be called after gnutls_dtls_cookie_send().
+ *
* Returns: %GNUTLS_E_SUCCESS (0) on success, or a negative error code.
*
* Since: 3.0
@@ -953,6 +959,9 @@ uint8_t digest[C_HASH_SIZE];
* the cookie authentication with the client, with the newly
* established session.
*
+ * This functions must be called after a successful gnutls_dtls_cookie_verify()
+ * and should be succeeded by the actual DTLS handshake using gnutls_handshake().
+ *
* Since: 3.0
**/
void gnutls_dtls_prestate_set(gnutls_session_t session, gnutls_dtls_prestate_st* prestate)