share/man/man3/pthread_suspend_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 May 5, 2016
  28 .Dt PTHREAD_SUSPEND_NP 3
  29 .Os
  30 .Sh NAME
  31 .Nm pthread_suspend_np
  32 .Nd suspend a thread
  33 .Sh LIBRARY
  34 .Lb libpthread
  35 .Sh SYNOPSIS
  36 .In pthread_np.h
  37 .Ft int
  38 .Fn pthread_suspend_np "pthread_t tid"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn pthread_suspend_np
  42 function, called on an active thread, causes it to suspend.
  43 .Pp
  44 It is not safe for the caller of the
  45 .Fn pthread_suspend_np
  46 function to use any non-async signal safe functions, except
  47 .Xr pthread_resume_np 3 ,
  48 until suspended thread is resumed, unless measures are taken to ensure
  49 that the thread is suspended at a safe point.
  50 .Sh RETURN VALUES
  51 If successful,
  52 .Fn pthread_suspend_np
  53 function returns 0.
  54 Otherwise, an error number is returned to indicate the error.
  55 .Sh ERRORS
  56 The
  57 .Fn pthread_suspend_np
  58 function will fail if:
  59 .Bl -tag -width Er
  60 .It Bq Er EDEADLK
  61 An attempt was made to suspend the current thread.
  62 .It Bq Er EINVAL
  63 The value specified by the
  64 .Fa tid
  65 argument is invalid.
  66 .It Bq Er ESRCH
  67 No thread could be found corresponding to the thread ID specified by the
  68 .Fa tid
  69 argument.
  70 .El
  71 .Sh SEE ALSO
  72 .Xr pthread_resume_all_np 3 ,
  73 .Xr pthread_resume_np 3 ,
  74 .Xr pthread_suspend_all_np 3
  75 .Sh AUTHORS
  76 This manual page was written by
  77 .An Alexey Zelkin Aq phantom@FreeBSD.org .