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 .Sh SYNOPSIS
  37 .In pthread_np.h
  38 .Ft int
  39 .Fn pthread_multi_np void
  40 .Ft int
  41 .Fn pthread_single_np void
  42 .Sh DESCRIPTION
  43 The
  44 .Fn pthread_single_np
  45 function switches the process to a single-threaded mode, i.e.,
  46 suspends all threads except the current.
  47 The semantics of this function is similar to
  48 .Xr pthread_suspend_all_np 3 .
  49 .Pp
  50 The
  51 .Fn pthread_multi_np
  52 function switches the process to a multi-threaded mode.
  53 The semantics of this function is similar to
  54 .Xr pthread_resume_all_np 3 .
  55 .Sh RETURN VALUES
  56 The
  57 .Fn pthread_multi_np
  58 and
  59 .Nm pthread_single_np
  60 functions always return 0.
  61 .Sh SEE ALSO
  62 .Xr pthread_resume_all_np 3 ,
  63 .Xr pthread_suspend_all_np 3
  64 .Sh AUTHORS
  65 This manual page was written by
  66 .An Alexey Zelkin Aq phantom@FreeBSD.org .