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