2
0

SSL_CTX_free.pod 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. =pod
  2. =head1 NAME
  3. SSL_CTX_free - free an allocated SSL_CTX object
  4. =head1 SYNOPSIS
  5. #include <openssl/ssl.h>
  6. void SSL_CTX_free(SSL_CTX *ctx);
  7. =head1 DESCRIPTION
  8. SSL_CTX_free() decrements the reference count of B<ctx>, and removes the
  9. SSL_CTX object pointed to by B<ctx> and frees up the allocated memory if the reference count has reached 0.
  10. It also calls the free()ing procedures for indirectly affected items, if
  11. applicable: the session cache, the list of ciphers, the list of Client CAs,
  12. the certificates and keys.
  13. If B<ctx> is NULL nothing is done.
  14. =head1 WARNINGS
  15. If a session-remove callback is set (SSL_CTX_sess_set_remove_cb()), this
  16. callback will be called for each session being freed from B<ctx>'s
  17. session cache. This implies, that all corresponding sessions from an
  18. external session cache are removed as well. If this is not desired, the user
  19. should explicitly unset the callback by calling
  20. SSL_CTX_sess_set_remove_cb(B<ctx>, NULL) prior to calling SSL_CTX_free().
  21. =head1 RETURN VALUES
  22. SSL_CTX_free() does not provide diagnostic information.
  23. =head1 SEE ALSO
  24. L<SSL_CTX_new(3)>, L<ssl(7)>,
  25. L<SSL_CTX_sess_set_get_cb(3)>
  26. =head1 COPYRIGHT
  27. Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  28. Licensed under the Apache License 2.0 (the "License"). You may not use
  29. this file except in compliance with the License. You can obtain a copy
  30. in the file LICENSE in the source distribution or at
  31. L<https://www.openssl.org/source/license.html>.
  32. =cut