]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - crypto/openssl/doc/ssl/SSL_get_version.pod
Merge OpenSSL 1.0.2p.
[FreeBSD/FreeBSD.git] / crypto / openssl / doc / ssl / SSL_get_version.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_get_version - get the protocol version of a connection.
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  const char *SSL_get_version(const SSL *ssl);
12
13 =head1 DESCRIPTION
14
15 SSL_get_version() returns the name of the protocol used for the
16 connection B<ssl>. It should only be called after the initial handshake has been
17 completed. Prior to that the results returned from this function may be
18 unreliable.
19
20 =head1 RETURN VALUES
21
22 The following strings can be returned:
23
24 =over 4
25
26 =item SSLv2
27
28 The connection uses the SSLv2 protocol.
29
30 =item SSLv3
31
32 The connection uses the SSLv3 protocol.
33
34 =item TLSv1
35
36 The connection uses the TLSv1.0 protocol.
37
38 =item TLSv1.1
39
40 The connection uses the TLSv1.1 protocol.
41
42 =item TLSv1.2
43
44 The connection uses the TLSv1.2 protocol.
45
46 =item unknown
47
48 This indicates an unknown protocol version.
49
50 =back
51
52 =head1 SEE ALSO
53
54 L<ssl(3)|ssl(3)>
55
56 =cut