xref: /freebsd/share/man/man3/pthread_attr_setcreatesuspend_np.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1318d8cfdSAlexey Zelkin.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
2318d8cfdSAlexey Zelkin.\" All rights reserved.
3318d8cfdSAlexey Zelkin.\"
4318d8cfdSAlexey Zelkin.\" Redistribution and use in source and binary forms, with or without
5318d8cfdSAlexey Zelkin.\" modification, are permitted provided that the following conditions
6318d8cfdSAlexey Zelkin.\" are met:
7318d8cfdSAlexey Zelkin.\" 1. Redistributions of source code must retain the above copyright
8318d8cfdSAlexey Zelkin.\"    notice, this list of conditions and the following disclaimer.
9318d8cfdSAlexey Zelkin.\" 2. Redistributions in binary form must reproduce the above copyright
10318d8cfdSAlexey Zelkin.\"    notice, this list of conditions and the following disclaimer in the
11318d8cfdSAlexey Zelkin.\"    documentation and/or other materials provided with the distribution.
12318d8cfdSAlexey Zelkin.\"
13318d8cfdSAlexey Zelkin.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14318d8cfdSAlexey Zelkin.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15318d8cfdSAlexey Zelkin.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16318d8cfdSAlexey Zelkin.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17318d8cfdSAlexey Zelkin.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18318d8cfdSAlexey Zelkin.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19318d8cfdSAlexey Zelkin.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20318d8cfdSAlexey Zelkin.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21318d8cfdSAlexey Zelkin.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22318d8cfdSAlexey Zelkin.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23318d8cfdSAlexey Zelkin.\" SUCH DAMAGE.
24318d8cfdSAlexey Zelkin.\"
25*df7d7638SFelix Johnson.Dd October 12, 2021
26318d8cfdSAlexey Zelkin.Dt PTHREAD_ATTR_SETCREATESUSPEND_NP 3
27318d8cfdSAlexey Zelkin.Os
28318d8cfdSAlexey Zelkin.Sh NAME
29318d8cfdSAlexey Zelkin.Nm pthread_attr_setcreatesuspend_np
303b96c71fSMike Pritchard.Nd prepare attribute for creation of suspended thread
31318d8cfdSAlexey Zelkin.Sh LIBRARY
32ec7452f1SRuslan Ermilov.Lb libpthread
33318d8cfdSAlexey Zelkin.Sh SYNOPSIS
34318d8cfdSAlexey Zelkin.In pthread_np.h
35318d8cfdSAlexey Zelkin.Ft int
36318d8cfdSAlexey Zelkin.Fn pthread_attr_setcreatesuspend_np "pthread_attr_t *attr"
37318d8cfdSAlexey Zelkin.Sh DESCRIPTION
38318d8cfdSAlexey ZelkinThe
39318d8cfdSAlexey Zelkin.Fn pthread_attr_setcreatesuspend_np
40318d8cfdSAlexey Zelkininstructs
41ace5be68SRuslan Ermilov.Xr pthread_create 3
42ace5be68SRuslan Ermilovthat the thread created with the
43318d8cfdSAlexey Zelkin.Fa attr
44ace5be68SRuslan Ermilovattribute
45ace5be68SRuslan Ermilovshould be created and left in a suspended state until explicitly resumed
46ace5be68SRuslan Ermilovby the call to
47318d8cfdSAlexey Zelkin.Fn pthread_resume_np
48318d8cfdSAlexey Zelkinor
49ace5be68SRuslan Ermilov.Fn pthread_resume_all_np .
50318d8cfdSAlexey Zelkin.Sh RETURN VALUES
51318d8cfdSAlexey Zelkin.Rv -std pthread_attr_setcreatesuspend_np
52318d8cfdSAlexey Zelkin.Sh ERRORS
53318d8cfdSAlexey ZelkinThe
54318d8cfdSAlexey Zelkin.Fn pthread_attr_setcreatesuspend_np
55318d8cfdSAlexey Zelkinfunction will fail if:
56ace5be68SRuslan Ermilov.Bl -tag -width Er
57318d8cfdSAlexey Zelkin.It Bq Er EINVAL
58318d8cfdSAlexey ZelkinThe value specified by
59318d8cfdSAlexey Zelkin.Fa attr
60ace5be68SRuslan Ermilovis invalid.
61318d8cfdSAlexey Zelkin.El
62318d8cfdSAlexey Zelkin.Sh SEE ALSO
63318d8cfdSAlexey Zelkin.Xr pthread_attr_destroy 3 ,
64ace5be68SRuslan Ermilov.Xr pthread_attr_init 3 ,
65318d8cfdSAlexey Zelkin.Xr pthread_create 3 ,
66*df7d7638SFelix Johnson.Xr pthread_np 3 ,
67318d8cfdSAlexey Zelkin.Xr pthread_resume_all_np 3 ,
68318d8cfdSAlexey Zelkin.Xr pthread_resume_np 3
69318d8cfdSAlexey Zelkin.Sh AUTHORS
70ace5be68SRuslan ErmilovThis manual page was written by
71a63d6c94SBaptiste Daroussin.An Alexey Zelkin Aq Mt phantom@FreeBSD.org .
72