Blame doc/man3/SSL_SESSION_get_time.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
SSL_SESSION_get_time, SSL_SESSION_set_time, SSL_SESSION_get_timeout,
Packit c4476c
SSL_SESSION_set_timeout,
Packit c4476c
SSL_get_time, SSL_set_time, SSL_get_timeout, SSL_set_timeout
Packit c4476c
- retrieve and manipulate session time and timeout settings
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/ssl.h>
Packit c4476c
Packit c4476c
 long SSL_SESSION_get_time(const SSL_SESSION *s);
Packit c4476c
 long SSL_SESSION_set_time(SSL_SESSION *s, long tm);
Packit c4476c
 long SSL_SESSION_get_timeout(const SSL_SESSION *s);
Packit c4476c
 long SSL_SESSION_set_timeout(SSL_SESSION *s, long tm);
Packit c4476c
Packit c4476c
 long SSL_get_time(const SSL_SESSION *s);
Packit c4476c
 long SSL_set_time(SSL_SESSION *s, long tm);
Packit c4476c
 long SSL_get_timeout(const SSL_SESSION *s);
Packit c4476c
 long SSL_set_timeout(SSL_SESSION *s, long tm);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
SSL_SESSION_get_time() returns the time at which the session B<s> was
Packit c4476c
established. The time is given in seconds since the Epoch and therefore
Packit c4476c
compatible to the time delivered by the time() call.
Packit c4476c
Packit c4476c
SSL_SESSION_set_time() replaces the creation time of the session B<s> with
Packit c4476c
the chosen value B<tm>.
Packit c4476c
Packit c4476c
SSL_SESSION_get_timeout() returns the timeout value set for session B<s>
Packit c4476c
in seconds.
Packit c4476c
Packit c4476c
SSL_SESSION_set_timeout() sets the timeout value for session B<s> in seconds
Packit c4476c
to B<tm>.
Packit c4476c
Packit c4476c
The SSL_get_time(), SSL_set_time(), SSL_get_timeout(), and SSL_set_timeout()
Packit c4476c
functions are synonyms for the SSL_SESSION_*() counterparts.
Packit c4476c
Packit c4476c
=head1 NOTES
Packit c4476c
Packit c4476c
Sessions are expired by examining the creation time and the timeout value.
Packit c4476c
Both are set at creation time of the session to the actual time and the
Packit c4476c
default timeout value at creation, respectively, as set by
Packit c4476c
L<SSL_CTX_set_timeout(3)>.
Packit c4476c
Using these functions it is possible to extend or shorten the lifetime
Packit c4476c
of the session.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
SSL_SESSION_get_time() and SSL_SESSION_get_timeout() return the currently
Packit c4476c
valid values.
Packit c4476c
Packit c4476c
SSL_SESSION_set_time() and SSL_SESSION_set_timeout() return 1 on success.
Packit c4476c
Packit c4476c
If any of the function is passed the NULL pointer for the session B<s>,
Packit c4476c
0 is returned.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<ssl(7)>,
Packit c4476c
L<SSL_CTX_set_timeout(3)>,
Packit c4476c
L<SSL_get_default_timeout(3)>
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut