pthreads/pthread_cond_wait.3

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