Add some accessor API's
[openssl.git] / doc / ssl / SSL_get_version.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_get_version, SSL_is_dtls - get the protocol information 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  int SSL_is_dtls(const SSL *ssl);
14
15 =head1 DESCRIPTION
16
17 SSL_get_version() returns the name of the protocol used for the
18 connection B<ssl>.
19
20 SSL_is_dtls() returns one if the connection is using DTLS, zero if not.
21
22 =head1 RETURN VALUES
23
24 SSL_get_verison() returns one of the following strings:
25
26 =over 4
27
28 =item SSLv3
29
30 The connection uses the SSLv3 protocol.
31
32 =item TLSv1
33
34 The connection uses the TLSv1.0 protocol.
35
36 =item TLSv1.1
37
38 The connection uses the TLSv1.1 protocol.
39
40 =item TLSv1.2
41
42 The connection uses the TLSv1.2 protocol.
43
44 =item unknown
45
46 This indicates that no version has been set (no connection established).
47
48 =back
49
50 =head1 SEE ALSO
51
52 L<ssl(3)>
53
54 =head1 HISTORY
55
56 SSL_is_dtls() was added in OpenSSL 1.1.0.
57
58 =head1 COPYRIGHT
59
60 Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
61
62 Licensed under the OpenSSL license (the "License").  You may not use
63 this file except in compliance with the License.  You can obtain a copy
64 in the file LICENSE in the source distribution or at
65 L<https://www.openssl.org/source/license.html>.
66
67 =cut