summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2017/man3p/pthread_condattr_destroy.3p
blob: 9c38e85c849ee424910d904671238b7f7928c9c7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
'\" et
.TH PTHREAD_CONDATTR_DESTROY "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
pthread_condattr_destroy,
pthread_condattr_init
\(em destroy and initialize the condition variable attributes object
.SH SYNOPSIS
.LP
.nf
#include <pthread.h>
.P
int pthread_condattr_destroy(pthread_condattr_t *\fIattr\fP);
int pthread_condattr_init(pthread_condattr_t *\fIattr\fP);
.fi
.SH DESCRIPTION
The
\fIpthread_condattr_destroy\fR()
function shall destroy a condition variable attributes object; the
object becomes, in effect, uninitialized. An implementation may cause
\fIpthread_condattr_destroy\fR()
to set the object referenced by
.IR attr
to an invalid value. A destroyed
.IR attr
attributes object can be reinitialized using
\fIpthread_condattr_init\fR();
the results of otherwise referencing the object after it
has been destroyed are undefined.
.P
The
\fIpthread_condattr_init\fR()
function shall initialize a condition variable attributes object
.IR attr
with the default value for all of the attributes defined by the
implementation.
.P
Results are undefined if
\fIpthread_condattr_init\fR()
is called specifying an already initialized
.IR attr
attributes object.
.P
After a condition variable attributes object has been used to
initialize one or more condition variables, any function affecting the
attributes object (including destruction) shall not affect any
previously initialized condition variables.
.P
This volume of POSIX.1\(hy2017 requires two attributes, the
.IR clock
attribute and the
.IR process-shared
attribute.
.P
Additional attributes, their default values, and the names of the
associated functions to get and set those attribute values are
implementation-defined.
.P
The behavior is undefined if the value specified by the
.IR attr
argument to
\fIpthread_condattr_destroy\fR()
does not refer to an initialized condition variable attributes object.
.SH "RETURN VALUE"
If successful, the
\fIpthread_condattr_destroy\fR()
and
\fIpthread_condattr_init\fR()
functions shall return zero; otherwise, an error number shall be
returned to indicate the error.
.SH ERRORS
The
\fIpthread_condattr_init\fR()
function shall fail if:
.TP
.BR ENOMEM
Insufficient memory exists to initialize the condition variable
attributes object.
.P
These functions shall not return an error code of
.BR [EINTR] .
.LP
.IR "The following sections are informative."
.SH EXAMPLES
None.
.SH "APPLICATION USAGE"
None.
.SH RATIONALE
A
.IR process-shared
attribute has been defined for condition variables for the same reason
it has been defined for mutexes.
.P
If an implementation detects that the value specified by the
.IR attr
argument to
\fIpthread_condattr_destroy\fR()
does not refer to an initialized condition variable attributes object,
it is recommended that the function should fail and report an
.BR [EINVAL] 
error.
.P
See also
.IR "\fIpthread_attr_destroy\fR\^(\|)"
and
.IR "\fIpthread_mutex_destroy\fR\^(\|)".
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.ad l
.IR "\fIpthread_attr_destroy\fR\^(\|)",
.IR "\fIpthread_cond_destroy\fR\^(\|)",
.IR "\fIpthread_condattr_getpshared\fR\^(\|)",
.IR "\fIpthread_create\fR\^(\|)",
.IR "\fIpthread_mutex_destroy\fR\^(\|)"
.ad b
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "\fB<pthread.h>\fP"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .