usr/src/man/man3c/raise.3c

   1 '\" te
   2 .\"  Copyright 1989 AT&T. Copyright (c) 2005, 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 RAISE 3C "Mar 23, 2005"
   7 .SH NAME
   8 raise \- send a signal to the executing thread
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <signal.h>
  13
  14 \fBint\fR \fBraise\fR(\fBint\fR \fIsig\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBraise()\fR function sends the signal \fIsig\fR to the executing thread.
  21 If a signal handler is called, the raise function does not return until after
  22 the signal handler returns.
  23 .sp
  24 .LP
  25 The effect of the raise function is equivalent to calling:
  26 .sp
  27 .in +2
  28 .nf
  29 pthread_kill(pthread_self(), sig);
  30 .fi
  31 .in -2
  32
  33 .sp
  34 .LP
  35 See the \fBpthread_kill\fR(3C) manual page for a detailed list of failure
  36 conditions and the \fBsignal.h\fR(3HEAD) manual page for a list of signals.
  37 .SH RETURN VALUES
  38 .sp
  39 .LP
  40 Upon successful completion, \fB0\fR is returned.  Otherwise, \fB\(mi1\fR is
  41 returned and \fBerrno\fR is set to indicate the error.
  42 .SH ATTRIBUTES
  43 .sp
  44 .LP
  45 See \fBattributes\fR(5) for descriptions of the following attributes:
  46 .sp
  47
  48 .sp
  49 .TS
  50 box;
  51 c | c
  52 l | l .
  53 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  54 _
  55 Interface Stability     Standard
  56 _
  57 MT-Level        MT-Safe
  58 .TE
  59
  60 .SH SEE ALSO
  61 .sp
  62 .LP
  63 \fBpthread_kill\fR(3C), \fBpthread_self\fR(3C), \fBsignal.h\fR(3HEAD),
  64 \fBattributes\fR(5), \fBstandards\fR(5)