1 .\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice(s), this list of conditions and the following disclaimer as
9 .\" the first lines of this file unmodified other than the possible
10 .\" addition of one or more copyright notices.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice(s), this list of conditions and the following disclaimer in
13 .\" the documentation and/or other materials provided with the
16 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
17 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
20 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
26 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 .Dt PTHREAD_CONDATTR 3
31 .Nm pthread_condattr_init ,
32 .Nm pthread_condattr_destroy ,
33 .Nm pthread_condattr_getclock ,
34 .Nm pthread_condattr_setclock ,
35 .Nm pthread_condattr_getpshared ,
36 .Nm pthread_condattr_setpshared
37 .Nd condition attribute operations
43 .Fn pthread_condattr_init "pthread_condattr_t *attr"
45 .Fn pthread_condattr_destroy "pthread_condattr_t *attr"
47 .Fo pthread_condattr_getclock
48 .Fa "pthread_condattr_t * restrict attr" "clockid_t * restrict clock_id"
51 .Fn pthread_condattr_setclock "pthread_condattr_t *attr" "clockid_t clock_id"
53 .Fo pthread_condattr_getpshared
54 .Fa "pthread_condattr_t * restrict attr" "int * restrict pshared"
57 .Fn pthread_condattr_setpshared "pthread_condattr_t *attr" "int pshared"
59 Condition attribute objects are used to specify parameters to
60 .Fn pthread_cond_init .
63 .Fn pthread_condattr_init
64 function initializes a condition attribute object with the default attributes.
67 .Fn pthread_condattr_destroy
68 function destroys a condition attribute object.
71 .Fn pthread_condattr_getclock
72 function will put the value of the clock attribute from
74 into the memory area pointed to by
77 .Fn pthread_condattr_setclock
78 function will set the clock attribute of
80 to the value specified in
82 The clock attribute affects the interpretation of
85 .Xr pthread_cond_timedwait 3
93 .Fn pthread_condattr_getpshared
94 function will put the value of the process-shared attribute from
96 into the memory area pointed to by
99 .Fn pthread_condattr_setpshared
100 function will set the process-shared attribute of
102 to the value specified in
106 may have one of the following values:
107 .Bl -tag -width ".Dv PTHREAD_PROCESS_PRIVATE"
108 .It Dv PTHREAD_PROCESS_PRIVATE
109 The condition variable it is attached to may only be accessed by
110 threads in the same process as the one that created the object.
111 .It Dv PTHREAD_PROCESS_SHARED
112 The condition variable it is attached to may be accessed by
113 threads in processes other than the one that created the object.
117 for details of the implementation of shared condition variables,
118 and their limitations.
120 If successful, these functions return 0.
121 Otherwise, an error number is returned to indicate the error.
124 .Fn pthread_condattr_init
125 function will fail if:
132 .Fn pthread_condattr_destroy
133 function will fail if:
141 .Fn pthread_condattr_setclock
142 function will fail if:
145 The value specified in
147 is not one of the allowed values.
151 .Fn pthread_condattr_setpshared
152 function will fail if:
155 The value specified in
157 is not one of the allowed values.
161 .Xr pthread_cond_init 3 ,
162 .Xr pthread_cond_timedwait 3
165 .Fn pthread_condattr_init
167 .Fn pthread_condattr_destroy