lib/libpthread/pthread_attr_setcreatesuspend_np.3

   1 .\" $NetBSD: pthread_attr_setcreatesuspend_np.3,v 1.2 2003/11/12 11:58:34 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2003 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Christos Zoulas.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd November 12, 2003
  31 .Dt PTHREAD_ATTR_SETCREATESUSPEND_NP 3
  32 .Os
  33 .Sh NAME
  34 .Nm pthread_attr_setcreatesuspend_np
  35 .Nd set attribute to create a thread suspended
  36 .Sh LIBRARY
  37 .Lb libpthread
  38 .Sh SYNOPSIS
  39 .In pthread.h
  40 .Ft int
  41 .Fn pthread_attr_setcreatesuspend_np "pthread_attr_t attr"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn pthread_attr_setcreatesuspend_np
  45 function sets the
  46 .Ar attr
  47 argument, so that if this
  48 .Ar attr
  49 is used in a
  50 .Xr pthread_create 3
  51 call, then the thread created will not run, but it will remain blocked
  52 in the suspended queue, until
  53 .Xr pthread_resume_np 3
  54 is called on it.
  55 .Sh RETURN VALUES
  56 The
  57 .Fn pthread_attr_setcreatesuspend_np
  58 function always returns 0.
  59 .Sh ERRORS
  60 .Fn pthread_attr_setcreatesuspend_np
  61 never fails.
  62 .Sh SEE ALSO
  63 .Xr pthread_create 3 ,
  64 .Xr pthread_resume_np 3 ,
  65 .Xr pthread_suspend_np 3