1: =pod
    2: 
    3: =head1 NAME
    4: 
    5: SSL_rstate_string, SSL_rstate_string_long - get textual description of state of an SSL object during read operation
    6: 
    7: =head1 SYNOPSIS
    8: 
    9:  #include <openssl/ssl.h>
   10: 
   11:  const char *SSL_rstate_string(SSL *ssl);
   12:  const char *SSL_rstate_string_long(SSL *ssl);
   13: 
   14: =head1 DESCRIPTION
   15: 
   16: SSL_rstate_string() returns a 2 letter string indicating the current read state
   17: of the SSL object B<ssl>.
   18: 
   19: SSL_rstate_string_long() returns a string indicating the current read state of
   20: the SSL object B<ssl>.
   21: 
   22: =head1 NOTES
   23: 
   24: When performing a read operation, the SSL/TLS engine must parse the record,
   25: consisting of header and body. When working in a blocking environment,
   26: SSL_rstate_string[_long]() should always return "RD"/"read done".
   27: 
   28: This function should only seldom be needed in applications.
   29: 
   30: =head1 RETURN VALUES
   31: 
   32: SSL_rstate_string() and SSL_rstate_string_long() can return the following
   33: values:
   34: 
   35: =over 4
   36: 
   37: =item "RH"/"read header"
   38: 
   39: The header of the record is being evaluated.
   40: 
   41: =item "RB"/"read body"
   42: 
   43: The body of the record is being evaluated.
   44: 
   45: =item "RD"/"read done"
   46: 
   47: The record has been completely processed.
   48: 
   49: =item "unknown"/"unknown"
   50: 
   51: The read state is unknown. This should never happen.
   52: 
   53: =back
   54: 
   55: =head1 SEE ALSO
   56: 
   57: L<ssl(3)|ssl(3)>
   58: 
   59: =cut