usr/src/man/man2/_lwp_cond_signal.2

   1 '\" te
   2 .\"  Copyright (c) 1995 Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH _LWP_COND_SIGNAL 2 "Dec 8, 1995"
   7 .SH NAME
   8 _lwp_cond_signal, _lwp_cond_broadcast \- signal a condition variable
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/lwp.h>
  13
  14 \fBint\fR \fB_lwp_cond_signal\fR(\fBlwp_cond_t *\fR\fIcvp\fR);
  15 .fi
  16
  17 .LP
  18 .nf
  19 \fBint\fR \fB_lwp_cond_broadcast\fR(\fBlwp_cond_t *\fR\fIcvp\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fB_lwp_cond_signal()\fR function unblocks one LWP that is blocked on the
  26 LWP condition variable pointed to by \fIcvp\fR.
  27 .sp
  28 .LP
  29 The \fB_lwp_cond_broadcast()\fR function unblocks all LWPs that are blocked on
  30 the LWP condition variable pointed to by \fIcvp\fR.
  31 .sp
  32 .LP
  33 If no LWPs are blocked on the LWP condition variable, then
  34 \fB_lwp_cond_signal()\fR and \fB_lwp_cond_broadcast()\fR have no effect.
  35 .sp
  36 .LP
  37 Both functions should be called under the protection of the same LWP mutex lock
  38 that is used with the LWP condition variable being  signaled. Otherwise, the
  39 condition variable may be signalled between the test of the associated
  40 condition and blocking in \fB_lwp_cond_wait()\fR. This can cause an infinite
  41 wait.
  42 .SH RETURN VALUES
  43 .sp
  44 .LP
  45 Upon successful completion, \fB0\fR is returned. A non-zero value indicates an
  46 error.
  47 .SH ERRORS
  48 .sp
  49 .LP
  50 The \fB_lwp_cond_signal()\fR and \fB_lwp_cond_broadcast()\fR functions will
  51 fail if:
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBEINVAL\fR\fR
  56 .ad
  57 .RS 10n
  58 The \fIcvp\fR argument points to an invalid LWP condition variable.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBEFAULT\fR\fR
  65 .ad
  66 .RS 10n
  67 The \fIcvp\fR argument points to an invalid address.
  68 .RE
  69
  70 .SH SEE ALSO
  71 .sp
  72 .LP
  73 \fB_lwp_cond_wait\fR(2), \fB_lwp_mutex_lock\fR(2)