xref: /freebsd/share/man/man3/pthread_resume_np.3 (revision 4b9d6057)
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_RESUME_NP 3
27.Os
28.Sh NAME
29.Nm pthread_resume_np
30.Nd resume suspended thread
31.Sh LIBRARY
32.Lb libpthread
33.Sh SYNOPSIS
34.In pthread_np.h
35.Ft int
36.Fn pthread_resume_np "pthread_t tid"
37.Sh DESCRIPTION
38The
39.Fn pthread_resume_np
40function, called on a suspended thread, causes it to resume.
41If a thread specified by the
42.Fa tid
43argument is not suspended, no actions will be performed.
44.Sh RETURN VALUES
45If successful,
46.Fn pthread_resume_np
47function returns 0.
48Otherwise, an error number is returned to indicate the error.
49.Sh ERRORS
50The
51.Fn pthread_resume_np
52function will fail if:
53.Bl -tag -width Er
54.It Bq Er EINVAL
55The value specified by the
56.Fa tid
57argument is invalid.
58.It Bq Er ESRCH
59No thread could be found corresponding to the thread ID specified by the
60.Fa tid
61argument.
62.El
63.Sh SEE ALSO
64.Xr pthread_attr_setcreatesuspend_np 3 ,
65.Xr pthread_np 3 ,
66.Xr pthread_resume_all_np 3 ,
67.Xr pthread_suspend_all_np 3 ,
68.Xr pthread_suspend_np 3
69.Sh AUTHORS
70This manual page was written by
71.An Alexey Zelkin Aq Mt phantom@FreeBSD.org .
72