wbrawner/openssl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
openssl/doc/crypto/ERR_remove_state.pod

45 lines
956 B
Text
Raw Normal View History

Document ERR library.
2000-02-01 01:37:00 +00:00
=pod
=head1 NAME
Restore the ERR_remove_thread_state() API and make it a no-op The ERR_remove_thread_state() API is restored to take a pointer argument, but does nothing more. ERR_remove_state() is also made into a no-op. Both functions are deprecated and users are recommended to use OPENSSL_thread_stop() instead. Documentation is changed to reflect this. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-05-08 15:01:09 +00:00
ERR_remove_thread_state, ERR_remove_state - DEPRECATED
Document ERR library.
2000-02-01 01:37:00 +00:00
=head1 SYNOPSIS
Document updates from wiki. PR#3071 The primary changes made are: - Updates to the "NAME" section of many pages to correctly reflect the functions defined on those pages. This section is automatically parsed by the util/extract-names.pl script, so if it is not correct then running "man" will not correctly locate the right manual pages. - Updates to take account of where functions are now deprecated - Full documentation of the ec sub-library - A number of other typo corrections and other minor tweaks
2013-06-12 22:42:08 +00:00
Deprecated:
Backwards-compatibility subject to OPENSSL_API_COMPAT Provide backwards-compatiblity for functions, macros and include files if OPENSSL_API_COMPAT is either not defined or defined less than the version number of the release in which the feature was deprecated. Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-01-05 04:00:33 +00:00
#if OPENSSL_API_COMPAT < 0x10000000L
Document ERR library.
2000-02-01 01:37:00 +00:00
void ERR_remove_state(unsigned long pid);
Backwards-compatibility subject to OPENSSL_API_COMPAT Provide backwards-compatiblity for functions, macros and include files if OPENSSL_API_COMPAT is either not defined or defined less than the version number of the release in which the feature was deprecated. Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-01-05 04:00:33 +00:00
#endif
Document ERR library.
2000-02-01 01:37:00 +00:00
Restore the ERR_remove_thread_state() API and make it a no-op The ERR_remove_thread_state() API is restored to take a pointer argument, but does nothing more. ERR_remove_state() is also made into a no-op. Both functions are deprecated and users are recommended to use OPENSSL_thread_stop() instead. Documentation is changed to reflect this. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-05-08 15:01:09 +00:00
#if OPENSSL_API_COMPAT < 0x10100000L
void ERR_remove_thread_state(void *);
#endif
Document ERR library.
2000-02-01 01:37:00 +00:00
Restore the ERR_remove_thread_state() API and make it a no-op The ERR_remove_thread_state() API is restored to take a pointer argument, but does nothing more. ERR_remove_state() is also made into a no-op. Both functions are deprecated and users are recommended to use OPENSSL_thread_stop() instead. Documentation is changed to reflect this. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-05-08 15:01:09 +00:00
=head1 DESCRIPTION
Document ERR library.
2000-02-01 01:37:00 +00:00
Restore the ERR_remove_thread_state() API and make it a no-op The ERR_remove_thread_state() API is restored to take a pointer argument, but does nothing more. ERR_remove_state() is also made into a no-op. Both functions are deprecated and users are recommended to use OPENSSL_thread_stop() instead. Documentation is changed to reflect this. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-05-08 15:01:09 +00:00
The functions described here were used to free the error queue
associated with the current or specificed thread.
Document ERR library.
2000-02-01 01:37:00 +00:00
Fix the docs for ERR_remove_thread_state and ERR_remove_state Don't primarly recommend using OPENSSL_thread_stop(), as that's a last resort. Instead, recommend leaving it to automatic mechanisms. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-05-10 11:12:01 +00:00
They are now deprecated and do nothing, as the OpenSSL libraries now
normally do all thread initialisation and deinitialisation
automatically (see L<OPENSSL_init_crypto(3)>).
Document updates from wiki. PR#3071 The primary changes made are: - Updates to the "NAME" section of many pages to correctly reflect the functions defined on those pages. This section is automatically parsed by the util/extract-names.pl script, so if it is not correct then running "man" will not correctly locate the right manual pages. - Updates to take account of where functions are now deprecated - Full documentation of the ec sub-library - A number of other typo corrections and other minor tweaks
2013-06-12 22:42:08 +00:00
Document ERR library.
2000-02-01 01:37:00 +00:00
=head1 RETURN VALUE
Restore the ERR_remove_thread_state() API and make it a no-op The ERR_remove_thread_state() API is restored to take a pointer argument, but does nothing more. ERR_remove_state() is also made into a no-op. Both functions are deprecated and users are recommended to use OPENSSL_thread_stop() instead. Documentation is changed to reflect this. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-05-08 15:01:09 +00:00
The functions described here return no value.
Document ERR library.
2000-02-01 01:37:00 +00:00
=head1 SEE ALSO
Fix the docs for ERR_remove_thread_state and ERR_remove_state Don't primarly recommend using OPENSSL_thread_stop(), as that's a last resort. Instead, recommend leaving it to automatic mechanisms. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-05-10 11:12:01 +00:00
L<err(3)>, L<OPENSSL_init_crypto(3)>
Document ERR library.
2000-02-01 01:37:00 +00:00
=head1 HISTORY
Restore the ERR_remove_thread_state() API and make it a no-op The ERR_remove_thread_state() API is restored to take a pointer argument, but does nothing more. ERR_remove_state() is also made into a no-op. Both functions are deprecated and users are recommended to use OPENSSL_thread_stop() instead. Documentation is changed to reflect this. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-05-08 15:01:09 +00:00
ERR_remove_state() was deprecated in OpenSSL 1.0.0 when
ERR_remove_thread_state() was introduced.
ERR_remove_thread_state() was deprecated in OpenSSL 1.1.0 when the
thread handling functionality was entirely rewritten.
Document ERR library.
2000-02-01 01:37:00 +00:00
=cut
Reference in a new issue Copy permalink