lib/libpthread/pthread_attr_setcreatesuspend_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_attr_setcreatesuspend_np.3,v 1.7 2007/10/22 10:08:00 ru Exp $
  26 .\" $DragonFly: src/lib/libc_r/man/pthread_attr_setcreatesuspend_np.3,v 1.2 2003/06/17 04:26:47 dillon Exp $
  27 .\"
  28 .Dd July 10, 2009
  29 .Dt PTHREAD_ATTR_SETCREATESUSPEND_NP 3
  30 .Os
  31 .Sh NAME
  32 .Nm pthread_attr_setcreatesuspend_np
  33 .Nd prepare attribute for creation of suspended 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_attr_setcreatesuspend_np "pthread_attr_t *attr"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn pthread_attr_setcreatesuspend_np
  44 instructs
  45 .Xr pthread_create 3
  46 that the thread created with the
  47 .Fa attr
  48 attribute
  49 should be created and left in a suspended state until explicitly resumed
  50 by the call to
  51 .Fn pthread_resume_np
  52 or
  53 .Fn pthread_resume_all_np .
  54 .Sh RETURN VALUES
  55 .Rv -std pthread_attr_setcreatesuspend_np
  56 .Sh ERRORS
  57 The
  58 .Fn pthread_attr_setcreatesuspend_np
  59 function will fail if:
  60 .Bl -tag -width Er
  61 .It Bq Er EINVAL
  62 The value specified by
  63 .Fa attr
  64 is invalid.
  65 .El
  66 .Sh SEE ALSO
  67 .Xr pthread_attr_destroy 3 ,
  68 .Xr pthread_attr_init 3 ,
  69 .Xr pthread_create 3 ,
  70 .Xr pthread_resume_all_np 3 ,
  71 .Xr pthread_resume_np 3
  72 .Sh AUTHORS
  73 This manual page was written by
  74 .An Alexey Zelkin Aq phantom@FreeBSD.org .