diff options
Diffstat (limited to 'src/lib/libssl/src/doc/ssl/SSL_SESSION_get_time.pod')
| -rw-r--r-- | src/lib/libssl/src/doc/ssl/SSL_SESSION_get_time.pod | 66 |
1 files changed, 0 insertions, 66 deletions
diff --git a/src/lib/libssl/src/doc/ssl/SSL_SESSION_get_time.pod b/src/lib/libssl/src/doc/ssl/SSL_SESSION_get_time.pod deleted file mode 100644 index a9b44b3a5c..0000000000 --- a/src/lib/libssl/src/doc/ssl/SSL_SESSION_get_time.pod +++ /dev/null | |||
| @@ -1,66 +0,0 @@ | |||
| 1 | =pod | ||
| 2 | |||
| 3 | =head1 NAME | ||
| 4 | |||
| 5 | SSL_SESSION_get_time, SSL_SESSION_set_time, SSL_SESSION_get_timeout, | ||
| 6 | SSL_SESSION_set_timeout - retrieve and manipulate session time and timeout | ||
| 7 | settings | ||
| 8 | |||
| 9 | =head1 SYNOPSIS | ||
| 10 | |||
| 11 | #include <openssl/ssl.h> | ||
| 12 | |||
| 13 | long SSL_SESSION_get_time(const SSL_SESSION *s); | ||
| 14 | long SSL_SESSION_set_time(SSL_SESSION *s, long tm); | ||
| 15 | long SSL_SESSION_get_timeout(const SSL_SESSION *s); | ||
| 16 | long SSL_SESSION_set_timeout(SSL_SESSION *s, long tm); | ||
| 17 | |||
| 18 | long SSL_get_time(const SSL_SESSION *s); | ||
| 19 | long SSL_set_time(SSL_SESSION *s, long tm); | ||
| 20 | long SSL_get_timeout(const SSL_SESSION *s); | ||
| 21 | long SSL_set_timeout(SSL_SESSION *s, long tm); | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | SSL_SESSION_get_time() returns the time at which the session B<s> was | ||
| 26 | established. The time is given in seconds since the Epoch and therefore | ||
| 27 | compatible to the time delivered by the time() call. | ||
| 28 | |||
| 29 | SSL_SESSION_set_time() replaces the creation time of the session B<s> with | ||
| 30 | the chosen value B<tm>. | ||
| 31 | |||
| 32 | SSL_SESSION_get_timeout() returns the timeout value set for session B<s> | ||
| 33 | in seconds. | ||
| 34 | |||
| 35 | SSL_SESSION_set_timeout() sets the timeout value for session B<s> in seconds | ||
| 36 | to B<tm>. | ||
| 37 | |||
| 38 | The SSL_get_time(), SSL_set_time(), SSL_get_timeout(), and SSL_set_timeout() | ||
| 39 | functions are synonyms for the SSL_SESSION_*() counterparts. | ||
| 40 | |||
| 41 | =head1 NOTES | ||
| 42 | |||
| 43 | Sessions are expired by examining the creation time and the timeout value. | ||
| 44 | Both are set at creation time of the session to the actual time and the | ||
| 45 | default timeout value at creation, respectively, as set by | ||
| 46 | L<SSL_CTX_set_timeout(3)|SSL_CTX_set_timeout(3)>. | ||
| 47 | Using these functions it is possible to extend or shorten the lifetime | ||
| 48 | of the session. | ||
| 49 | |||
| 50 | =head1 RETURN VALUES | ||
| 51 | |||
| 52 | SSL_SESSION_get_time() and SSL_SESSION_get_timeout() return the currently | ||
| 53 | valid values. | ||
| 54 | |||
| 55 | SSL_SESSION_set_time() and SSL_SESSION_set_timeout() return 1 on success. | ||
| 56 | |||
| 57 | If any of the function is passed the NULL pointer for the session B<s>, | ||
| 58 | 0 is returned. | ||
| 59 | |||
| 60 | =head1 SEE ALSO | ||
| 61 | |||
| 62 | L<ssl(3)|ssl(3)>, | ||
| 63 | L<SSL_CTX_set_timeout(3)|SSL_CTX_set_timeout(3)>, | ||
| 64 | L<SSL_get_default_timeout(3)|SSL_get_default_timeout(3)> | ||
| 65 | |||
| 66 | =cut | ||
