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 August 17, 2018 31.Dt PTHREAD_COND_INIT 3 32.Os 33.Sh NAME 34.Nm pthread_cond_init 35.Nd create a condition variable 36.Sh LIBRARY 37.Lb libpthread 38.Sh SYNOPSIS 39.In pthread.h 40.Ft int 41.Fn pthread_cond_init "pthread_cond_t *restrict cond" "const pthread_condattr_t *restrict 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 NULL the default attributes are used. 50.Sh RETURN VALUES 51If successful, the 52.Fn pthread_cond_init 53function will return zero and put the new condition variable id into 54.Fa cond , 55otherwise an error number will be returned to indicate the error. 56.Sh ERRORS 57The 58.Fn pthread_cond_init 59function will fail if: 60.Bl -tag -width Er 61.It Bq Er EINVAL 62The value specified by 63.Fa attr 64is invalid. 65.It Bq Er ENOMEM 66The process cannot allocate enough memory to create another condition 67variable. 68.It Bq Er EAGAIN 69The system temporarily lacks the resources to create another condition 70variable. 71.El 72.Sh SEE ALSO 73.Xr pthread_cond_broadcast 3 , 74.Xr pthread_cond_destroy 3 , 75.Xr pthread_cond_signal 3 , 76.Xr pthread_cond_timedwait 3 , 77.Xr pthread_cond_wait 3 , 78.Xr pthread_condattr 3 79.Sh STANDARDS 80The 81.Fn pthread_cond_init 82function conforms to 83.St -p1003.1-96 . 84