SSL_CTX_sessions.pod 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. =pod
  2. =head1 NAME
  3. SSL_CTX_sessions - access internal session cache
  4. =head1 SYNOPSIS
  5. #include <openssl/ssl.h>
  6. LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
  7. =head1 DESCRIPTION
  8. SSL_CTX_sessions() returns a pointer to the lhash databases containing the
  9. internal session cache for B<ctx>.
  10. =head1 NOTES
  11. The sessions in the internal session cache are kept in an
  12. L<LHASH(3)> type database. It is possible to directly
  13. access this database e.g. for searching. In parallel, the sessions
  14. form a linked list which is maintained separately from the
  15. L<LHASH(3)> operations, so that the database must not be
  16. modified directly but by using the
  17. L<SSL_CTX_add_session(3)> family of functions.
  18. =head1 RETURN VALUES
  19. SSL_CTX_sessions() returns a pointer to the lhash of B<SSL_SESSION>.
  20. =head1 SEE ALSO
  21. L<ssl(7)>, L<LHASH(3)>,
  22. L<SSL_CTX_add_session(3)>,
  23. L<SSL_CTX_set_session_cache_mode(3)>
  24. =head1 COPYRIGHT
  25. Copyright 2001-2021 The OpenSSL Project Authors. All Rights Reserved.
  26. Licensed under the Apache License 2.0 (the "License"). You may not use
  27. this file except in compliance with the License. You can obtain a copy
  28. in the file LICENSE in the source distribution or at
  29. L<https://www.openssl.org/source/license.html>.
  30. =cut