xref: /freebsd/share/man/man3/pthread_attr_setcreatesuspend_np.3 (revision edf8578117e8844e02c0121147f45e4609b30680)
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.Dd October 12, 2021
26.Dt PTHREAD_ATTR_SETCREATESUSPEND_NP 3
27.Os
28.Sh NAME
29.Nm pthread_attr_setcreatesuspend_np
30.Nd prepare attribute for creation of suspended thread
31.Sh LIBRARY
32.Lb libpthread
33.Sh SYNOPSIS
34.In pthread_np.h
35.Ft int
36.Fn pthread_attr_setcreatesuspend_np "pthread_attr_t *attr"
37.Sh DESCRIPTION
38The
39.Fn pthread_attr_setcreatesuspend_np
40instructs
41.Xr pthread_create 3
42that the thread created with the
43.Fa attr
44attribute
45should be created and left in a suspended state until explicitly resumed
46by the call to
47.Fn pthread_resume_np
48or
49.Fn pthread_resume_all_np .
50.Sh RETURN VALUES
51.Rv -std pthread_attr_setcreatesuspend_np
52.Sh ERRORS
53The
54.Fn pthread_attr_setcreatesuspend_np
55function will fail if:
56.Bl -tag -width Er
57.It Bq Er EINVAL
58The value specified by
59.Fa attr
60is invalid.
61.El
62.Sh SEE ALSO
63.Xr pthread_attr_destroy 3 ,
64.Xr pthread_attr_init 3 ,
65.Xr pthread_create 3 ,
66.Xr pthread_np 3 ,
67.Xr pthread_resume_all_np 3 ,
68.Xr pthread_resume_np 3
69.Sh AUTHORS
70This manual page was written by
71.An Alexey Zelkin Aq Mt phantom@FreeBSD.org .
72