doc: mention that the session data functions will fail prior to handshake completion

diff --git a/lib/session.c b/lib/session.c
index 4fd0abac124b71a3b7ac9510d5f61d192e62e5c7..a156ba4e5def0612d69c250ed0066bfaeadd2a3c 100644 (file)
--- a/lib/session.c
+++ b/lib/session.c
@@ -1,5 +1,6 @@
 /*
- * Copyright (C) 2000-2012 Free Software Foundation, Inc.
+ * Copyright (C) 2000-2016 Free Software Foundation, Inc.
+ * Copyright (C) 2016 Red Hat, Inc.
  *
  * Author: Nikos Mavrogiannopoulos
  *
@@ -35,6 +36,10 @@
  * The client should call this, and store the returned session data. A session
  * may be resumed later by calling gnutls_session_set_data().  
  *
+ * This function will fail if called prior to handshake completion. In
+ * case of false start TLS, the handshake completes only after data have
+ * been successfully received from the peer.
+ *
  * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
  *   an error code is returned.
  **/
@@ -80,6 +85,10 @@ gnutls_session_get_data(gnutls_session_t session,
  *
  * The returned @data are allocated and must be released using gnutls_free().
  *
+ * This function will fail if called prior to handshake completion. In
+ * case of false start TLS, the handshake completes only after data have
+ * been successfully received from the peer.
+ *
  * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
  *   an error code is returned.
  **/