xref: /freebsd/share/man/man3/pthread_cond_destroy.3 (revision 12afe06c06846b49eab319388a689123dd7860a4)
11fbdc08dSPoul-Henning Kamp.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
21fbdc08dSPoul-Henning Kamp.\" All rights reserved.
31fbdc08dSPoul-Henning Kamp.\"
41fbdc08dSPoul-Henning Kamp.\" Redistribution and use in source and binary forms, with or without
51fbdc08dSPoul-Henning Kamp.\" modification, are permitted provided that the following conditions
61fbdc08dSPoul-Henning Kamp.\" are met:
71fbdc08dSPoul-Henning Kamp.\" 1. Redistributions of source code must retain the above copyright
81fbdc08dSPoul-Henning Kamp.\"    notice, this list of conditions and the following disclaimer.
91fbdc08dSPoul-Henning Kamp.\" 2. Redistributions in binary form must reproduce the above copyright
101fbdc08dSPoul-Henning Kamp.\"    notice, this list of conditions and the following disclaimer in the
111fbdc08dSPoul-Henning Kamp.\"    documentation and/or other materials provided with the distribution.
121fbdc08dSPoul-Henning Kamp.\" 3. Neither the name of the author nor the names of any co-contributors
131fbdc08dSPoul-Henning Kamp.\"    may be used to endorse or promote products derived from this software
141fbdc08dSPoul-Henning Kamp.\"    without specific prior written permission.
151fbdc08dSPoul-Henning Kamp.\"
161fbdc08dSPoul-Henning Kamp.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
171fbdc08dSPoul-Henning Kamp.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
181fbdc08dSPoul-Henning Kamp.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
191fbdc08dSPoul-Henning Kamp.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
201fbdc08dSPoul-Henning Kamp.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
211fbdc08dSPoul-Henning Kamp.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
221fbdc08dSPoul-Henning Kamp.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
231fbdc08dSPoul-Henning Kamp.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
241fbdc08dSPoul-Henning Kamp.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
251fbdc08dSPoul-Henning Kamp.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
261fbdc08dSPoul-Henning Kamp.\" SUCH DAMAGE.
271fbdc08dSPoul-Henning Kamp.\"
287f3dea24SPeter Wemm.\" $FreeBSD$
29fbc400a6SNik Clayton.\"
301fbdc08dSPoul-Henning Kamp.Dd July 28, 1998
311fbdc08dSPoul-Henning Kamp.Dt PTHREAD_COND_DESTROY 3
32a307d598SRuslan Ermilov.Os
331fbdc08dSPoul-Henning Kamp.Sh NAME
341fbdc08dSPoul-Henning Kamp.Nm pthread_cond_destroy
351fbdc08dSPoul-Henning Kamp.Nd destroy a condition variable
36d8a78688SAlexey Zelkin.Sh LIBRARY
37ec7452f1SRuslan Ermilov.Lb libpthread
381fbdc08dSPoul-Henning Kamp.Sh SYNOPSIS
3932eef9aeSRuslan Ermilov.In pthread.h
401fbdc08dSPoul-Henning Kamp.Ft int
411fbdc08dSPoul-Henning Kamp.Fn pthread_cond_destroy "pthread_cond_t *cond"
421fbdc08dSPoul-Henning Kamp.Sh DESCRIPTION
431fbdc08dSPoul-Henning KampThe
441fbdc08dSPoul-Henning Kamp.Fn pthread_cond_destroy
451fbdc08dSPoul-Henning Kampfunction frees the resources allocated by the condition variable
461fbdc08dSPoul-Henning Kamp.Fa cond .
47*12afe06cSJoel Dahl.Sh IMPLEMENTATION NOTES
48*12afe06cSJoel DahlA condition variable can be destroyed immediately after all the threads that
49*12afe06cSJoel Dahlare blocked on it are awakened.
501fbdc08dSPoul-Henning Kamp.Sh RETURN VALUES
511fbdc08dSPoul-Henning KampIf successful, the
52ded8c91aSAlexey Zelkin.Fn pthread_cond_destroy
531fbdc08dSPoul-Henning Kampfunction will return zero, otherwise an error number will be returned
541fbdc08dSPoul-Henning Kampto indicate the error.
551fbdc08dSPoul-Henning Kamp.Sh ERRORS
566f673fd1SPhilippe CharnierThe
571fbdc08dSPoul-Henning Kamp.Fn pthread_cond_destroy
586f673fd1SPhilippe Charnierfunction will fail if:
591fbdc08dSPoul-Henning Kamp.Bl -tag -width Er
601fbdc08dSPoul-Henning Kamp.It Bq Er EINVAL
611fbdc08dSPoul-Henning KampThe value specified by
621fbdc08dSPoul-Henning Kamp.Fa cond
631fbdc08dSPoul-Henning Kampis invalid.
641fbdc08dSPoul-Henning Kamp.It Bq Er EBUSY
651fbdc08dSPoul-Henning KampThe variable
661fbdc08dSPoul-Henning Kamp.Fa cond
671fbdc08dSPoul-Henning Kampis locked by another thread.
681fbdc08dSPoul-Henning Kamp.El
691fbdc08dSPoul-Henning Kamp.Sh SEE ALSO
70acd80190SWolfram Schneider.Xr pthread_cond_broadcast 3 ,
711fbdc08dSPoul-Henning Kamp.Xr pthread_cond_init 3 ,
721fbdc08dSPoul-Henning Kamp.Xr pthread_cond_signal 3 ,
73acd80190SWolfram Schneider.Xr pthread_cond_timedwait 3 ,
74acd80190SWolfram Schneider.Xr pthread_cond_wait 3
751fbdc08dSPoul-Henning Kamp.Sh STANDARDS
766f673fd1SPhilippe CharnierThe
771fbdc08dSPoul-Henning Kamp.Fn pthread_cond_destroy
786f673fd1SPhilippe Charnierfunction conforms to
79096841ecSRuslan Ermilov.St -p1003.1-96 .
80