share/man/man3/pthread_multi_np.3

   1 .\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd February 13, 2003
  28 .Dt PTHREAD_MULTI_NP 3
  29 .Os
  30 .Sh NAME
  31 .Nm pthread_multi_np ,
  32 .Nm pthread_single_np
  33 .Nd "switch between multi- and single-threaded scheduling modes"
  34 .Sh LIBRARY
  35 .Lb libpthread
  36 .Lb libthr
  37 .Sh SYNOPSIS
  38 .In pthread_np.h
  39 .Ft int
  40 .Fn pthread_multi_np void
  41 .Ft int
  42 .Fn pthread_single_np void
  43 .Sh DESCRIPTION
  44 The
  45 .Fn pthread_single_np
  46 function switches the process to a single-threaded mode, i.e.,
  47 suspends all threads except the current.
  48 The semantics of this function is similar to
  49 .Xr pthread_suspend_all_np 3 .
  50 .Pp
  51 The
  52 .Fn pthread_multi_np
  53 function switches the process to a multi-threaded mode.
  54 The semantics of this function is similar to
  55 .Xr pthread_resume_all_np 3 .
  56 .Sh IMPLEMENTATION NOTES
  57 The
  58 .Fn pthread_single_np
  59 function is only available in
  60 .Lb libpthread .
  61 This function is not implemented in
  62 .Lb libthr .
  63 .Sh RETURN VALUES
  64 The
  65 .Fn pthread_multi_np
  66 and
  67 .Nm pthread_single_np
  68 functions always return 0.
  69 .Sh SEE ALSO
  70 .Xr pthread_resume_all_np 3 ,
  71 .Xr pthread_suspend_all_np 3
  72 .Sh AUTHORS
  73 This manual page was written by
  74 .An Alexey Zelkin Aq phantom@FreeBSD.org .