-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
Standard preamble:
========================================================================
..
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================
Title "SSL_RSTATE_STRING 3ossl"
way too many mistakes in technical documents.
Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
Standard preamble:
========================================================================
..
.... \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================
Title "SSL_RSTATE_STRING 3ossl"
SSL_RSTATE_STRING 3ossl 2025-07-01 3.5.1 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makesway too many mistakes in technical documents.
NAME
SSL_rstate_string, SSL_rstate_string_long - get textual description of state of an SSL object during read operation
SYNOPSIS
Header "SYNOPSIS" .Vb 1
#include <openssl/ssl.h>
\&
const char *SSL_rstate_string(SSL *ssl);
const char *SSL_rstate_string_long(SSL *ssl);
.Ve
DESCRIPTION
Header "DESCRIPTION" \fBSSL_rstate_string() returns a 2 letter string indicating the current read state
of the SSL object ssl.
\fBSSL_rstate_string_long() returns a string indicating the current read state of the SSL object ssl.
NOTES
Header "NOTES" When performing a read operation, the SSL/TLS engine must parse the record,
consisting of header and body. When working in a blocking environment,
SSL_rstate_string[_long]() should always return "RD"/"read done".
This function should only seldom be needed in applications.
"RETURN VALUES"
Header "RETURN VALUES" \fBSSL_rstate_string() and SSL_rstate_string_long() can return the following
values:
"""RH""/""read header""" 4
Item """RH""/""read header""" The header of the record is being evaluated.
"""RB""/""read body""" 4
Item """RB""/""read body""" The body of the record is being evaluated.
"""unknown""/""unknown""" 4
Item """unknown""/""unknown""" The read state is unknown. This should never happen.
When used with QUIC SSL objects, these functions always return "RH"/"read header" in normal conditions.
"SEE ALSO"
Header "SEE ALSO" \fBssl\|(7)
COPYRIGHT
Header "COPYRIGHT" Copyright 2001-2023 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.