xref: /freebsd/share/man/man3/pthread_kill.3 (revision 6b3455a7665208c366849f0b2b3bc916fb97516e)
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.\"
28.\" $FreeBSD$
29.Dd April 27, 2000
30.Dt PTHREAD_KILL 3
31.Os
32.Sh NAME
33.Nm pthread_kill
34.Nd send a signal to a specified thread
35.Sh LIBRARY
36.Lb libc_r
37.Lb libpthread
38.Lb libthr
39.Sh SYNOPSIS
40.In pthread.h
41.In signal.h
42.Ft int
43.Fn pthread_kill "pthread_t thread" "int sig"
44.Sh DESCRIPTION
45The
46.Fn pthread_kill
47function sends a signal, specified by
48.Fa sig ,
49to a thread, specified by
50.Fa thread .
51If
52.Fa sig
53is 0, error checking is performed, but no signal is actually sent.
54.Sh RETURN VALUES
55If successful,
56.Fn pthread_kill
57returns 0.
58Otherwise, an error number is returned.
59.Sh ERRORS
60The
61.Fn pthread_kill
62function will fail if:
63.Bl -tag -width Er
64.It Bq Er ESRCH
65.Fa thread
66is an invalid thread ID.
67.It Bq Er EINVAL
68.Fa sig
69is an invalid or unsupported signal number.
70.El
71.Sh SEE ALSO
72.Xr kill 2 ,
73.Xr pthread_self 3 ,
74.Xr raise 3
75.Sh STANDARDS
76The
77.Fn pthread_kill
78function conforms to
79.St -p1003.1-96
80