share/man/man3/pthread_cond_broadcast.3

   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 .\" $FreeBSD$
  29 .\"
  30 .Dd July 28, 1998
  31 .Dt PTHREAD_COND_BROADCAST 3
  32 .Os
  33 .Sh NAME
  34 .Nm pthread_cond_broadcast
  35 .Nd unblock all threads waiting for a condition variable
  36 .Sh LIBRARY
  37 .Lb libc_r
  38 .Lb libpthread
  39 .Lb libthr
  40 .Sh SYNOPSIS
  41 .In pthread.h
  42 .Ft int
  43 .Fn pthread_cond_broadcast "pthread_cond_t *cond"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn pthread_cond_broadcast
  47 function unblocks all threads waiting for the condition variable
  48 .Fa cond .
  49 .Sh RETURN VALUES
  50 If successful, the
  51 .Fn pthread_cond_broadcast
  52 function will return zero, otherwise an error number will be returned
  53 to indicate the error.
  54 .Sh ERRORS
  55 The
  56 .Fn pthread_cond_broadcast
  57 function will fail if:
  58 .Bl -tag -width Er
  59 .It Bq Er EINVAL
  60 The value specified by
  61 .Fa cond
  62 is invalid.
  63 .El
  64 .Sh SEE ALSO
  65 .Xr pthread_cond_destroy 3 ,
  66 .Xr pthread_cond_init 3 ,
  67 .Xr pthread_cond_signal 3 ,
  68 .Xr pthread_cond_timedwait 3 ,
  69 .Xr pthread_cond_wait 3
  70 .Sh STANDARDS
  71 The
  72 .Fn pthread_cond_broadcast
  73 function conforms to
  74 .St -p1003.1-96 .