diff options
author | schwarze <> | 2016-11-05 15:32:20 +0000 |
---|---|---|
committer | schwarze <> | 2016-11-05 15:32:20 +0000 |
commit | 5af30545c000c195ca6e44f207da004e5780ddb5 (patch) | |
tree | 1672f1234352c29443fcacb44e22f1b20f174d99 /src/lib/libssl/doc/SSL_state_string.3 | |
parent | ba7c6bac5d2c870a4d1c1ce9f08db5e57c660625 (diff) | |
download | openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.tar.gz openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.tar.bz2 openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.zip |
move manual pages from doc/ to man/ for consistency with other
libraries, in particular considering that there are unrelated
files in doc/; requested by jsing@ and beck@
Diffstat (limited to 'src/lib/libssl/doc/SSL_state_string.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_state_string.3 | 57 |
1 files changed, 0 insertions, 57 deletions
diff --git a/src/lib/libssl/doc/SSL_state_string.3 b/src/lib/libssl/doc/SSL_state_string.3 deleted file mode 100644 index e9a042a3ce..0000000000 --- a/src/lib/libssl/doc/SSL_state_string.3 +++ /dev/null | |||
@@ -1,57 +0,0 @@ | |||
1 | .\" | ||
2 | .\" $OpenBSD: SSL_state_string.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
3 | .\" | ||
4 | .Dd $Mdocdate: December 2 2014 $ | ||
5 | .Dt SSL_STATE_STRING 3 | ||
6 | .Os | ||
7 | .Sh NAME | ||
8 | .Nm SSL_state_string , | ||
9 | .Nm SSL_state_string_long | ||
10 | .Nd get textual description of state of an SSL object | ||
11 | .Sh SYNOPSIS | ||
12 | .In openssl/ssl.h | ||
13 | .Ft const char * | ||
14 | .Fn SSL_state_string "const SSL *ssl" | ||
15 | .Ft const char * | ||
16 | .Fn SSL_state_string_long "const SSL *ssl" | ||
17 | .Sh DESCRIPTION | ||
18 | .Fn SSL_state_string | ||
19 | returns a 6 letter string indicating the current state of the | ||
20 | .Vt SSL | ||
21 | object | ||
22 | .Fa ssl . | ||
23 | .Pp | ||
24 | .Fn SSL_state_string_long | ||
25 | returns a string indicating the current state of the | ||
26 | .Vt SSL | ||
27 | object | ||
28 | .Fa ssl . | ||
29 | .Sh NOTES | ||
30 | During its use, an | ||
31 | .Vt SSL | ||
32 | object passes several states. | ||
33 | The state is internally maintained. | ||
34 | Querying the state information is not very informative before or when a | ||
35 | connection has been established. | ||
36 | It however can be of significant interest during the handshake. | ||
37 | .Pp | ||
38 | When using non-blocking sockets, | ||
39 | the function call performing the handshake may return with | ||
40 | .Dv SSL_ERROR_WANT_READ | ||
41 | or | ||
42 | .Dv SSL_ERROR_WANT_WRITE | ||
43 | condition, so that | ||
44 | .Fn SSL_state_string[_long] | ||
45 | may be called. | ||
46 | .Pp | ||
47 | For both blocking or non-blocking sockets, | ||
48 | the details state information can be used within the | ||
49 | .Fn info_callback | ||
50 | function set with the | ||
51 | .Xr SSL_set_info_callback 3 | ||
52 | call. | ||
53 | .Sh RETURN VALUES | ||
54 | Detailed description of possible states to be included later. | ||
55 | .Sh SEE ALSO | ||
56 | .Xr ssl 3 , | ||
57 | .Xr SSL_CTX_set_info_callback 3 | ||