SSL_SESSION_get_ex_data.pod 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. =pod
  2. =head1 NAME
  3. SSL_SESSION_set_ex_data,
  4. SSL_SESSION_get_ex_data
  5. - get and set application specific data on a session
  6. =head1 SYNOPSIS
  7. #include <openssl/ssl.h>
  8. int SSL_SESSION_set_ex_data(SSL_SESSION *ss, int idx, void *data);
  9. void *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx);
  10. =head1 DESCRIPTION
  11. SSL_SESSION_set_ex_data() enables an application to store arbitrary application
  12. specific data B<data> in an SSL_SESSION structure B<ss>. The index B<idx> should
  13. be a value previously returned from a call to L<CRYPTO_get_ex_new_index(3)>.
  14. SSL_SESSION_get_ex_data() retrieves application specific data previously stored
  15. in an SSL_SESSION structure B<s>. The B<idx> value should be the same as that
  16. used when originally storing the data.
  17. =head1 RETURN VALUES
  18. SSL_SESSION_set_ex_data() returns 1 for success or 0 for failure.
  19. SSL_SESSION_get_ex_data() returns the previously stored value or NULL on
  20. failure. NULL may also be a valid value.
  21. =head1 SEE ALSO
  22. L<ssl(7)>,
  23. L<CRYPTO_get_ex_new_index(3)>
  24. =head1 COPYRIGHT
  25. Copyright 2017 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