xref: /freebsd/share/man/man3/pthread_cond_signal.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
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.\"
281fbdc08dSPoul-Henning Kamp.Dd July 28, 1998
291fbdc08dSPoul-Henning Kamp.Dt PTHREAD_COND_SIGNAL 3
30a307d598SRuslan Ermilov.Os
311fbdc08dSPoul-Henning Kamp.Sh NAME
321fbdc08dSPoul-Henning Kamp.Nm pthread_cond_signal
331fbdc08dSPoul-Henning Kamp.Nd unblock a thread waiting for a condition variable
34d8a78688SAlexey Zelkin.Sh LIBRARY
35ec7452f1SRuslan Ermilov.Lb libpthread
361fbdc08dSPoul-Henning Kamp.Sh SYNOPSIS
3732eef9aeSRuslan Ermilov.In pthread.h
381fbdc08dSPoul-Henning Kamp.Ft int
391fbdc08dSPoul-Henning Kamp.Fn pthread_cond_signal "pthread_cond_t *cond"
401fbdc08dSPoul-Henning Kamp.Sh DESCRIPTION
411fbdc08dSPoul-Henning KampThe
421fbdc08dSPoul-Henning Kamp.Fn pthread_cond_signal
431fbdc08dSPoul-Henning Kampfunction unblocks one thread waiting for the condition variable
441fbdc08dSPoul-Henning Kamp.Fa cond .
451fbdc08dSPoul-Henning Kamp.Sh RETURN VALUES
461fbdc08dSPoul-Henning KampIf successful, the
471fbdc08dSPoul-Henning Kamp.Fn pthread_cond_signal
481fbdc08dSPoul-Henning Kampfunction will return zero, otherwise an error number will be returned
491fbdc08dSPoul-Henning Kampto indicate the error.
501fbdc08dSPoul-Henning Kamp.Sh ERRORS
516f673fd1SPhilippe CharnierThe
521fbdc08dSPoul-Henning Kamp.Fn pthread_cond_signal
536f673fd1SPhilippe Charnierfunction will fail if:
541fbdc08dSPoul-Henning Kamp.Bl -tag -width Er
551fbdc08dSPoul-Henning Kamp.It Bq Er EINVAL
561fbdc08dSPoul-Henning KampThe value specified by
571fbdc08dSPoul-Henning Kamp.Fa cond
581fbdc08dSPoul-Henning Kampis invalid.
591fbdc08dSPoul-Henning Kamp.El
601fbdc08dSPoul-Henning Kamp.Sh SEE ALSO
61acd80190SWolfram Schneider.Xr pthread_cond_broadcast 3 ,
621fbdc08dSPoul-Henning Kamp.Xr pthread_cond_destroy 3 ,
63acd80190SWolfram Schneider.Xr pthread_cond_init 3 ,
641fbdc08dSPoul-Henning Kamp.Xr pthread_cond_timedwait 3 ,
65acd80190SWolfram Schneider.Xr pthread_cond_wait 3
661fbdc08dSPoul-Henning Kamp.Sh STANDARDS
676f673fd1SPhilippe CharnierThe
681fbdc08dSPoul-Henning Kamp.Fn pthread_cond_signal
696f673fd1SPhilippe Charnierfunction conforms to
70096841ecSRuslan Ermilov.St -p1003.1-96 .
71