diff options
| author | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2012-10-28 23:47:58 +0100 |
|---|---|---|
| committer | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2012-10-28 23:47:58 +0100 |
| commit | 37f9f77dfe2a1f54f489f980341e76078a3f39aa (patch) | |
| tree | baa5dab3c1e39962ed65cb0cdfc7a2a9e031e4e7 /lib/gnutls_session.c | |
| parent | 82c9716470d027af6bb34e06d0ed4af8fe80a4b3 (diff) | |
| download | gnutls-37f9f77dfe2a1f54f489f980341e76078a3f39aa.tar.gz | |
doc update
Diffstat (limited to 'lib/gnutls_session.c')
| -rw-r--r-- | lib/gnutls_session.c | 26 |
1 files changed, 9 insertions, 17 deletions
diff --git a/lib/gnutls_session.c b/lib/gnutls_session.c index 80d984cbeb..eea332c865 100644 --- a/lib/gnutls_session.c +++ b/lib/gnutls_session.c @@ -31,14 +31,10 @@ * @session_data: is a pointer to space to hold the session. * @session_data_size: is the session_data's size, or it will be set by the function. * - * Returns all session parameters, in order to support resuming. The - * client should call this, and keep the returned session, if he - * wants to resume that current version later by calling - * gnutls_session_set_data() This function must be called after a - * successful handshake. - * - * Resuming sessions is really useful and speedups connections after - * a successful one. + * Returns all session parameters needed to be stored to support resumption. + * 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 must be called after a successful handshake. * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise * an error code is returned. @@ -86,15 +82,11 @@ error: * @session: is a #gnutls_session_t structure. * @data: is a pointer to a datum that will hold the session. * - * Returns all session parameters, in order to support resuming. The - * client should call this, and keep the returned session, if he wants - * to resume that current version later by calling - * gnutls_session_set_data(). This function must be called after a - * successful handshake. The returned datum must be freed with - * gnutls_free(). - * - * Resuming sessions is really useful and speedups connections after - * a successful one. + * Returns all session parameters needed to be stored to support resumption. + * 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 must be called after a successful handshake. + * The returned @data are allocated and must be released using gnutls_free(). * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise * an error code is returned. |