crypto/heimdal/lib/krb5/krb5_is_thread_safe.3

   1 .\" Copyright (c) 2005 Kungliga Tekniska Högskolan
   2 .\" (Royal Institute of Technology, Stockholm, Sweden).
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" 3. Neither the name of the Institute nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $Id$
  33 .\"
  34 .Dd May  5, 2006
  35 .Dt KRB5_IS_THREAD_SAFE 3
  36 .Os HEIMDAL
  37 .Sh NAME
  38 .Nm krb5_is_thread_safe
  39 .Nd "is the Kerberos library compiled with multithread support"
  40 .Sh LIBRARY
  41 Kerberos 5 Library (libkrb5, -lkrb5)
  42 .Sh SYNOPSIS
  43 .In krb5.h
  44 .Ft krb5_boolean
  45 .Fn krb5_is_thread_safe "void"
  46 .Sh DESCRIPTION
  47 .Nm
  48 returns
  49 .Dv TRUE
  50 if the library was compiled with with multithread support.
  51 If the library isn't compiled, the consumer have to use a global lock
  52 to make sure Kerboros functions are not called at the same time by
  53 different threads.
  54 .\" .Sh EXAMPLE
  55 .\" .Sh BUGS
  56 .Sh SEE ALSO
  57 .Xr krb5_create_checksum 3 ,
  58 .Xr krb5_encrypt 3