2
0

SSL_CTX_sess_number.pod 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. =pod
  2. =head1 NAME
  3. SSL_CTX_sess_number, SSL_CTX_sess_connect, SSL_CTX_sess_connect_good, SSL_CTX_sess_connect_renegotiate, SSL_CTX_sess_accept, SSL_CTX_sess_accept_good, SSL_CTX_sess_accept_renegotiate, SSL_CTX_sess_hits, SSL_CTX_sess_cb_hits, SSL_CTX_sess_misses, SSL_CTX_sess_timeouts, SSL_CTX_sess_cache_full - obtain session cache statistics
  4. =head1 SYNOPSIS
  5. #include <openssl/ssl.h>
  6. long SSL_CTX_sess_number(SSL_CTX *ctx);
  7. long SSL_CTX_sess_connect(SSL_CTX *ctx);
  8. long SSL_CTX_sess_connect_good(SSL_CTX *ctx);
  9. long SSL_CTX_sess_connect_renegotiate(SSL_CTX *ctx);
  10. long SSL_CTX_sess_accept(SSL_CTX *ctx);
  11. long SSL_CTX_sess_accept_good(SSL_CTX *ctx);
  12. long SSL_CTX_sess_accept_renegotiate(SSL_CTX *ctx);
  13. long SSL_CTX_sess_hits(SSL_CTX *ctx);
  14. long SSL_CTX_sess_cb_hits(SSL_CTX *ctx);
  15. long SSL_CTX_sess_misses(SSL_CTX *ctx);
  16. long SSL_CTX_sess_timeouts(SSL_CTX *ctx);
  17. long SSL_CTX_sess_cache_full(SSL_CTX *ctx);
  18. =head1 DESCRIPTION
  19. SSL_CTX_sess_number() returns the current number of sessions in the internal
  20. session cache.
  21. SSL_CTX_sess_connect() returns the number of started SSL/TLS handshakes in
  22. client mode.
  23. SSL_CTX_sess_connect_good() returns the number of successfully established
  24. SSL/TLS sessions in client mode.
  25. SSL_CTX_sess_connect_renegotiate() returns the number of started renegotiations
  26. in client mode.
  27. SSL_CTX_sess_accept() returns the number of started SSL/TLS handshakes in
  28. server mode.
  29. SSL_CTX_sess_accept_good() returns the number of successfully established
  30. SSL/TLS sessions in server mode.
  31. SSL_CTX_sess_accept_renegotiate() returns the number of started renegotiations
  32. in server mode.
  33. SSL_CTX_sess_hits() returns the number of successfully reused sessions.
  34. In client mode a session set with L<SSL_set_session(3)>
  35. successfully reused is counted as a hit. In server mode a session successfully
  36. retrieved from internal or external cache is counted as a hit.
  37. SSL_CTX_sess_cb_hits() returns the number of successfully retrieved sessions
  38. from the external session cache in server mode.
  39. SSL_CTX_sess_misses() returns the number of sessions proposed by clients
  40. that were not found in the internal session cache in server mode.
  41. SSL_CTX_sess_timeouts() returns the number of sessions proposed by clients
  42. and either found in the internal or external session cache in server mode,
  43. but that were invalid due to timeout. These sessions are not included in
  44. the SSL_CTX_sess_hits() count.
  45. SSL_CTX_sess_cache_full() returns the number of sessions that were removed
  46. because the maximum session cache size was exceeded.
  47. =head1 RETURN VALUES
  48. The functions return the values indicated in the DESCRIPTION section.
  49. =head1 SEE ALSO
  50. L<ssl(7)>, L<SSL_set_session(3)>,
  51. L<SSL_CTX_set_session_cache_mode(3)>
  52. L<SSL_CTX_sess_set_cache_size(3)>
  53. =head1 COPYRIGHT
  54. Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
  55. Licensed under the Apache License 2.0 (the "License"). You may not use
  56. this file except in compliance with the License. You can obtain a copy
  57. in the file LICENSE in the source distribution or at
  58. L<https://www.openssl.org/source/license.html>.
  59. =cut