d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2f764f809f
freebsd-skq/share/man/man3/pthread_cond_wait.3

87 lines
2.8 KiB
Groff
Raw Normal View History

I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the author nor the names of any co-contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
Add $Id$, to make it simpler for members of the translation teams to track. The $Id$ line is normally at the bottom of the main comment block in the man page, separated from the rest of the manpage by an empty comment, like so; .\" $Id$ .\" If the immediately preceding comment is a @(#) format ID marker than the the $Id$ will line up underneath it with no intervening blank lines. Otherwise, an additional blank line is inserted. Approved by: bde
1999-07-12 20:50:10 +00:00
.\"
- Massage wording to make it easier to understand and fix some grammar. Submitted by: sbahra at gwu dot edu Reviewed by: ru@ Approved by: ceri@ MFC after: 3 days
2006-02-16 09:56:31 +00:00
.Dd February 16, 2006
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Dt PTHREAD_COND_WAIT 3
mdoc(7) police: removed HISTORY info from the .Os call.
2001-07-10 13:41:46 +00:00
.Os
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Sh NAME
.Nm pthread_cond_wait
.Nd wait on a condition variable
Introduce .Lb macro to libc_r manpages.
2000-04-22 15:50:29 +00:00
.Sh LIBRARY
Have a single set of POSIX threads man pages. The LIBRARY section of each manpage lists libraries that have corresponding interfaces implemented. Prodded by: threads Reviewed by: deischen
2004-01-14 21:44:26 +00:00
.Lb libpthread
Document interfaces that are supported by libthr.
2004-01-15 15:59:00 +00:00
.Lb libthr
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In pthread.h
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Ft int
.Fn pthread_cond_wait "pthread_cond_t *cond" "pthread_mutex_t *mutex"
.Sh DESCRIPTION
The
.Fn pthread_cond_wait
function atomically blocks the current thread waiting on the condition
variable specified by
.Fa cond ,
- Massage wording to make it easier to understand and fix some grammar. Submitted by: sbahra at gwu dot edu Reviewed by: ru@ Approved by: ceri@ MFC after: 3 days
2006-02-16 09:56:31 +00:00
and releases the mutex specified by
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Fa mutex .
The waiting thread unblocks only after another thread calls
mdoc(7) police: split punctuation characters + misc fixes.
2001-02-01 16:38:02 +00:00
.Xr pthread_cond_signal 3 ,
or
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Xr pthread_cond_broadcast 3
Fix typo. PR: docs/23936 Submitted by: Garret Rooney <rooneg@rpi.edu>
2001-02-02 03:32:03 +00:00
with the same condition variable, and the current thread reacquires the lock
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
on
.Fa mutex .
.Sh RETURN VALUES
If successful, the
.Fn pthread_cond_wait
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc.
2000-03-02 09:14:21 +00:00
function will return zero.
Otherwise an error number will be returned to
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
indicate the error.
.Sh ERRORS
The .Fn function
2003-02-06 11:10:32 +00:00
The
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Fn pthread_cond_wait
The .Fn function
2003-02-06 11:10:32 +00:00
function will fail if:
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by
.Fa cond
or the value specified by
Fix EINVAL related descriptions.
1999-08-20 07:00:22 +00:00
.Fa mutex
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
is invalid.
.El
.Sh SEE ALSO
Sort cross references.
1998-08-31 16:41:09 +00:00
.Xr pthread_cond_broadcast 3 ,
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Xr pthread_cond_destroy 3 ,
Sort cross references.
1998-08-31 16:41:09 +00:00
.Xr pthread_cond_init 3 ,
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Xr pthread_cond_signal 3 ,
Sort cross references.
1998-08-31 16:41:09 +00:00
.Xr pthread_cond_timedwait 3
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Sh STANDARDS
The .Fn function
2003-02-06 11:10:32 +00:00
The
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Fn pthread_cond_wait
The .Fn function
2003-02-06 11:10:32 +00:00
function conforms to
Use ``.St -p1003.1-96''.
2001-02-26 15:16:43 +00:00
.St -p1003.1-96 .
Reference in New Issue Copy Permalink