xref: /freebsd/share/man/man3/pthread_kill.3 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1.\" Copyright (C) 2000 Jason Evans <jasone@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(s), this list of conditions and the following disclaimer as
9.\"    the first lines of this file unmodified other than the possible
10.\"    addition of one or more copyright notices.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice(s), this list of conditions and the following disclaimer in
13.\"    the documentation and/or other materials provided with the
14.\"    distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
17.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
20.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
26.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27.Dd April 27, 2000
28.Dt PTHREAD_KILL 3
29.Os
30.Sh NAME
31.Nm pthread_kill
32.Nd send a signal to a specified thread
33.Sh LIBRARY
34.Lb libpthread
35.Sh SYNOPSIS
36.In pthread.h
37.In signal.h
38.Ft int
39.Fn pthread_kill "pthread_t thread" "int sig"
40.Sh DESCRIPTION
41The
42.Fn pthread_kill
43function sends a signal, specified by
44.Fa sig ,
45to a thread, specified by
46.Fa thread .
47If
48.Fa sig
49is 0, error checking is performed, but no signal is actually sent.
50.Sh RETURN VALUES
51If successful,
52.Fn pthread_kill
53returns 0.
54Otherwise, an error number is returned.
55.Sh ERRORS
56The
57.Fn pthread_kill
58function will fail if:
59.Bl -tag -width Er
60.It Bq Er ESRCH
61.Fa thread
62is an invalid thread ID.
63.It Bq Er EINVAL
64.Fa sig
65is an invalid or unsupported signal number.
66.El
67.Sh SEE ALSO
68.Xr kill 2 ,
69.Xr pthread_self 3 ,
70.Xr raise 3
71.Sh STANDARDS
72The
73.Fn pthread_kill
74function conforms to
75.St -p1003.1-96
76