lib/libpthread/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: src/share/man/man3/pthread_multi_np.3,v 1.7 2007/10/22 10:08:00 ru Exp $
  26 .\" $DragonFly: src/lib/libc_r/man/pthread_multi_np.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
  27 .\"
  28 .Dd July 10, 2009
  29 .Dt PTHREAD_MULTI_NP 3
  30 .Os
  31 .Sh NAME
  32 .Nm pthread_multi_np ,
  33 .Nm pthread_single_np
  34 .Nd "switch between multi- and single-threaded scheduling modes"
  35 .Sh LIBRARY
  36 .Lb libpthread
  37 .Sh SYNOPSIS
  38 .In pthread.h
  39 .In pthread_np.h
  40 .Ft int
  41 .Fn pthread_multi_np void
  42 .Ft int
  43 .Fn pthread_single_np void
  44 .Sh DESCRIPTION
  45 The
  46 .Fn pthread_single_np
  47 function switches the process to a single-threaded mode, i.e.,
  48 suspends all threads except the current.
  49 The semantics of this function is similar to
  50 .Xr pthread_suspend_all_np 3 .
  51 .Pp
  52 The
  53 .Fn pthread_multi_np
  54 function switches the process to a multi-threaded mode.
  55 The semantics of this function is similar to
  56 .Xr pthread_resume_all_np 3 .
  57 .Sh RETURN VALUES
  58 The
  59 .Fn pthread_multi_np
  60 and
  61 .Nm pthread_single_np
  62 functions always return 0.
  63 .Sh SEE ALSO
  64 .Xr pthread_resume_all_np 3 ,
  65 .Xr pthread_suspend_all_np 3
  66 .Sh AUTHORS
  67 This manual page was written by
  68 .An Alexey Zelkin Aq phantom@FreeBSD.org .