e9e4f6df507038a5414be6862115938da41f1462
[openssl.git] / doc / ssl / SSL_SESSION_get_protocol_version.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_SESSION_get_protocol_version - retrieve session protocol version
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  int SSL_SESSION_get_protocol_version(const SSL_SESSION *s);
12
13 =head1 DESCRIPTION
14
15 SSL_SESSION_get_protocol_version() returns the time at which the session B<s> was
16 established. The time is given in seconds since the Epoch and therefore
17 compatible to the time delivered by the time() call.
18
19 SSL_SESSION_set_time() replaces the creation time of the session B<s> with
20 the chosen value B<tm>.
21
22 SSL_SESSION_get_timeout() returns the timeout value set for session B<s>
23 in seconds.
24
25 SSL_SESSION_set_timeout() sets the timeout value for session B<s> in seconds
26 to B<tm>.
27
28 The SSL_get_time(), SSL_set_time(), SSL_get_timeout(), and SSL_set_timeout()
29 functions are synonyms for the SSL_SESSION_*() counterparts.
30
31 =head1 RETURN VALUES
32
33 SSL_SESSION_get_protocol_version() returns a number indicating the protocol
34 version used for the session; this number matches the constants I<e.g.>
35 B<TLS1_VERSION> or B<TLS1_2_VERSION>.
36
37 If the function is passed the NULL pointer for the session B<s>, 0 is returned.
38
39 =head1 SEE ALSO
40
41 L<ssl(3)>,
42 L<SSL_CTX_set_timeout(3)>,
43 L<SSL_get_default_timeout(3)>
44
45 =head1 COPYRIGHT
46
47 Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
48
49 Licensed under the OpenSSL license (the "License").  You may not use
50 this file except in compliance with the License.  You can obtain a copy
51 in the file LICENSE in the source distribution or at
52 L<https://www.openssl.org/source/license.html>.
53
54 =cut