xref: /freebsd/share/man/man3/pthread_cond_destroy.3 (revision 02e9120893770924227138ba49df1edb3896112a)
1.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the author nor the names of any co-contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd July 28, 1998
29.Dt PTHREAD_COND_DESTROY 3
30.Os
31.Sh NAME
32.Nm pthread_cond_destroy
33.Nd destroy a condition variable
34.Sh LIBRARY
35.Lb libpthread
36.Sh SYNOPSIS
37.In pthread.h
38.Ft int
39.Fn pthread_cond_destroy "pthread_cond_t *cond"
40.Sh DESCRIPTION
41The
42.Fn pthread_cond_destroy
43function frees the resources allocated by the condition variable
44.Fa cond .
45.Sh IMPLEMENTATION NOTES
46A condition variable can be destroyed immediately after all the threads that
47are blocked on it are awakened.
48.Sh RETURN VALUES
49If successful, the
50.Fn pthread_cond_destroy
51function will return zero, otherwise an error number will be returned
52to indicate the error.
53.Sh ERRORS
54The
55.Fn pthread_cond_destroy
56function will fail if:
57.Bl -tag -width Er
58.It Bq Er EINVAL
59The value specified by
60.Fa cond
61is invalid.
62.It Bq Er EBUSY
63The variable
64.Fa cond
65is locked by another thread.
66.El
67.Sh SEE ALSO
68.Xr pthread_cond_broadcast 3 ,
69.Xr pthread_cond_init 3 ,
70.Xr pthread_cond_signal 3 ,
71.Xr pthread_cond_timedwait 3 ,
72.Xr pthread_cond_wait 3
73.Sh STANDARDS
74The
75.Fn pthread_cond_destroy
76function conforms to
77.St -p1003.1-96 .
78