xref: /freebsd/share/man/man3/pthread_cond_broadcast.3 (revision d37eb51047221dc3322b34db1038ff3aa533883f)
1.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
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.\" 3. Neither the name of the author nor the names of any co-contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd July 28, 1998
29.Dt PTHREAD_COND_BROADCAST 3
30.Os
31.Sh NAME
32.Nm pthread_cond_broadcast
33.Nd unblock all threads waiting for a condition variable
34.Sh LIBRARY
35.Lb libpthread
36.Sh SYNOPSIS
37.In pthread.h
38.Ft int
39.Fn pthread_cond_broadcast "pthread_cond_t *cond"
40.Sh DESCRIPTION
41The
42.Fn pthread_cond_broadcast
43function unblocks all threads waiting for the condition variable
44.Fa cond .
45.Sh RETURN VALUES
46If successful, the
47.Fn pthread_cond_broadcast
48function will return zero, otherwise an error number will be returned
49to indicate the error.
50.Sh ERRORS
51The
52.Fn pthread_cond_broadcast
53function will fail if:
54.Bl -tag -width Er
55.It Bq Er EINVAL
56The value specified by
57.Fa cond
58is invalid.
59.El
60.Sh SEE ALSO
61.Xr pthread_cond_destroy 3 ,
62.Xr pthread_cond_init 3 ,
63.Xr pthread_cond_signal 3 ,
64.Xr pthread_cond_timedwait 3 ,
65.Xr pthread_cond_wait 3
66.Sh STANDARDS
67The
68.Fn pthread_cond_broadcast
69function conforms to
70.St -p1003.1-96 .
71