108 lines
3.8 KiB
Groff
108 lines
3.8 KiB
Groff
.\" $OpenBSD: ERR_remove_state.3,v 1.7 2020/03/28 22:40:58 schwarze Exp $
|
|
.\" OpenSSL 9b86974e Aug 17 15:21:33 2015 -0400
|
|
.\"
|
|
.\" This file was written by Ulf Moeller <ulf@openssl.org> and
|
|
.\" Matt Caswell <matt@openssl.org>.
|
|
.\" Copyright (c) 2000, 2013 The OpenSSL Project. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\"
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\"
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in
|
|
.\" the documentation and/or other materials provided with the
|
|
.\" distribution.
|
|
.\"
|
|
.\" 3. All advertising materials mentioning features or use of this
|
|
.\" software must display the following acknowledgment:
|
|
.\" "This product includes software developed by the OpenSSL Project
|
|
.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
|
|
.\"
|
|
.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
|
|
.\" endorse or promote products derived from this software without
|
|
.\" prior written permission. For written permission, please contact
|
|
.\" openssl-core@openssl.org.
|
|
.\"
|
|
.\" 5. Products derived from this software may not be called "OpenSSL"
|
|
.\" nor may "OpenSSL" appear in their names without prior written
|
|
.\" permission of the OpenSSL Project.
|
|
.\"
|
|
.\" 6. Redistributions of any form whatsoever must retain the following
|
|
.\" acknowledgment:
|
|
.\" "This product includes software developed by the OpenSSL Project
|
|
.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
|
|
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
|
|
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
|
|
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.Dd $Mdocdate: March 28 2020 $
|
|
.Dt ERR_REMOVE_STATE 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm ERR_remove_thread_state ,
|
|
.Nm ERR_remove_state
|
|
.Nd free a thread's OpenSSL error queue
|
|
.Sh SYNOPSIS
|
|
.In openssl/err.h
|
|
.Ft void
|
|
.Fo ERR_remove_thread_state
|
|
.Fa "const CRYPTO_THREADID *tid"
|
|
.Fc
|
|
.Pp
|
|
Deprecated:
|
|
.Pp
|
|
.Ft void
|
|
.Fo ERR_remove_state
|
|
.Fa "unsigned long pid"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
.Fn ERR_remove_thread_state
|
|
frees the error queue associated with thread
|
|
.Fa tid .
|
|
If
|
|
.Fa tid
|
|
is
|
|
.Dv NULL ,
|
|
the current thread will have its error queue removed.
|
|
.Pp
|
|
Since error queue data structures are allocated automatically for new
|
|
threads, they must be freed when threads are terminated in order to
|
|
avoid memory leaks.
|
|
.Pp
|
|
.Fn ERR_remove_state
|
|
is deprecated and has been replaced by
|
|
.Fn ERR_remove_thread_state .
|
|
Since threads in OpenSSL are no longer identified by unsigned long
|
|
values, any argument to this function is ignored.
|
|
Calling
|
|
.Fn ERR_remove_state
|
|
is equivalent to
|
|
.Fn ERR_remove_thread_state NULL .
|
|
.Sh SEE ALSO
|
|
.Xr ERR 3
|
|
.Sh HISTORY
|
|
.Fn ERR_remove_state
|
|
first appeared in SSLeay 0.6.1 and has been available since
|
|
.Ox 2.4 .
|
|
.Pp
|
|
It was deprecated in OpenSSL 1.0.0 and
|
|
.Ox 4.9
|
|
when
|
|
.Fn ERR_remove_thread_state
|
|
was introduced and thread IDs were introduced to identify threads
|
|
instead of
|
|
.Vt unsigned long .
|