libcrypto/man/SSL_SESSION_get_time.3

         $NetBSD: SSL_SESSION_get_time.3,v 1.25 2024/09/08 13:08:33 christos Exp $

 -*- mode: troff; coding: utf-8 -*-
 Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

 Standard preamble:
 ========================================================================
..
..

..
 \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` ""
. ds C' ""
'br\}
. ds C`
. ds C'
'br\}

 Escape single quotes in literal strings from groff's Unicode transform.

 If the F register is >0, we'll generate index entries on stderr for
 titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 entries marked with X<> in POD. Of course, you'll have to process the
 output yourself in some meaningful fashion.

 Avoid warning from groff about undefined register 'F'.
..
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
 ========================================================================

 Title "SSL_SESSION_get_time 3"  SSL_SESSION_get_time 3 2024-09-03 3.0.15 OpenSSL
 For nroff, turn off justification. Always turn off hyphenation; it makes
 way too many mistakes in technical documents.
 NAME
SSL_SESSION_get_time, SSL_SESSION_set_time, SSL_SESSION_get_timeout,
SSL_SESSION_set_timeout,
SSL_get_time, SSL_set_time, SSL_get_timeout, SSL_set_timeout
\- retrieve and manipulate session time and timeout settings
 SYNOPSIS
 Header "SYNOPSIS" .Vb 1
 #include <openssl/ssl.h>
\&
 long SSL_SESSION_get_time(const SSL_SESSION *s);
 long SSL_SESSION_set_time(SSL_SESSION *s, long tm);
 long SSL_SESSION_get_timeout(const SSL_SESSION *s);
 long SSL_SESSION_set_timeout(SSL_SESSION *s, long tm);
\&
 long SSL_get_time(const SSL_SESSION *s);
 long SSL_set_time(SSL_SESSION *s, long tm);
 long SSL_get_timeout(const SSL_SESSION *s);
 long SSL_set_timeout(SSL_SESSION *s, long tm);
.Ve
 DESCRIPTION
 Header "DESCRIPTION" \fBSSL_SESSION_get_time() returns the time at which the session s was
established. The time is given in seconds since the Epoch and therefore
compatible to the time delivered by the time() call.

\fBSSL_SESSION_set_time() replaces the creation time of the session s with
the chosen value tm.

\fBSSL_SESSION_get_timeout() returns the timeout value set for session s
in seconds.

\fBSSL_SESSION_set_timeout() sets the timeout value for session s in seconds
to tm.

The SSL_get_time(), SSL_set_time(), SSL_get_timeout(), and SSL_set_timeout()
functions are synonyms for the SSL_SESSION_*() counterparts.
 NOTES
 Header "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
\fBSSL_CTX_set_timeout\|(3).
Using these functions it is possible to extend or shorten the lifetime
of the session.
 "RETURN VALUES"
 Header "RETURN VALUES" \fBSSL_SESSION_get_time() and SSL_SESSION_get_timeout() return the currently
valid values.

\fBSSL_SESSION_set_time() and SSL_SESSION_set_timeout() return 1 on success.

If any of the function is passed the NULL pointer for the session s,
0 is returned.
 "SEE ALSO"
 Header "SEE ALSO" \fBssl\|(7),
\fBSSL_CTX_set_timeout\|(3),
\fBSSL_get_default_timeout\|(3)
 COPYRIGHT
 Header "COPYRIGHT" Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
<https://www.openssl.org/source/license.html>.