xref: /freebsd/share/man/man3/pthread_mutexattr_getkind_np.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1318d8cfdSAlexey Zelkin.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
2318d8cfdSAlexey Zelkin.\" All rights reserved.
3318d8cfdSAlexey Zelkin.\"
4318d8cfdSAlexey Zelkin.\" Redistribution and use in source and binary forms, with or without
5318d8cfdSAlexey Zelkin.\" modification, are permitted provided that the following conditions
6318d8cfdSAlexey Zelkin.\" are met:
7318d8cfdSAlexey Zelkin.\" 1. Redistributions of source code must retain the above copyright
8318d8cfdSAlexey Zelkin.\"    notice, this list of conditions and the following disclaimer.
9318d8cfdSAlexey Zelkin.\" 2. Redistributions in binary form must reproduce the above copyright
10318d8cfdSAlexey Zelkin.\"    notice, this list of conditions and the following disclaimer in the
11318d8cfdSAlexey Zelkin.\"    documentation and/or other materials provided with the distribution.
12318d8cfdSAlexey Zelkin.\"
13318d8cfdSAlexey Zelkin.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14318d8cfdSAlexey Zelkin.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15318d8cfdSAlexey Zelkin.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16318d8cfdSAlexey Zelkin.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17318d8cfdSAlexey Zelkin.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18318d8cfdSAlexey Zelkin.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19318d8cfdSAlexey Zelkin.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20318d8cfdSAlexey Zelkin.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21318d8cfdSAlexey Zelkin.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22318d8cfdSAlexey Zelkin.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23318d8cfdSAlexey Zelkin.\" SUCH DAMAGE.
24318d8cfdSAlexey Zelkin.\"
25*df7d7638SFelix Johnson.Dd October 12, 2021
26318d8cfdSAlexey Zelkin.Dt PTHREAD_MUTEXATTR_GETKIND_NP 3
27318d8cfdSAlexey Zelkin.Os
28318d8cfdSAlexey Zelkin.Sh NAME
29318d8cfdSAlexey Zelkin.Nm pthread_mutexattr_getkind_np ,
30318d8cfdSAlexey Zelkin.Nm pthread_mutexattr_setkind_np
31ace5be68SRuslan Ermilov.Nd mutex attribute operations (legacy)
32318d8cfdSAlexey Zelkin.Sh LIBRARY
33ec7452f1SRuslan Ermilov.Lb libpthread
34318d8cfdSAlexey Zelkin.Sh SYNOPSIS
35318d8cfdSAlexey Zelkin.In pthread_np.h
36318d8cfdSAlexey Zelkin.Ft int
37318d8cfdSAlexey Zelkin.Fn pthread_mutexattr_getkind_np "pthread_mutexattr_t attr"
38318d8cfdSAlexey Zelkin.Ft int
39318d8cfdSAlexey Zelkin.Fn pthread_mutexattr_setkind_np "pthread_mutexattr_t *attr" "int kind"
40318d8cfdSAlexey Zelkin.Sh DESCRIPTION
41ace5be68SRuslan Ermilov.Bf -symbolic
42ace5be68SRuslan ErmilovThese functions are deprecated and non-portable implementation of
43ace5be68SRuslan Ermilovthe mutex type manipulation.
44ace5be68SRuslan Ermilov.Ef
45318d8cfdSAlexey Zelkin.Pp
46ace5be68SRuslan ErmilovIt is recommended to use the
47ace5be68SRuslan Ermilov.Xr pthread_mutexattr_gettype 3
48318d8cfdSAlexey Zelkinand
49ace5be68SRuslan Ermilov.Xr pthread_mutexattr_settype 3
50318d8cfdSAlexey Zelkinfunctions instead.
51318d8cfdSAlexey Zelkin.Sh RETURN VALUES
52318d8cfdSAlexey ZelkinThe
53318d8cfdSAlexey Zelkin.Fn pthread_mutexattr_getkind_np
54ace5be68SRuslan Ermilovfunction returns a positive value representing the
55ace5be68SRuslan Ermilov.Dq kind
56ace5be68SRuslan Ermilovof the mutex attribute
57318d8cfdSAlexey Zelkin.Fa attr
58ace5be68SRuslan Ermilovif successful; otherwise the value \-1 is returned and the global variable
59ace5be68SRuslan Ermilov.Va errno
60318d8cfdSAlexey Zelkinis set to indicate the error.
61318d8cfdSAlexey Zelkin.Pp
62ace5be68SRuslan Ermilov.Rv -std pthread_mutexattr_setkind_np
63318d8cfdSAlexey Zelkin.Sh ERRORS
64318d8cfdSAlexey ZelkinThe
65318d8cfdSAlexey Zelkin.Fn pthread_mutexattr_getkind_np
66318d8cfdSAlexey Zelkinand
67318d8cfdSAlexey Zelkin.Fn pthread_mutexattr_setkind_np
68318d8cfdSAlexey Zelkinfunctions will fail if:
69ace5be68SRuslan Ermilov.Bl -tag -width Er
70318d8cfdSAlexey Zelkin.It Bq Er EINVAL
71318d8cfdSAlexey ZelkinThe value specified by
72318d8cfdSAlexey Zelkin.Fa attr
73ace5be68SRuslan Ermilovis invalid.
74318d8cfdSAlexey Zelkin.El
75318d8cfdSAlexey Zelkin.Sh SEE ALSO
763ac17febSRuslan Ermilov.Xr pthread_mutex_destroy 3 ,
77e52a1af2SBaptiste Daroussin.Xr pthread_mutex_init 3 ,
78e52a1af2SBaptiste Daroussin.Xr pthread_mutexattr_gettype 3 ,
79*df7d7638SFelix Johnson.Xr pthread_mutexattr_settype 3 ,
80*df7d7638SFelix Johnson.Xr pthread_np 3
81