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 .\" $FreeBSD: src/share/man/man3/pthread_condattr.3,v 1.15 2007/10/22 10:08:00 ru Exp $
31 .Dt PTHREAD_CONDATTR 3
34 .Nm pthread_condattr_init ,
35 .Nm pthread_condattr_destroy ,
36 .Nm pthread_condattr_getclock ,
37 .Nm pthread_condattr_setclock ,
38 .Nm pthread_condattr_getpshared ,
39 .Nm pthread_condattr_setpshared
40 .Nd condition attribute operations
46 .Fn pthread_condattr_init "pthread_condattr_t *attr"
48 .Fn pthread_condattr_destroy "pthread_condattr_t *attr"
50 .Fn pthread_condattr_getclock "const pthread_condattr_t * restrict attr" "clockid_t * restrict clock_id"
52 .Fn pthread_condattr_setclock "pthread_condattr_t *attr" "clockid_t clock_id"
54 .Fn pthread_condattr_getpshared "const pthread_condattr_t * restrict attr" "int * restrict pshared"
56 .Fn pthread_condattr_setpshared "pthread_condattr_t *attr" "int pshared"
58 Condition attribute objects are used to specify parameters to
59 .Fn pthread_cond_init .
61 implementation of conditions does not support any non-default
62 attributes, so these functions are not very useful, though they are required
67 .Fn pthread_condattr_init
68 function initializes a condition attribute object with the default attributes.
71 .Fn pthread_condattr_destroy
72 function destroys a condition attribute object.
75 .Fn pthread_condattr_getclock
76 function will put the value of the clock attribute from
78 into the memory area pointed to by
81 .Fn pthread_condattr_setclock
82 function will set the clock attribute of
84 to the value specified in
86 The clock attribute affects the interpretation of
89 .Xr pthread_cond_timedwait 3
97 .Fn pthread_condattr_getpshared
98 function will put the value of the process-shared attribute from
100 into the memory area pointed to by
103 .Fn pthread_condattr_setpshared
104 function will set the process-shared attribute of
106 to the value specified in
110 may have the following value:
111 .Bl -tag -width ".Dv PTHREAD_PROCESS_PRIVATE"
112 .It Dv PTHREAD_PROCESS_PRIVATE
113 The condition variable it is attached to may only be accessed by
114 threads in the same process as the one that created the object.
115 .\".It Dv PTHREAD_PROCESS_SHARED
116 .\"The condition variable it is attached to may be accessed by
117 .\"threads in processes other than the one that created the object.
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.
160 .Xr pthread_cond_init 3 ,
161 .Xr pthread_cond_timedwait 3
164 .Fn pthread_condattr_init
166 .Fn pthread_condattr_destroy