diff options
author | Nikos Mavrogiannopoulos <nmav@redhat.com> | 2016-07-22 10:57:37 +0200 |
---|---|---|
committer | Nikos Mavrogiannopoulos <nmav@redhat.com> | 2016-07-22 10:57:37 +0200 |
commit | a8b9017c47c2d87f6c513d43d0201c70aac1c4f2 (patch) | |
tree | d9a842c952a714c93eb966e5bb8d2c04358cd268 | |
parent | 31b05c3c255a48cd2f43dfb5ca070c37530da726 (diff) | |
download | gnutls-a8b9017c47c2d87f6c513d43d0201c70aac1c4f2.tar.gz |
doc: mention that the session data functions will fail prior to handshake completion
-rw-r--r-- | lib/session.c | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/lib/session.c b/lib/session.c index 4fd0abac12..a156ba4e5d 100644 --- 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. **/ |