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 February 13, 2003
  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 .Sh RETURN VALUES
  44 If successful,
  45 .Fn pthread_suspend_np
  46 function returns 0.
  47 Otherwise, an error number is returned to indicate the error.
  48 .Sh ERRORS
  49 The
  50 .Fn pthread_suspend_np
  51 function will fail if:
  52 .Bl -tag -width Er
  53 .It Bq Er EDEADLK
  54 An attempt was made to suspend the current thread.
  55 .It Bq Er EINVAL
  56 The value specified by the
  57 .Fa tid
  58 argument is invalid.
  59 .It Bq ESRC
  60 No thread could be found corresponding to the thread ID specified by the
  61 .Fa tid
  62 argument.
  63 .El
  64 .Sh SEE ALSO
  65 .Xr pthread_resume_all_np 3 ,
  66 .Xr pthread_resume_np 3 ,
  67 .Xr pthread_suspend_all_np 3
  68 .Sh AUTHORS
  69 This manual page was written by
  70 .An Alexey Zelkin Aq phantom@FreeBSD.org .