git.saurik.com Git - apple/libpthread.git/blob

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 November 4, 2006

31 .Dt PTHREAD_COND_INIT 3

32 .Os

33 .Sh NAME

34 .Nm pthread_cond_init

35 .Nd create a condition variable

36 .Sh SYNOPSIS

37 .In pthread.h

38 .Ft int

39 .Fn pthread_cond_init "pthread_cond_t *cond" "const pthread_condattr_t *attr"

40 .Sh DESCRIPTION

41 The

42 .Fn pthread_cond_init

43 function creates a new condition variable, with attributes specified with

44 .Fa attr .

45 If

46 .Fa attr

47 is NULL the default attributes are used.

48 .Sh RETURN VALUES

49 If successful, the

50 .Fn pthread_cond_init

51 function will return zero and put the new condition variable id into

52 .Fa cond ,

53 otherwise an error number will be returned to indicate the error.

54 .Sh ERRORS

55 The

56 .Fn pthread_cond_init

57 function will fail if:

58 .Bl -tag -width Er

59 .It Bq Er EINVAL

60 The value specified by

61 .Fa attr

62 is invalid.

63 .It Bq Er ENOMEM

64 The process cannot allocate enough memory to create another condition

65 variable.

66 .It Bq Er EAGAIN

67 The system temporarily lacks the resources to create another condition

68 variable.

69 .El

70 .Sh SEE ALSO

71 .Xr pthread_cond_broadcast 3 ,

72 .Xr pthread_cond_destroy 3 ,

73 .Xr pthread_cond_signal 3 ,

74 .Xr pthread_cond_timedwait 3 ,

75 .Xr pthread_cond_wait 3 ,

76 .Xr pthread_condattr 3

77 .Sh STANDARDS

78 The

79 .Fn pthread_cond_init

80 function conforms to

81 .St -p1003.1-96 .