SSL_state_string.pod 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. =pod
  2. =head1 NAME
  3. SSL_state_string, SSL_state_string_long - get textual description of state of an SSL object
  4. =head1 SYNOPSIS
  5. #include <openssl/ssl.h>
  6. const char *SSL_state_string(const SSL *ssl);
  7. const char *SSL_state_string_long(const SSL *ssl);
  8. =head1 DESCRIPTION
  9. SSL_state_string() returns a 6 letter string indicating the current state
  10. of the SSL object B<ssl>.
  11. SSL_state_string_long() returns a string indicating the current state of
  12. the SSL object B<ssl>.
  13. =head1 NOTES
  14. During its use, an SSL objects passes several states. The state is internally
  15. maintained. Querying the state information is not very informative before
  16. or when a connection has been established. It however can be of significant
  17. interest during the handshake.
  18. When using non-blocking sockets, the function call performing the handshake
  19. may return with SSL_ERROR_WANT_READ or SSL_ERROR_WANT_WRITE condition,
  20. so that SSL_state_string[_long]() may be called.
  21. For both blocking or non-blocking sockets, the details state information
  22. can be used within the info_callback function set with the
  23. SSL_set_info_callback() call.
  24. =head1 RETURN VALUES
  25. Detailed description of possible states to be included later.
  26. =head1 SEE ALSO
  27. L<ssl(7)>, L<SSL_CTX_set_info_callback(3)>
  28. =head1 COPYRIGHT
  29. Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
  30. Licensed under the OpenSSL license (the "License"). You may not use
  31. this file except in compliance with the License. You can obtain a copy
  32. in the file LICENSE in the source distribution or at
  33. L<https://www.openssl.org/source/license.html>.
  34. =cut