This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

This manual page is associated with the Mac OS X developer tools. The software or headers described may not be present on your Mac OS X installation until you install the developer tools package. This package is available on your Mac OS X installation DVD, and the latest versions can be downloaded from developer.apple.com.

For more information about the manual page format, see the manual page for manpages(5).

SSL_rstate_string(3)                               OpenSSL                              SSL_rstate_string(3)



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

SYNOPSIS
        #include <openssl/ssl.h>

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

DESCRIPTION
       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.

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
       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.

       "unknown"/"unknown"
           The read state is unknown. This should never happen.

SEE ALSO
       ssl(3)



0.9.7l                                           2001-08-23                             SSL_rstate_string(3)