1.\" $OpenBSD: pthread_cond_init.3,v 1.11 2013/06/05 03:44:50 tedu Exp $
2.\"
3.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the author nor the names of any co-contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\" $FreeBSD: pthread_cond_init.3,v 1.6 1999/08/28 00:03:03 peter Exp $
31.\"
32.Dd $Mdocdate: June 5 2013 $
33.Dt PTHREAD_COND_INIT 3
34.Os
35.Sh NAME
36.Nm pthread_cond_init
37.Nd create a condition variable
38.Sh SYNOPSIS
39.In pthread.h
40.Ft int
41.Fn pthread_cond_init "pthread_cond_t *cond" "const pthread_condattr_t *attr"
42.Sh DESCRIPTION
43The
44.Fn pthread_cond_init
45function creates a new condition variable, with attributes specified with
46.Fa attr .
47If
48.Fa attr
49is
50.Dv NULL
51the default attributes are used.
52.Sh RETURN VALUES
53If successful, the
54.Fn pthread_cond_init
55function will return zero and put the new condition variable ID into
56.Fa cond ,
57otherwise an error number will be returned to indicate the error.
58.Sh ERRORS
59.Fn pthread_cond_init
60will fail if:
61.Bl -tag -width Er
62.It Bq Er EINVAL
63The value specified by
64.Fa attr
65is invalid.
66.It Bq Er ENOMEM
67The process cannot allocate enough memory to create another condition
68variable.
69.It Bq Er EAGAIN
70The system temporarily lacks the resources to create another condition
71variable.
72.El
73.Sh SEE ALSO
74.Xr pthread_cond_broadcast 3 ,
75.Xr pthread_cond_destroy 3 ,
76.Xr pthread_cond_signal 3 ,
77.Xr pthread_cond_timedwait 3 ,
78.Xr pthread_cond_wait 3
79.Sh STANDARDS
80.Fn pthread_cond_init
81conforms to
82.St -p1003.1-96 .
83