lib/libpthread/man/pthread_cond_signal.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_SIGNAL 3
  32 .Os BSD 4
  33 .Sh NAME
  34 .Nm pthread_cond_signal
  35 .Nd unblock a thread waiting for a condition variable
  36 .Sh SYNOPSIS
  37 .Fd #include <pthread.h>
  38 .Ft int
  39 .Fn pthread_cond_signal "pthread_cond_t *cond"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn pthread_cond_signal
  43 function unblocks one thread waiting for the condition variable
  44 .Fa cond .
  45 .Sh RETURN VALUES
  46 If successful, the
  47 .Fn pthread_cond_signal
  48 function will return zero, otherwise an error number will be returned
  49 to indicate the error.
  50 .Sh ERRORS
  51 .Fn pthread_cond_signal
  52 will fail if:
  53 .Bl -tag -width Er
  54 .It Bq Er EINVAL
  55 The value specified by
  56 .Fa cond
  57 is invalid.
  58 .El
  59 .Pp
  60 .Sh SEE ALSO
  61 .Xr pthread_cond_broadcast 3 ,
  62 .Xr pthread_cond_destroy 3 ,
  63 .Xr pthread_cond_init 3 ,
  64 .Xr pthread_cond_timedwait 3 ,
  65 .Xr pthread_cond_wait 3
  66 .Sh STANDARDS
  67 .Fn pthread_cond_signal
  68 conforms to ISO/IEC 9945-1 ANSI/IEEE
  69 .Pq Dq Tn POSIX
  70 Std 1003.1 Second Edition 1996-07-12.