1.\"	$OpenBSD: pthread_barrierattr_getpshared.3,v 1.4 2020/04/06 00:01:08 pirofti Exp $
2.\"
3.\" Copyright (c) 2012 Paul Irofti <paul@irofti.net>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.\"
18.Dd $Mdocdate: April 6 2020 $
19.Dt PTHREAD_BARRIERATTR_GETPSHARED 3
20.Os
21.Sh NAME
22.Nm pthread_barrierattr_getpshared ,
23.Nm pthread_barrierattr_setpshared
24.Nd get and set the process-shared attribute of the barrier attribute's object
25.Sh SYNOPSIS
26.In pthread.h
27.Ft int
28.Fn pthread_barrierattr_getpshared "pthread_barrierattr_t *attr" "int *pshared"
29.Ft int
30.Fn pthread_barrierattr_setpshared "pthread_barrierattr_t *attr" "int pshared"
31.Sh DESCRIPTION
32The
33.Fn pthread_barrierattr_getpshared
34function writes in
35.Fa pshared
36the current process-shared attribute value.
37.Pp
38The
39.Fn pthread_barrierattr_setpshared
40function sets the process-shared attribute as indicated in
41.Fa pshared .
42.Sh RETURN VALUES
43If successful,
44.Fn pthread_barrierattr_getpshared
45and
46.Fn pthread_barrierattr_setpshared
47will return zero, otherwise an error number will be returned to
48indicate the error.
49.Sh ERRORS
50.Fn pthread_barrierattr_getpshared
51will fail if:
52.Bl -tag -width Er
53.It Bq Er EINVAL
54The value specified by
55.Fa attr
56is invalid.
57.El
58.Pp
59.Fn pthread_barrierattr_setpshared
60will fail if:
61.Bl -tag -width Er
62.It Bq Er EINVAL
63The value specified by
64.Fa attr
65is invalid.
66.It Bq Er ENOTSUP
67The value specified by
68.Fa pshared
69is not PTHREAD_PROCESS_PRIVATE.
70.El
71.Sh SEE ALSO
72.Xr pthread_barrier_init 3 ,
73.Xr pthread_barrier_wait 3 ,
74.Xr pthread_barrierattr_init 3
75.Sh STANDARDS
76.Fn pthread_barrierattr_getpshared
77and
78.Fn pthread_barrierattr_setpshared
79conform to
80.St -p1003.1-2008 .
81.Sh BUGS
82Currently only private barriers are supported and the pshared attribute is
83always set that way.
84Any attempts to change that value will trigger
85.Er ENOTSUP .
86