lib/libpthread/pthread_resume_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_resume_np.3,v 1.6 2007/10/22 10:08:00 ru Exp $
  26 .\"
  27 .Dd July 10, 2009
  28 .Dt PTHREAD_RESUME_NP 3
  29 .Os
  30 .Sh NAME
  31 .Nm pthread_resume_np
  32 .Nd resume suspended thread
  33 .Sh LIBRARY
  34 .Lb libpthread
  35 .Sh SYNOPSIS
  36 .In pthread.h
  37 .In pthread_np.h
  38 .Ft int
  39 .Fn pthread_resume_np "pthread_t tid"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn pthread_resume_np
  43 function, called on a suspended thread, causes it to resume.
  44 If a thread specified by the
  45 .Fa tid
  46 argument is not suspended, no actions will be performed.
  47 .Sh RETURN VALUES
  48 If successful,
  49 .Fn pthread_resume_np
  50 function returns 0.
  51 Otherwise, an error number is returned to indicate the error.
  52 .Sh ERRORS
  53 The
  54 .Fn pthread_resume_np
  55 function will fail if:
  56 .Bl -tag -width Er
  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_attr_setcreatesuspend_np 3 ,
  68 .Xr pthread_resume_all_np 3 ,
  69 .Xr pthread_suspend_all_np 3 ,
  70 .Xr pthread_suspend_np 3
  71 .Sh AUTHORS
  72 This manual page was written by
  73 .An Alexey Zelkin Aq Mt phantom@FreeBSD.org .