xref: /openbsd-src/lib/libpthread/man/pthread_barrierattr_init.3 (revision 8855e28c066fcedf8b2ce6df476d3f9b3d0ee8f9)
1*8855e28cSpirofti.\"	$OpenBSD: pthread_barrierattr_init.3,v 1.4 2020/04/06 00:01:08 pirofti Exp $
2c9961bb2Spirofti.\"
3*8855e28cSpirofti.\" Copyright (c) 2012 Paul Irofti <paul@irofti.net>
4c9961bb2Spirofti.\"
5c9961bb2Spirofti.\" Permission to use, copy, modify, and distribute this software for any
6c9961bb2Spirofti.\" purpose with or without fee is hereby granted, provided that the above
7c9961bb2Spirofti.\" copyright notice and this permission notice appear in all copies.
8c9961bb2Spirofti.\"
9c9961bb2Spirofti.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10c9961bb2Spirofti.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11c9961bb2Spirofti.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12c9961bb2Spirofti.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13c9961bb2Spirofti.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14c9961bb2Spirofti.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15c9961bb2Spirofti.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16c9961bb2Spirofti.\"
17c9961bb2Spirofti.\"
18*8855e28cSpirofti.Dd $Mdocdate: April 6 2020 $
19c9961bb2Spirofti.Dt PTHREAD_BARRIERATTR_INIT 3
20c9961bb2Spirofti.Os
21c9961bb2Spirofti.Sh NAME
22c9961bb2Spirofti.Nm pthread_barrierattr_init ,
23c9961bb2Spirofti.Nm pthread_barrierattr_destroy
24c9961bb2Spirofti.Nd initialize and destroy a barrier attribute object
25c9961bb2Spirofti.Sh SYNOPSIS
2686f9d4cdStedu.In pthread.h
27c9961bb2Spirofti.Ft int
28c9961bb2Spirofti.Fn pthread_barrierattr_init "pthread_barrierattr_t *attr"
29c9961bb2Spirofti.Ft int
30c9961bb2Spirofti.Fn pthread_barrierattr_destroy "pthread_barrierattr_t *attr"
31c9961bb2Spirofti.Sh DESCRIPTION
32c9961bb2SpiroftiThe
33c9961bb2Spirofti.Fn pthread_barrierattr_init
34c9961bb2Spiroftifunction creates a new barrier attribute object.
35c9961bb2Spirofti.Pp
36c9961bb2SpiroftiThe
37c9961bb2Spirofti.Fn pthread_barrierattr_destroy
38c9961bb2Spiroftifunction frees the resources allocated for
39c9961bb2Spirofti.Fa attr .
40c9961bb2Spirofti.Sh RETURN VALUES
41c9961bb2SpiroftiIf successful,
42c9961bb2Spirofti.Fn pthread_barrierattr_init
43c9961bb2Spiroftiand
44c9961bb2Spirofti.Fn pthread_barrierattr_destroy
456f2b369cSjmcreturn zero;
466f2b369cSjmcotherwise an error number is returned to indicate the error.
47c9961bb2Spirofti.Sh ERRORS
48c9961bb2Spirofti.Fn pthread_barrierattr_init
49c9961bb2Spiroftiwill fail if:
50c9961bb2Spirofti.Bl -tag -width Er
51c9961bb2Spirofti.It Bq Er EINVAL
52c9961bb2SpiroftiThe value specified by
53c9961bb2Spirofti.Fa attr
54c9961bb2Spiroftiis invalid.
55c9961bb2Spirofti.It Bq Er ENOMEM
56c9961bb2SpiroftiThe process cannot allocate enough memory to create another barrier attribute
57c9961bb2Spiroftiobject.
58c9961bb2Spirofti.El
59c9961bb2Spirofti.Pp
60c9961bb2Spirofti.Fn pthread_barrierattr_destroy
61c9961bb2Spiroftiwill fail if:
62c9961bb2Spirofti.Bl -tag -width Er
63c9961bb2Spirofti.It Bq Er EINVAL
64c9961bb2SpiroftiThe value specified by
65c9961bb2Spirofti.Fa attr
66c9961bb2Spiroftiis invalid.
67c9961bb2Spirofti.El
68c9961bb2Spirofti.Sh SEE ALSO
69c9961bb2Spirofti.Xr pthread_barrier_init 3 ,
706f2b369cSjmc.Xr pthread_barrier_wait 3 ,
716f2b369cSjmc.Xr pthread_barrierattr_getpshared 3
72c9961bb2Spirofti.Sh STANDARDS
73c9961bb2Spirofti.Fn pthread_barrierattr_init
74c9961bb2Spiroftiand
75c9961bb2Spirofti.Fn pthread_barrierattr_destroy
76c9961bb2Spirofticonform to
77c9961bb2Spirofti.St -p1003.1-2008 .
78