doc/man3/SSL_CTX_sessions.pod

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