usr/src/man/man9f/ddi_can_receive_sig.9f

   1 '\" te
   2 .\" Copyright (c) 2003, 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 DDI_CAN_RECEIVE_SIG 9F "Dec 15, 2003"
   7 .SH NAME
   8 ddi_can_receive_sig \- Test for ability to receive signals
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/ddi.h>
  13 #include <sys/sunddi.h>
  14
  15
  16
  17 \fBboolean_t\fR ddi_can_receive_sig(\fBvoid\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris DDI specific (Solaris DDI).
  24 .SH PARAMETERS
  25 .sp
  26 .LP
  27 None.
  28 .SH DESCRIPTION
  29 .sp
  30 .LP
  31 The \fBddi_can_receive_sig()\fR function returns a boolean value
  32 indicating whether the current thread can receive signals sent by
  33 \fBkill\fR(2). If the return value is  \fBB_FALSE\fR, then the calling  thread
  34 cannot receive  signals, and any call to \fBqwait_sig\fR(9F),
  35 \fBcv_wait_sig\fR(9F), or  \fBcv_timedwait_sig\fR(9F) implicitly becomes
  36 \fBqwait\fR(9F), \fBcv_wait\fR(9F), or  \fBcv_timedwait\fR(9F), respectively.
  37 Drivers that can block indefinitely awaiting an event should use this function
  38 to determine if additional means (such as \fBtimeout\fR(9F)) may be necessary
  39 to avoid creating unkillable threads.
  40 .SH RETURN VALUES
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fBB_FALSE\fR \fR
  45 .ad
  46 .RS 12n
  47 The  calling thread is in a state in which signals            cannot be
  48 received. For  example, the thread is not associated with a user process or is
  49 in the midst of \fBexit\fR(2) handling.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBB_TRUE\fR \fR
  56 .ad
  57 .RS 12n
  58 The calling thread may receive a signal while blocked            on a condition
  59 variable. Note that this function does not check to  determine whether signals
  60 are blocked (see \fBsigprocmask\fR(2)).
  61 .RE
  62
  63 .SH CONTEXT
  64 .sp
  65 .LP
  66 The \fBddi_can_receive_sig()\fR function  may be called from user, kernel, or
  67 interrupt context.
  68 .SH SEE ALSO
  69 .sp
  70 .LP
  71 \fBclose\fR(9E), \fBcv_wait\fR(9F), \fBqwait\fR(9F)