5 SSL_rstate_string, SSL_rstate_string_long - get textual description of state of an SSL object during read operation
9 #include <openssl/ssl.h>
11 const char *SSL_rstate_string(SSL *ssl);
12 const char *SSL_rstate_string_long(SSL *ssl);
16 SSL_rstate_string() returns a 2 letter string indicating the current read state
17 of the SSL object B<ssl>.
19 SSL_rstate_string_long() returns a string indicating the current read state of
20 the SSL object B<ssl>.
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".
28 This function should only seldom be needed in applications.
32 SSL_rstate_string() and SSL_rstate_string_long() can return the following
37 =item "RH"/"read header"
39 The header of the record is being evaluated.
41 =item "RB"/"read body"
43 The body of the record is being evaluated.
45 =item "RD"/"read done"
47 The record has been completely processed.
49 =item "unknown"/"unknown"
51 The read state is unknown. This should never happen.
61 Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
63 Licensed under the OpenSSL license (the "License"). You may not use
64 this file except in compliance with the License. You can obtain a copy
65 in the file LICENSE in the source distribution or at
66 L<https://www.openssl.org/source/license.html>.