diff options
author | Lutz Jänicke <jaenicke@openssl.org> | 2001-08-23 17:22:43 +0000 |
---|---|---|
committer | Lutz Jänicke <jaenicke@openssl.org> | 2001-08-23 17:22:43 +0000 |
commit | 11c8f0b79d91bf7faba0a688ad3a76b01f157888 (patch) | |
tree | 3138e198d5c2fcf46e7325bfdcd9cabe80d4cac9 /doc/ssl/SSL_rstate_string.pod | |
parent | c4068186acec0f5cd370f7b5772b41f215903234 (diff) |
More manual pages. Constify.
Diffstat (limited to 'doc/ssl/SSL_rstate_string.pod')
-rw-r--r-- | doc/ssl/SSL_rstate_string.pod | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/doc/ssl/SSL_rstate_string.pod b/doc/ssl/SSL_rstate_string.pod new file mode 100644 index 0000000000..bdb8a1fcd5 --- /dev/null +++ b/doc/ssl/SSL_rstate_string.pod @@ -0,0 +1,59 @@ +=pod + +=head1 NAME + +SSL_rstate_string, SSL_rstate_string_long - get textual description of state of an SSL object during read operation + +=head1 SYNOPSIS + + #include <openssl/ssl.h> + + const char *SSL_rstate_string(SSL *ssl); + const char *SSL_rstate_string_long(SSL *ssl); + +=head1 DESCRIPTION + +SSL_rstate_string() returns a 2 letter string indicating the current read state +of the SSL object B<ssl>. + +SSL_rstate_string_long() returns a string indicating the current read state of +the SSL object B<ssl>. + +=head1 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. + +=head1 RETURN VALUES + +SSL_rstate_string() and SSL_rstate_string_long() can return the following +values: + +=over 4 + +=item "RH"/"read header" + +The header of the record is being evaluated. + +=item "RB"/"read body" + +The body of the record is being evaluated. + +=item "RD"/"read done" + +The record has been completely processed. + +=item "unknown"/"unknown" + +The read state is unknown. This should never happen. + +=back + +=head1 SEE ALSO + +L<ssl(3)|ssl(3)> + +=cut |