a8c4463c640a22b49588600eb9a00a3950f2772e
[openssl.git] / doc / ssl / SSL_set_connect_state.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_set_connect_state, SSL_get_accept_state - prepare SSL object to work in client or server mode
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  void SSL_set_connect_state(SSL *ssl);
12
13  void SSL_set_accept_state(SSL *ssl);
14
15 =head1 DESCRIPTION
16
17 SSL_set_connect_state() B<ssl> to work in client mode.
18
19 SSL_set_accept_state() B<ssl> to work in server mode.
20
21 =head1 NOTES
22
23 When the SSL_CTX object was created with L<SSL_CTX_new(3)|SSL_CTX_new(3)>,
24 it was either assigned a dedicated client method, a dedicated server
25 method, or a generic method, that can be used for both client and
26 server connections. (The method might have been changed with
27 L<SSL_CTX_set_ssl_version(3)|SSL_CTX_set_ssl_version(3)> or
28 SSL_set_ssl_method().)
29
30 In order to successfully accomplish the handshake, the SSL routines need
31 to know whether they should act in server or client mode. If the generic
32 method was used, this is not clear from the method itself and must be set
33 with either SSL_set_connect_state() or SSL_set_accept_state(). If these
34 routines are not called, the default value set when L<SSL_new(3)|SSL_new(3)>
35 is called is server mode.
36
37 =head1 RETURN VALUES
38
39 SSL_set_connect_state() and SSL_set_accept_state() do not return diagnostic
40 information.
41
42 =head1 SEE ALSO
43
44 L<ssl(3)|ssl(3)>, L<SSL_new(3)|SSL_new(3)>, L<SSL_CTX_new(3)|SSL_CTX_new(3)>,
45 L<SSL_CTX_set_ssl_version(3)|SSL_CTX_set_ssl_version(3)>
46
47 =cut