xref: /freebsd/share/man/man3/pthread_cond_init.3 (revision a8445737e740901f5f2c8d24c12ef7fc8b00134e)
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_INIT 3
30.Os BSD 4
31.Sh NAME
32.Nm pthread_cond_init
33.Nd create a condition variable
34.Sh SYNOPSIS
35.Fd #include <pthread.h>
36.Ft int
37.Fn pthread_cond_init "pthread_cond_t *cond" "const pthread_condattr_t *attr"
38.Sh DESCRIPTION
39The
40.Fn pthread_cond_init
41function creates a new condition variable, with attributes specified with
42.Fa attr .
43If
44.Fa attr
45is NULL the default attributes are used.
46.Sh RETURN VALUES
47If successful, the
48.Fn pthread_cond_init
49function will return zero and put the new condition variable id into
50.Fa cond ,
51otherwise an error number will be returned to indicate the error.
52.Sh ERRORS
53.Fn pthread_cond_init
54will fail if:
55.Bl -tag -width Er
56.It Bq Er EINVAL
57The value specified by
58.Fa attr
59is invalid.
60.It Bq Er ENOMEM
61The process cannot allocate enough memory to create another condition
62variable.
63.It Bq Er EAGAIN
64The temporarily lacks the resources to create another condition variable.
65.El
66.Pp
67.Sh SEE ALSO
68.Xr pthread_cond_broadcast 3 ,
69.Xr pthread_cond_destroy 3 ,
70.Xr pthread_cond_signal 3 ,
71.Xr pthread_cond_timedwait 3 ,
72.Xr pthread_cond_wait 3
73.Sh STANDARDS
74.Fn pthread_cond_init
75conforms to ISO/IEC 9945-1 ANSI/IEEE
76.Pq Dq Tn POSIX
77Std 1003.1 Second Edition 1996-07-12.
78