lib/libpthread/pthread_cond_broadcast.3

   1 .\" $NetBSD: pthread_cond_broadcast.3,v 1.6 2008/05/26 02:16:48 ad Exp $
   2 .\"
   3 .\" Copyright (c) 2002, 2008 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   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 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  14 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  15 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  17 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  23 .\" POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
  26 .\" All rights reserved.
  27 .\"
  28 .\" Redistribution and use in source and binary forms, with or without
  29 .\" modification, are permitted provided that the following conditions
  30 .\" are met:
  31 .\" 1. Redistributions of source code must retain the above copyright
  32 .\"    notice, this list of conditions and the following disclaimer.
  33 .\" 2. Redistributions in binary form must reproduce the above copyright
  34 .\"    notice, this list of conditions and the following disclaimer in the
  35 .\"    documentation and/or other materials provided with the distribution.
  36 .\" 3. Neither the name of the author nor the names of any co-contributors
  37 .\"    may be used to endorse or promote products derived from this software
  38 .\"    without specific prior written permission.
  39 .\"
  40 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
  41 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  44 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50 .\" SUCH DAMAGE.
  51 .\"
  52 .\" $FreeBSD: src/lib/libpthread/man/pthread_cond_broadcast.3,v 1.11 2002/09/16 19:29:28 mini Exp $
  53 .\"
  54 .Dd May 26, 2008
  55 .Dt PTHREAD_COND_BROADCAST 3
  56 .Os
  57 .Sh NAME
  58 .Nm pthread_cond_broadcast ,
  59 .Nm pthread_cond_signal
  60 .Nd unblock one or all threads waiting on a condition variable
  61 .Sh LIBRARY
  62 .Lb libpthread
  63 .Sh SYNOPSIS
  64 .In pthread.h
  65 .Ft int
  66 .Fn pthread_cond_broadcast "pthread_cond_t *cond"
  67 .Ft int
  68 .Fn pthread_cond_signal "pthread_cond_t *cond"
  69 .Sh DESCRIPTION
  70 The
  71 .Fn pthread_cond_broadcast
  72 function unblocks all threads waiting for the condition variable
  73 .Fa cond .
  74 If no threads are waiting on
  75 .Fa cond ,
  76 the
  77 .Fn pthread_cond_broadcast
  78 function has no effect.
  79 .Pp
  80 The
  81 .Fn pthread_cond_signal
  82 function unblocks one thread waiting for the condition variable
  83 .Fa cond .
  84 If no threads are waiting on
  85 .Fa cond ,
  86 the
  87 .Fn pthread_cond_signal
  88 function has no effect.
  89 .Pp
  90 When calling
  91 .Fn pthread_cond_wait
  92 and/or
  93 .Fn pthread_cond_timedwait ,
  94 a temporary binding is established between the condition variable
  95 .Fa cond
  96 and a caller-supplied mutex.
  97 .Pp
  98 The same mutex must be held while calling
  99 .Fn pthread_cond_broadcast
 100 and
 101 .Fn pthread_cond_signal .
 102 Neither function enforces this requirement, but if the mutex is not
 103 held the resulting behaviour is undefined.
 104 .Sh RETURN VALUES
 105 If successful, the
 106 .Fn pthread_cond_broadcast
 107 and
 108 .Fn pthread_cond_signal
 109 functions will return zero, otherwise an error number will be returned
 110 to indicate the error.
 111 .Sh ERRORS
 112 .Fn pthread_cond_broadcast
 113 and
 114 .Fn pthread_cond_signal
 115 may fail if:
 116 .Bl -tag -width Er
 117 .It Bq Er EINVAL
 118 The value specified by
 119 .Fa cond
 120 is invalid.
 121 .El
 122 .Sh SEE ALSO
 123 .Xr pthread_cond_destroy 3 ,
 124 .Xr pthread_cond_init 3 ,
 125 .Xr pthread_cond_timedwait 3 ,
 126 .Xr pthread_cond_wait 3
 127 .Sh STANDARDS
 128 .Fn pthread_cond_broadcast
 129 and
 130 .Fn pthread_cond_signal
 131 conform to
 132 .St -p1003.1-96 .