doc/ssl/SSL_CTX_sess_set_cache_size.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CTX_sess_set_cache_size, SSL_CTX_sess_get_cache_size - manipulate session cache size
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  long SSL_CTX_sess_set_cache_size(SSL_CTX *ctx, long t);
  12  long SSL_CTX_sess_get_cache_size(SSL_CTX *ctx);
  13
  14 =head1 DESCRIPTION
  15
  16 SSL_CTX_sess_set_cache_size() sets the size of the internal session cache
  17 of context B<ctx> to B<t>.
  18
  19 SSL_CTX_sess_get_cache_size() returns the currently valid session cache size.
  20
  21 =head1 NOTES
  22
  23 The internal session cache size is SSL_SESSION_CACHE_MAX_SIZE_DEFAULT,
  24 currently 1024*20, so that up to 20000 sessions can be held. This size
  25 can be modified using the SSL_CTX_sess_set_cache_size() call. A special
  26 case is the size 0, which is used for unlimited size.
  27
  28 When the maximum number of sessions is reached, no more new sessions are
  29 added to the cache. New space may be added by calling
  30 L<SSL_CTX_flush_sessions(3)|SSL_CTX_flush_sessions(3)> to remove
  31 expired sessions.
  32
  33 If the size of the session cache is reduced and more sessions are already
  34 in the session cache, old session will be removed at the next time a
  35 session shall be added. This removal is not synchronized with the
  36 expiration of sessions.
  37
  38 =head1 RETURN VALUES
  39
  40 SSL_CTX_sess_set_cache_size() returns the previously valid size.
  41
  42 SSL_CTX_sess_get_cache_size() returns the currently valid size.
  43
  44 =head1 SEE ALSO
  45
  46 L<ssl(3)|ssl(3)>,
  47 L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>,
  48 L<SSL_CTX_sess_number(3)|SSL_CTX_sess_number(3)>,
  49 L<SSL_CTX_flush_sessions(3)|SSL_CTX_flush_sessions(3)>
  50
  51 =cut