lib/libpthread/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: src/share/man/man3/pthread_switch_add_np.3,v 1.5 2007/10/22 10:08:01 ru Exp $
  26 .\" $DragonFly: src/lib/libc_r/man/pthread_suspend_np.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
  27 .\"
  28 .Dd July 10, 2009
  29 .Dt PTHREAD_SUSPEND_NP 3
  30 .Os
  31 .Sh NAME
  32 .Nm pthread_suspend_np
  33 .Nd suspend a thread
  34 .Sh LIBRARY
  35 .Lb libpthread
  36 .Sh SYNOPSIS
  37 .In pthread.h
  38 .In pthread_np.h
  39 .Ft int
  40 .Fn pthread_suspend_np "pthread_t tid"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn pthread_suspend_np
  44 function, called on an active thread, causes it to suspend.
  45 .Sh RETURN VALUES
  46 If successful,
  47 .Fn pthread_suspend_np
  48 function returns 0.
  49 Otherwise, an error number is returned to indicate the error.
  50 .Sh ERRORS
  51 The
  52 .Fn pthread_suspend_np
  53 function will fail if:
  54 .Bl -tag -width Er
  55 .It Bq Er EDEADLK
  56 An attempt was made to suspend the current thread.
  57 .It Bq Er EINVAL
  58 The value specified by the
  59 .Fa tid
  60 argument is invalid.
  61 .It Bq ESRC
  62 No thread could be found corresponding to the thread ID specified by the
  63 .Fa tid
  64 argument.
  65 .El
  66 .Sh SEE ALSO
  67 .Xr pthread_resume_all_np 3 ,
  68 .Xr pthread_resume_np 3 ,
  69 .Xr pthread_suspend_all_np 3
  70 .Sh AUTHORS
  71 This manual page was written by
  72 .An Alexey Zelkin Aq phantom@FreeBSD.org .