PageRenderTime 24ms CodeModel.GetById 17ms app.highlight 3ms RepoModel.GetById 1ms app.codeStats 0ms

/share/man/man3/pthread_cond_broadcast.3

https://bitbucket.org/freebsd/freebsd-head/
Unknown | 72 lines | 72 code | 0 blank | 0 comment | 0 complexity | 560f509cf5a556aec8fd2c1621961928 MD5 | raw file
 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.\" $FreeBSD$
29.\"
30.Dd July 28, 1998
31.Dt PTHREAD_COND_BROADCAST 3
32.Os
33.Sh NAME
34.Nm pthread_cond_broadcast
35.Nd unblock all threads waiting for a condition variable
36.Sh LIBRARY
37.Lb libpthread
38.Sh SYNOPSIS
39.In pthread.h
40.Ft int
41.Fn pthread_cond_broadcast "pthread_cond_t *cond"
42.Sh DESCRIPTION
43The
44.Fn pthread_cond_broadcast
45function unblocks all threads waiting for the condition variable
46.Fa cond .
47.Sh RETURN VALUES
48If successful, the
49.Fn pthread_cond_broadcast
50function will return zero, otherwise an error number will be returned
51to indicate the error.
52.Sh ERRORS
53The
54.Fn pthread_cond_broadcast
55function will fail if:
56.Bl -tag -width Er
57.It Bq Er EINVAL
58The value specified by
59.Fa cond
60is invalid.
61.El
62.Sh SEE ALSO
63.Xr pthread_cond_destroy 3 ,
64.Xr pthread_cond_init 3 ,
65.Xr pthread_cond_signal 3 ,
66.Xr pthread_cond_timedwait 3 ,
67.Xr pthread_cond_wait 3
68.Sh STANDARDS
69The
70.Fn pthread_cond_broadcast
71function conforms to
72.St -p1003.1-96 .