For the operating systems where it matters, it is sometimes good to
[openssl.git] / doc / ssl / SSL_clear.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_clear - reset SSL object to allow another connection
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  int SSL_clear(SSL *ssl);
12
13 =head1 DESCRIPTION
14
15 Reset B<ssl> to allow another connection. All settings (method, ciphers,
16 BIOs) are kept. A completely negotiated B<SSL_SESSION> is not freed but left
17 untouched for the underlying B<SSL_CTX>.
18
19 =head1 RETURN VALUES
20
21 The following return values can occur:
22
23 =over 4
24
25 =item 0
26
27 The SSL_clear() operation could not be performed. Check the error stack to
28 find out the reason.
29
30 =item 1
31
32 The SSL_clear() operation was successful.
33
34 =back
35
36 L<SSL_new(3)|SSL_new(3)>, L<SSL_free(3)|SSL_free(3)>,
37 L<ssl(3)|ssl(3)>
38
39 =cut