SSL_get_default_timeout.pod 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. =pod
  2. =head1 NAME
  3. SSL_get_default_timeout - get default session timeout value
  4. =head1 SYNOPSIS
  5. #include <openssl/ssl.h>
  6. long SSL_get_default_timeout(const SSL *ssl);
  7. =head1 DESCRIPTION
  8. SSL_get_default_timeout() returns the default timeout value assigned to
  9. SSL_SESSION objects negotiated for the protocol valid for B<ssl>.
  10. =head1 NOTES
  11. Whenever a new session is negotiated, it is assigned a timeout value,
  12. after which it will not be accepted for session reuse. If the timeout
  13. value was not explicitly set using
  14. L<SSL_CTX_set_timeout(3)|SSL_CTX_set_timeout(3)>, the hardcoded default
  15. timeout for the protocol will be used.
  16. SSL_get_default_timeout() return this hardcoded value, which is 300 seconds
  17. for all currently supported protocols (SSLv2, SSLv3, and TLSv1).
  18. =head1 RETURN VALUES
  19. See description.
  20. =head1 SEE ALSO
  21. L<ssl(3)|ssl(3)>,
  22. L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>,
  23. L<SSL_SESSION_get_time(3)|SSL_SESSION_get_time(3)>,
  24. L<SSL_CTX_flush_sessions(3)|SSL_CTX_flush_sessions(3)>,
  25. L<SSL_get_default_timeout(3)|SSL_get_default_timeout(3)>
  26. =cut