lib/libcrypto/man/ERR_remove_state.3

   1 .\"     $OpenBSD: ERR_remove_state.3,v 1.3 2016/11/23 17:59:29 schwarze Exp $
   2 .\"     OpenSSL 9b86974e Aug 17 15:21:33 2015 -0400
   3 .\"
   4 .\" This file was written by Ulf Moeller <ulf@openssl.org> and
   5 .\" Matt Caswell <matt@openssl.org>.
   6 .\" Copyright (c) 2000, 2013 The OpenSSL Project.  All rights reserved.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\"
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\"
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in
  17 .\"    the documentation and/or other materials provided with the
  18 .\"    distribution.
  19 .\"
  20 .\" 3. All advertising materials mentioning features or use of this
  21 .\"    software must display the following acknowledgment:
  22 .\"    "This product includes software developed by the OpenSSL Project
  23 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  24 .\"
  25 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26 .\"    endorse or promote products derived from this software without
  27 .\"    prior written permission. For written permission, please contact
  28 .\"    openssl-core@openssl.org.
  29 .\"
  30 .\" 5. Products derived from this software may not be called "OpenSSL"
  31 .\"    nor may "OpenSSL" appear in their names without prior written
  32 .\"    permission of the OpenSSL Project.
  33 .\"
  34 .\" 6. Redistributions of any form whatsoever must retain the following
  35 .\"    acknowledgment:
  36 .\"    "This product includes software developed by the OpenSSL Project
  37 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  38 .\"
  39 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  51 .\"
  52 .Dd $Mdocdate: November 23 2016 $
  53 .Dt ERR_REMOVE_STATE 3
  54 .Os
  55 .Sh NAME
  56 .Nm ERR_remove_thread_state ,
  57 .Nm ERR_remove_state
  58 .Nd free a thread's OpenSSL error queue
  59 .Sh SYNOPSIS
  60 .In openssl/err.h
  61 .Ft void
  62 .Fo ERR_remove_thread_state
  63 .Fa "const CRYPTO_THREADID *tid"
  64 .Fc
  65 .Pp
  66 Deprecated:
  67 .Pp
  68 .Ft void
  69 .Fo ERR_remove_state
  70 .Fa "unsigned long pid"
  71 .Fc
  72 .Sh DESCRIPTION
  73 .Fn ERR_remove_thread_state
  74 frees the error queue associated with thread
  75 .Fa tid .
  76 If
  77 .Fa tid
  78 is
  79 .Dv NULL ,
  80 the current thread will have its error queue removed.
  81 .Pp
  82 Since error queue data structures are allocated automatically for new
  83 threads, they must be freed when threads are terminated in order to
  84 avoid memory leaks.
  85 .Pp
  86 .Fn ERR_remove_state
  87 is deprecated and has been replaced by
  88 .Fn ERR_remove_thread_state .
  89 Since threads in OpenSSL are no longer identified by unsigned long
  90 values, any argument to this function is ignored.
  91 Calling
  92 .Fn ERR_remove_state
  93 is equivalent to
  94 .Fn ERR_remove_thread_state NULL .
  95 .Sh RETURN VALUES
  96 .Fn ERR_remove_thread_state
  97 and
  98 .Fn ERR_remove_state
  99 return no value.
 100 .Sh SEE ALSO
 101 .Xr ERR 3
 102 .Sh HISTORY
 103 .Fn ERR_remove_state
 104 is available in all versions of SSLeay and OpenSSL.
 105 It was deprecated in OpenSSL 1.0.0 when
 106 .Fn ERR_remove_thread_state
 107 was introduced and thread IDs were introduced to identify threads
 108 instead of
 109 .Vt unsigned long .