summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/doc/ERR_remove_state.pod
diff options
context:
space:
mode:
authormiod <>2014-07-11 16:18:14 +0000
committermiod <>2014-07-11 16:18:14 +0000
commit42ef36c6813822962aff009ee1ca5eaf04d6c5c7 (patch)
treed06ffa1565a72fd493dbed6024d44e5daa26be91 /src/lib/libcrypto/doc/ERR_remove_state.pod
parent687488572f223f89cf98909e87b4d1a3fbb14bfd (diff)
downloadopenbsd-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.pod21
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
5ERR_remove_state - free a thread's error queue 5ERR_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
13Deprecated:
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
15ERR_remove_state() frees the error queue associated with thread B<pid>. 19ERR_remove_thread_state() frees the error queue associated with thread B<tid>.
16If B<pid> == 0, the current thread will have its error queue removed. 20If B<tid> == B<NULL>, the current thread will have its error queue removed.
17 21
18Since error queue data structures are allocated automatically for new 22Since error queue data structures are allocated automatically for new
19threads, they must be freed when threads are terminated in order to 23threads, they must be freed when threads are terminated in order to
20avoid memory leaks. 24avoid memory leaks.
21 25
26ERR_remove_state is deprecated and has been replaced by
27ERR_remove_thread_state. Since threads in OpenSSL are no longer identified
28by unsigned long values any argument to this function is ignored. Calling
29ERR_remove_state is equivalent to B<ERR_remove_thread_state(NULL)>.
30
22=head1 RETURN VALUE 31=head1 RETURN VALUE
23 32
24ERR_remove_state() returns no value. 33ERR_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
32ERR_remove_state() is available in all versions of SSLeay and OpenSSL. 41ERR_remove_state() is available in all versions of SSLeay and OpenSSL. It
42was deprecated in OpenSSL 1.0.0 when ERR_remove_thread_state was introduced
43and thread IDs were introduced to identify threads instead of 'unsigned long'.
33 44
34=cut 45=cut