"Fossies" - the Fresh Open Source Software Archive

Member "openssl-1.0.2q/doc/ssl/SSL_rstate_string.pod" (20 Nov 2018, 1238 Bytes) of package /linux/misc/openssl-1.0.2q.tar.gz:

Caution: As a special service "Fossies" has tried to format the requested pod source page into HTML format but links to other pod pages may be missing or even errorneous. Alternatively you can here view or download the uninterpreted pod source code. A member file download can also be achieved by clicking within a package contents listing on the according byte size field. See also the last Fossies "Diffs" side-by-side code changes report for "SSL_rstate_string.pod": 1.1.0g_vs_1.1.1-pre2.


SSL_rstate_string, SSL_rstate_string_long - get textual description of state of an SSL object during read operation


 #include <openssl/ssl.h>

 const char *SSL_rstate_string(SSL *ssl);
 const char *SSL_rstate_string_long(SSL *ssl);


SSL_rstate_string() returns a 2 letter string indicating the current read state of the SSL object ssl.

SSL_rstate_string_long() returns a string indicating the current read state of the SSL object ssl.


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.


SSL_rstate_string() and SSL_rstate_string_long() can return the following values:

"RH"/"read header"

The header of the record is being evaluated.

"RB"/"read body"

The body of the record is being evaluated.

"RD"/"read done"

The record has been completely processed.


The read state is unknown. This should never happen.