SSL_rstate_string.pod 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. =pod
  2. =head1 NAME
  3. SSL_rstate_string, SSL_rstate_string_long - get textual description of state of an SSL object during read operation
  4. =head1 SYNOPSIS
  5. #include <openssl/ssl.h>
  6. const char *SSL_rstate_string(SSL *ssl);
  7. const char *SSL_rstate_string_long(SSL *ssl);
  8. =head1 DESCRIPTION
  9. SSL_rstate_string() returns a 2 letter string indicating the current read state
  10. of the SSL object B<ssl>.
  11. SSL_rstate_string_long() returns a string indicating the current read state of
  12. the SSL object B<ssl>.
  13. =head1 NOTES
  14. When performing a read operation, the SSL/TLS engine must parse the record,
  15. consisting of header and body. When working in a blocking environment,
  16. SSL_rstate_string[_long]() should always return "RD"/"read done".
  17. This function should only seldom be needed in applications.
  18. =head1 RETURN VALUES
  19. SSL_rstate_string() and SSL_rstate_string_long() can return the following
  20. values:
  21. =over 4
  22. =item "RH"/"read header"
  23. The header of the record is being evaluated.
  24. =item "RB"/"read body"
  25. The body of the record is being evaluated.
  26. =item "RD"/"read done"
  27. The record has been completely processed.
  28. =item "unknown"/"unknown"
  29. The read state is unknown. This should never happen.
  30. =back
  31. =head1 SEE ALSO
  32. L<ssl(7)>
  33. =head1 COPYRIGHT
  34. Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
  35. Licensed under the Apache License 2.0 (the "License"). You may not use
  36. this file except in compliance with the License. You can obtain a copy
  37. in the file LICENSE in the source distribution or at
  38. L<https://www.openssl.org/source/license.html>.
  39. =cut