Seth Woolley's Man Viewer

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(2,n,1 builtins) 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(3,n) indicating the current
       read(2,n,1 builtins) state of the SSL object ssl.

       SSL_rstate_string_long() returns a string(3,n) indicating the current read(2,n,1 builtins)
       state of the SSL object ssl.

NOTES
       When performing a read(2,n,1 builtins) operation, the SSL/TLS engine must parse the
       record, consisting of header and body. When working in(1,8) a blocking envi-
       ronment, SSL_rstate_string[_long]() should always return "RD"/"read(2,n,1 builtins)
       done".

       This function should only seldom be needed in(1,8) applications.

RETURN VALUES
       SSL_rstate_string() and SSL_rstate_string_long() can return the follow-
       ing values:

       "RH"/"read(2,n,1 builtins) header"
           The header of the record is being evaluated.

       "RB"/"read(2,n,1 builtins) body"
           The body of the record is being evaluated.

       "RD"/"read(2,n,1 builtins) done"
           The record has been completely processed.

       "unknown"/"unknown"
           The read(2,n,1 builtins) state is unknown. This should never happen.

SEE ALSO
       ssl(3)



0.9.7d                            2001-08-23              SSL_rstate_string(3)