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_rstate_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_rstate_string.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_rstate_string.3 | 55 |
1 files changed, 0 insertions, 55 deletions
diff --git a/src/lib/libssl/doc/SSL_rstate_string.3 b/src/lib/libssl/doc/SSL_rstate_string.3 deleted file mode 100644 index 81d83e52a1..0000000000 --- a/src/lib/libssl/doc/SSL_rstate_string.3 +++ /dev/null | |||
@@ -1,55 +0,0 @@ | |||
1 | .\" | ||
2 | .\" $OpenBSD: SSL_rstate_string.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
3 | .\" | ||
4 | .Dd $Mdocdate: December 2 2014 $ | ||
5 | .Dt SSL_RSTATE_STRING 3 | ||
6 | .Os | ||
7 | .Sh NAME | ||
8 | .Nm SSL_rstate_string , | ||
9 | .Nm SSL_rstate_string_long | ||
10 | .Nd get textual description of state of an SSL object during read operation | ||
11 | .Sh SYNOPSIS | ||
12 | .In openssl/ssl.h | ||
13 | .Ft const char * | ||
14 | .Fn SSL_rstate_string "SSL *ssl" | ||
15 | .Ft const char * | ||
16 | .Fn SSL_rstate_string_long "SSL *ssl" | ||
17 | .Sh DESCRIPTION | ||
18 | .Fn SSL_rstate_string | ||
19 | returns a 2-letter string indicating the current read state of the | ||
20 | .Vt SSL | ||
21 | object | ||
22 | .Fa ssl . | ||
23 | .Pp | ||
24 | .Fn SSL_rstate_string_long | ||
25 | returns a string indicating the current read state of the | ||
26 | .Vt SSL | ||
27 | object | ||
28 | .Fa ssl . | ||
29 | .Sh NOTES | ||
30 | When performing a read operation, the SSL/TLS engine must parse the record, | ||
31 | consisting of header and body. | ||
32 | When working in a blocking environment, | ||
33 | .Fn SSL_rstate_string[_long] | ||
34 | should always return | ||
35 | .Qo RD Qc Ns / Ns Qo read done Qc . | ||
36 | .Pp | ||
37 | This function should only seldom be needed in applications. | ||
38 | .Sh RETURN VALUES | ||
39 | .Fn SSL_rstate_string | ||
40 | and | ||
41 | .Fn SSL_rstate_string_long | ||
42 | can return the following values: | ||
43 | .Bl -tag -width Ds | ||
44 | .It Qo RH Qc Ns / Ns Qo read header Qc | ||
45 | The header of the record is being evaluated. | ||
46 | .It Qo RB Qc Ns / Ns Qo read body Qc | ||
47 | The body of the record is being evaluated. | ||
48 | .It Qo RD Qc Ns / Ns Qo read done Qc | ||
49 | The record has been completely processed. | ||
50 | .It Qo unknown Qc Ns / Ns Qo unknown Qc | ||
51 | The read state is unknown. | ||
52 | This should never happen. | ||
53 | .El | ||
54 | .Sh SEE ALSO | ||
55 | .Xr ssl 3 | ||