Debian Codegraph @

upstream/debian-unstable/man3/SSL_state_string.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SSL_STATE_STRING 3SSL"
58 .TH SSL_STATE_STRING 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SSL_state_string, SSL_state_string_long \- get textual description of state of an SSL object
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& const char *SSL_state_string(const SSL *ssl);
71 \& const char *SSL_state_string_long(const SSL *ssl);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 \&\fBSSL_state_string()\fR returns an abbreviated string indicating the current state
76 of the SSL object \fBssl\fR. The returned NUL-terminated string contains 6 or fewer characters.
77 .PP
78 \&\fBSSL_state_string_long()\fR returns a descriptive string indicating the current state of
79 the SSL object \fBssl\fR.
80 .SH NOTES
81 .IX Header "NOTES"
82 During its use, an SSL objects passes several states. The state is internally
83 maintained. Querying the state information is not very informative before
84 or when a connection has been established. It however can be of significant
85 interest during the handshake.
86 .PP
87 When using nonblocking sockets, the function call performing the handshake
88 may return with SSL_ERROR_WANT_READ or SSL_ERROR_WANT_WRITE condition,
89 so that SSL_state_string[_long]() may be called.
90 .PP
91 For both blocking or nonblocking sockets, the details state information
92 can be used within the info_callback function set with the
93 \&\fBSSL_set_info_callback()\fR call.
94 .SH "RETURN VALUES"
95 .IX Header "RETURN VALUES"
96 Detailed description of possible states to be included later.
97 .SH "SEE ALSO"
98 .IX Header "SEE ALSO"
99 \&\fBssl\fR\|(7), \fBSSL_CTX_set_info_callback\fR\|(3)
100 .SH COPYRIGHT
101 .IX Header "COPYRIGHT"
102 Copyright 2001\-2021 The OpenSSL Project Authors. All Rights Reserved.
103 .PP
104 Licensed under the Apache License 2.0 (the "License"). You may not use
105 this file except in compliance with the License. You can obtain a copy
106 in the file LICENSE in the source distribution or at
107 <https://www.openssl.org/source/license.html>.