diff options
author | miod <> | 2014-07-11 16:18:14 +0000 |
---|---|---|
committer | miod <> | 2014-07-11 16:18:14 +0000 |
commit | 42ef36c6813822962aff009ee1ca5eaf04d6c5c7 (patch) | |
tree | d06ffa1565a72fd493dbed6024d44e5daa26be91 /src/lib/libcrypto/doc/ERR_remove_state.pod | |
parent | 687488572f223f89cf98909e87b4d1a3fbb14bfd (diff) | |
download | openbsd-42ef36c6813822962aff009ee1ca5eaf04d6c5c7.tar.gz openbsd-42ef36c6813822962aff009ee1ca5eaf04d6c5c7.tar.bz2 openbsd-42ef36c6813822962aff009ee1ca5eaf04d6c5c7.zip |
Huge documentation update for libcrypto and libssl, mostly from Matt Caswell,
Jeff Trawick, Jean-Paul Calderone, Michal Bozon, Jeffrey Walton and Rich Salz,
via OpenSSL trunk (with some parts not applying to us, such as SSLv2 support,
at least partially removed).
Diffstat (limited to 'src/lib/libcrypto/doc/ERR_remove_state.pod')
-rw-r--r-- | src/lib/libcrypto/doc/ERR_remove_state.pod | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/src/lib/libcrypto/doc/ERR_remove_state.pod b/src/lib/libcrypto/doc/ERR_remove_state.pod index 72925fb9f4..a4d38c17fd 100644 --- a/src/lib/libcrypto/doc/ERR_remove_state.pod +++ b/src/lib/libcrypto/doc/ERR_remove_state.pod | |||
@@ -2,26 +2,35 @@ | |||
2 | 2 | ||
3 | =head1 NAME | 3 | =head1 NAME |
4 | 4 | ||
5 | ERR_remove_state - free a thread's error queue | 5 | ERR_remove_thread_state, ERR_remove_state - free a thread's error queue |
6 | 6 | ||
7 | =head1 SYNOPSIS | 7 | =head1 SYNOPSIS |
8 | 8 | ||
9 | #include <openssl/err.h> | 9 | #include <openssl/err.h> |
10 | 10 | ||
11 | void ERR_remove_thread_state(const CRYPTO_THREADID *tid); | ||
12 | |||
13 | Deprecated: | ||
14 | |||
11 | void ERR_remove_state(unsigned long pid); | 15 | void ERR_remove_state(unsigned long pid); |
12 | 16 | ||
13 | =head1 DESCRIPTION | 17 | =head1 DESCRIPTION |
14 | 18 | ||
15 | ERR_remove_state() frees the error queue associated with thread B<pid>. | 19 | ERR_remove_thread_state() frees the error queue associated with thread B<tid>. |
16 | If B<pid> == 0, the current thread will have its error queue removed. | 20 | If B<tid> == B<NULL>, the current thread will have its error queue removed. |
17 | 21 | ||
18 | Since error queue data structures are allocated automatically for new | 22 | Since error queue data structures are allocated automatically for new |
19 | threads, they must be freed when threads are terminated in order to | 23 | threads, they must be freed when threads are terminated in order to |
20 | avoid memory leaks. | 24 | avoid memory leaks. |
21 | 25 | ||
26 | ERR_remove_state is deprecated and has been replaced by | ||
27 | ERR_remove_thread_state. Since threads in OpenSSL are no longer identified | ||
28 | by unsigned long values any argument to this function is ignored. Calling | ||
29 | ERR_remove_state is equivalent to B<ERR_remove_thread_state(NULL)>. | ||
30 | |||
22 | =head1 RETURN VALUE | 31 | =head1 RETURN VALUE |
23 | 32 | ||
24 | ERR_remove_state() returns no value. | 33 | ERR_remove_thread_state and ERR_remove_state() return no value. |
25 | 34 | ||
26 | =head1 SEE ALSO | 35 | =head1 SEE ALSO |
27 | 36 | ||
@@ -29,6 +38,8 @@ L<err(3)|err(3)> | |||
29 | 38 | ||
30 | =head1 HISTORY | 39 | =head1 HISTORY |
31 | 40 | ||
32 | ERR_remove_state() is available in all versions of SSLeay and OpenSSL. | 41 | ERR_remove_state() is available in all versions of SSLeay and OpenSSL. It |
42 | was deprecated in OpenSSL 1.0.0 when ERR_remove_thread_state was introduced | ||
43 | and thread IDs were introduced to identify threads instead of 'unsigned long'. | ||
33 | 44 | ||
34 | =cut | 45 | =cut |