root
/
openssl
mirror of https://github.com/openssl/openssl.git
1
0
Fork 0
Code Issues Actions 7 Packages Projects Releases Wiki Activity
openssl/doc/man3/SSL_SESSION_get_time.pod

77 lines
2.3 KiB
Plaintext
Raw Normal View History

Documenting session caching, 2nd step.
2001-02-05 02:05:27 +08:00
=pod
=head1 NAME
More doc cleanup Add missing entries to NAME section Add SYNOPSIS lines, remove old NAME entries Update find-doc-nits; better regexp's for parsing SYNOPSIS sections. Rename a couple of files to have an API name. Remove RSA_private_decrypt; it was duplicate content Update for recent doc additions Reviewed-by: Matt Caswell <matt@openssl.org>
2016-06-21 19:03:34 +08:00
SSL_SESSION_get_time, SSL_SESSION_set_time, SSL_SESSION_get_timeout,
Provide documentation for missing SSL_SESSION_* functions Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/3052)
2017-03-25 00:01:50 +08:00
SSL_SESSION_set_timeout,
Look for comma before - in POD pages [skip ci] Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/3021)
2017-03-24 01:04:52 +08:00
SSL_get_time, SSL_set_time, SSL_get_timeout, SSL_set_timeout
More doc cleanup Add missing entries to NAME section Add SYNOPSIS lines, remove old NAME entries Update find-doc-nits; better regexp's for parsing SYNOPSIS sections. Rename a couple of files to have an API name. Remove RSA_private_decrypt; it was duplicate content Update for recent doc additions Reviewed-by: Matt Caswell <matt@openssl.org>
2016-06-21 19:03:34 +08:00
- retrieve and manipulate session time and timeout settings
Documenting session caching, 2nd step.
2001-02-05 02:05:27 +08:00
=head1 SYNOPSIS
#include <openssl/ssl.h>
update docs (recent constification)
2005-03-30 19:50:14 +08:00
long SSL_SESSION_get_time(const SSL_SESSION *s);
Documenting session caching, 2nd step.
2001-02-05 02:05:27 +08:00
long SSL_SESSION_set_time(SSL_SESSION *s, long tm);
update docs (recent constification)
2005-03-30 19:50:14 +08:00
long SSL_SESSION_get_timeout(const SSL_SESSION *s);
Documenting session caching, 2nd step.
2001-02-05 02:05:27 +08:00
long SSL_SESSION_set_timeout(SSL_SESSION *s, long tm);
update docs (recent constification)
2005-03-30 19:50:14 +08:00
long SSL_get_time(const SSL_SESSION *s);
Documenting session caching, 2nd step.
2001-02-05 02:05:27 +08:00
long SSL_set_time(SSL_SESSION *s, long tm);
update docs (recent constification)
2005-03-30 19:50:14 +08:00
long SSL_get_timeout(const SSL_SESSION *s);
Documenting session caching, 2nd step.
2001-02-05 02:05:27 +08:00
long SSL_set_timeout(SSL_SESSION *s, long tm);
=head1 DESCRIPTION
SSL_SESSION_get_time() returns the time at which the session B<s> was
established. The time is given in seconds since the Epoch and therefore
compatible to the time delivered by the time() call.
SSL_SESSION_set_time() replaces the creation time of the session B<s> with
the chosen value B<tm>.
SSL_SESSION_get_timeout() returns the timeout value set for session B<s>
in seconds.
SSL_SESSION_set_timeout() sets the timeout value for session B<s> in seconds
to B<tm>.
The SSL_get_time(), SSL_set_time(), SSL_get_timeout(), and SSL_set_timeout()
functions are synonyms for the SSL_SESSION_*() counterparts.
=head1 NOTES
Sessions are expired by examining the creation time and the timeout value.
Both are set at creation time of the session to the actual time and the
default timeout value at creation, respectively, as set by
Fix L<> content in manpages L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-08-18 03:21:33 +08:00
L<SSL_CTX_set_timeout(3)>.
Documenting session caching, 2nd step.
2001-02-05 02:05:27 +08:00
Using these functions it is possible to extend or shorten the lifetime
of the session.
=head1 RETURN VALUES
SSL_SESSION_get_time() and SSL_SESSION_get_timeout() return the currently
valid values.
SSL_SESSION_set_time() and SSL_SESSION_set_timeout() return 1 on success.
Fix nits in pod files. Add doc-nit-check to help find future issues. Make podchecker be almost clean. Remove trailing whitespace. Tab expansion Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-20 20:11:46 +08:00
If any of the function is passed the NULL pointer for the session B<s>,
Documenting session caching, 2nd step.
2001-02-05 02:05:27 +08:00
0 is returned.
=head1 SEE ALSO
Fix referenses in section 3 manuals Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1900)
2016-11-11 16:33:09 +08:00
L<ssl(7)>,
Fix L<> content in manpages L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-08-18 03:21:33 +08:00
L<SSL_CTX_set_timeout(3)>,
L<SSL_get_default_timeout(3)>
Documenting session caching, 2nd step.
2001-02-05 02:05:27 +08:00
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
=head1 COPYRIGHT
Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
Following the license change, modify the boilerplates in doc/man3/ [skip ci] Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7829)
2018-12-06 21:04:44 +08:00
Licensed under the Apache License 2.0 (the "License"). You may not use
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut