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.
30 .Dt PTHREAD_MUTEXATTR 3
33 .Nm pthread_mutexattr_init ,
34 .Nm pthread_mutexattr_destroy ,
35 .Nm pthread_mutexattr_setprioceiling ,
36 .Nm pthread_mutexattr_getprioceiling ,
37 .Nm pthread_mutexattr_setprotocol ,
38 .Nm pthread_mutexattr_getprotocol ,
39 .Nm pthread_mutexattr_settype ,
40 .Nm pthread_mutexattr_gettype
41 .Nd mutex attribute operations
47 .Fn pthread_mutexattr_init "pthread_mutexattr_t *attr"
49 .Fn pthread_mutexattr_destroy "pthread_mutexattr_t *attr"
51 .Fn pthread_mutexattr_setprioceiling "pthread_mutexattr_t *attr" "int prioceiling"
53 .Fn pthread_mutexattr_getprioceiling "pthread_mutexattr_t *attr" "int *prioceiling"
55 .Fn pthread_mutexattr_setprotocol "pthread_mutexattr_t *attr" "int protocol"
57 .Fn pthread_mutexattr_getprotocol "pthread_mutexattr_t *attr" "int *protocol"
59 .Fn pthread_mutexattr_settype "pthread_mutexattr_t *attr" "int type"
61 .Fn pthread_mutexattr_gettype "pthread_mutexattr_t *attr" "int *type"
63 Mutex attributes are used to specify parameters to
64 .Fn pthread_mutex_init .
65 One attribute object can be used in multiple calls to
66 .Fn pthread_mutex_init ,
67 with or without modifications between calls.
70 .Fn pthread_mutexattr_init
73 with all the default mutex attributes.
76 .Fn pthread_mutexattr_destroy
81 .Fn pthread_mutexattr_set*
82 functions set the attribute that corresponds to each function name.
85 .Fn pthread_mutexattr_get*
86 functions copy the value of the attribute that corresponds to each function name
87 to the location pointed to by the second function parameter.
89 If successful, these functions return 0.
90 Otherwise, an error number is returned to indicate the error.
93 .Fn pthread_mutexattr_init
94 function will fail if:
101 .Fn pthread_mutexattr_destroy
102 function will fail if:
110 .Fn pthread_mutexattr_setprioceiling
111 function will fail if:
121 .Fn pthread_mutexattr_getprioceiling
122 function will fail if:
130 .Fn pthread_mutexattr_setprotocol
131 function will fail if:
141 .Fn pthread_mutexattr_getprotocol
142 function will fail if:
150 .Fn pthread_mutexattr_settype
151 function will fail if:
161 .Fn pthread_mutexattr_gettype
162 function will fail if:
169 .Xr pthread_mutex_init 3
172 .Fn pthread_mutexattr_init
174 .Fn pthread_mutexattr_destroy
179 .Fn pthread_mutexattr_setprioceiling ,
180 .Fn pthread_mutexattr_getprioceiling ,
181 .Fn pthread_mutexattr_setprotocol ,
182 .Fn pthread_mutexattr_getprotocol ,
183 .Fn pthread_mutexattr_settype ,
185 .Fn pthread_mutexattr_gettype